Get an existing secret

GET

/secrets/{secretId}

Get an existing secret by Id

Authorizations

• publicOauth2
  read:secret

Parameters

Path Parameters

secretId

required

string

format: uuid

A secret ID.

Responses

200

A secret

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

A secret

object

id

required

string

format: uuid

name

required

The name of the secret. Must comply with RFC 1035.

string

<= 63 characters

/^[a-zA-Z]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$/

Example:

my-secret1

description

The description of the secret

string

""

<= 250 characters

createdAt

required

string

format: date-time

Example

Content type: application/json

Copied!

{ 

{

"id": "string",

"name": "my-secret1",

"description": "string",

"createdAt": "string"

}

400

Invalid input

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}

401

Access token is missing or invalid

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "invalid_token",

"message": "The access token expired."

}

403

Permission denied

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}

404

Resource not found

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}

500

Internal Server Error

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}