List all secrets.

GET

/secrets

Retrieves a list of all secrets accessible to the user

Authorizations

• publicOauth2
  read:secret

Parameters

Query Parameters

limit

integer

default: 10

>= 1

<= 100

The maximum number of items to return in a single response. Used for pagination. Must be between 1 and 100.

Example

Example:

10

offset

integer

The number of items to skip before starting to return results. Used for pagination. For example, to get the next 10 items after the first 10, set offset to 10.

Responses

200

A collection of secrets

Response Headers

X-Request-Id

string

Example:

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

ID uniquely identifying the request/response cycle.

Response Schema

A collection of secrets

object

count

required

Number of items returned in the current result set.

integer

Example:

10

meta

required

Pagination metadata for collection responses

object

total

required

Total number of items available

integer

Example:

1000

limit

required

Maximum number of items per page

integer

Example:

10

offset

required

Number of items skipped before the current result set

integer

Example:

10

secrets

required

Array

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!

{ 

{

"count": 10,

"meta": { 

"total": 1000,

"limit": 10,

"offset": 10

},

"secrets": [ 

]

}

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"

}

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"

}