---
title: "List all secrets."
description: "Retrieves a list of all secrets accessible to the user"
---

# List all secrets.

> For the complete documentation index see: [llms.txt](https://aerospike.com/docs/llms.txt)
> 
> All documentation pages available in markdown.

GET

/secrets

-   

Retrieves a list of all secrets accessible to the user

## Authorizations

-   **[publicOauth2](https://aerospike.com/docs/cloud/reference/api/#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**

Pagination metadata

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

RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses.

object

**type**

required

URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN.

string

Allowed values:

urn:aerospike:errors:auth:unauthorized

urn:aerospike:errors:auth:token-expired

urn:aerospike:errors:resource:not-found

urn:aerospike:errors:resource:already-exists

urn:aerospike:errors:validation:failed

urn:aerospike:errors:system:internal

urn:aerospike:errors:system:unavailable

urn:aerospike:errors:ratelimit:exceeded

**title**

required

A short, human-readable summary of the problem type

string

Example:

Resource Not Found

**status**

required

The HTTP status code

integer

Example:

404

**detail**

A human-readable explanation specific to this occurrence

string

Example:

The requested cluster could not be found.

**instance**

A URI reference that identifies the specific occurrence

string

format: uri

**context**

Any of:

-   [object](#tab-panel-409)
-   [object](#tab-panel-410)
-   [object](#tab-panel-411)

Context for resource-related errors (not-found, already-exists)

object

**resource**

Type of resource (e.g., cluster, database, organization)

string

Example:

cluster

**id**

Identifier of the resource

string

Example:

abc-123

Structured context for validation errors

object

**missing**

JSON Pointer paths to missing required fields

Array<string>

Example:

\[ "/user/email", "/user/password", "/user/firstName" \]

**invalid**

Details about invalid field values

Array<object>

object

**field**

required

JSON Pointer path to the invalid field

string

Example:

/user/phoneNumber

**type**

required

URN identifying the specific validation error type

string

format: uri

Allowed values:

urn:aerospike:errors:validation:failed

urn:aerospike:errors:validation:invalid-phone-format

urn:aerospike:errors:validation:invalid-email-format

urn:aerospike:errors:validation:invalid-date-format

urn:aerospike:errors:validation:invalid-url-format

urn:aerospike:errors:validation:out-of-range

urn:aerospike:errors:validation:too-long

urn:aerospike:errors:validation:too-short

Example:

urn:aerospike:errors:validation:failed

**description**

An optional human-readable description of the validation error

string

object

**_key_**

additional properties

any

**message**

Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.

string

Example:

The requested cluster could not be found.

##### Example

Example:

{ "type": "urn:aerospike:errors:auth:token-expired", "title": "Token Expired", "status": 401, "detail": "Your session has expired. Please log in again.", "instance": "string", "context": { "resource": "cluster", "id": "abc-123" }, "message": "Your session has expired. Please log in again." }

### 403

Permission denied

##### Response Headers

**X-Request-Id**

string

Example:

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

ID uniquely identifying the request/response cycle.

##### Response Schema

RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses.

object

**type**

required

URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN.

string

Allowed values:

urn:aerospike:errors:auth:unauthorized

urn:aerospike:errors:auth:token-expired

urn:aerospike:errors:resource:not-found

urn:aerospike:errors:resource:already-exists

urn:aerospike:errors:validation:failed

urn:aerospike:errors:system:internal

urn:aerospike:errors:system:unavailable

urn:aerospike:errors:ratelimit:exceeded

**title**

required

A short, human-readable summary of the problem type

string

Example:

Resource Not Found

**status**

required

The HTTP status code

integer

Example:

404

**detail**

A human-readable explanation specific to this occurrence

string

Example:

The requested cluster could not be found.

**instance**

A URI reference that identifies the specific occurrence

string

format: uri

**context**

Any of:

-   [object](#tab-panel-412)
-   [object](#tab-panel-413)
-   [object](#tab-panel-414)

Context for resource-related errors (not-found, already-exists)

object

**resource**

Type of resource (e.g., cluster, database, organization)

string

Example:

cluster

**id**

Identifier of the resource

string

Example:

abc-123

Structured context for validation errors

object

**missing**

JSON Pointer paths to missing required fields

Array<string>

Example:

\[ "/user/email", "/user/password", "/user/firstName" \]

**invalid**

Details about invalid field values

Array<object>

object

**field**

required

JSON Pointer path to the invalid field

string

Example:

/user/phoneNumber

**type**

required

URN identifying the specific validation error type

string

format: uri

Allowed values:

urn:aerospike:errors:validation:failed

urn:aerospike:errors:validation:invalid-phone-format

urn:aerospike:errors:validation:invalid-email-format

urn:aerospike:errors:validation:invalid-date-format

urn:aerospike:errors:validation:invalid-url-format

urn:aerospike:errors:validation:out-of-range

urn:aerospike:errors:validation:too-long

urn:aerospike:errors:validation:too-short

Example:

urn:aerospike:errors:validation:failed

**description**

An optional human-readable description of the validation error

string

object

**_key_**

additional properties

any

**message**

Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.

string

Example:

The requested cluster could not be found.

##### Example

Example:

{ "type": "urn:aerospike:errors:auth:unauthorized", "title": "Unauthorized", "status": 403, "detail": "You don't have permission to access this resource.", "instance": "string", "context": { "resource": "cluster", "id": "abc-123" }, "message": "You don't have permission to access this resource." }

### 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

RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses.

object

**type**

required

URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN.

string

Allowed values:

urn:aerospike:errors:auth:unauthorized

urn:aerospike:errors:auth:token-expired

urn:aerospike:errors:resource:not-found

urn:aerospike:errors:resource:already-exists

urn:aerospike:errors:validation:failed

urn:aerospike:errors:system:internal

urn:aerospike:errors:system:unavailable

urn:aerospike:errors:ratelimit:exceeded

**title**

required

A short, human-readable summary of the problem type

string

Example:

Resource Not Found

**status**

required

The HTTP status code

integer

Example:

404

**detail**

A human-readable explanation specific to this occurrence

string

Example:

The requested cluster could not be found.

**instance**

A URI reference that identifies the specific occurrence

string

format: uri

**context**

Any of:

-   [object](#tab-panel-415)
-   [object](#tab-panel-416)
-   [object](#tab-panel-417)

Context for resource-related errors (not-found, already-exists)

object

**resource**

Type of resource (e.g., cluster, database, organization)

string

Example:

cluster

**id**

Identifier of the resource

string

Example:

abc-123

Structured context for validation errors

object

**missing**

JSON Pointer paths to missing required fields

Array<string>

Example:

\[ "/user/email", "/user/password", "/user/firstName" \]

**invalid**

Details about invalid field values

Array<object>

object

**field**

required

JSON Pointer path to the invalid field

string

Example:

/user/phoneNumber

**type**

required

URN identifying the specific validation error type

string

format: uri

Allowed values:

urn:aerospike:errors:validation:failed

urn:aerospike:errors:validation:invalid-phone-format

urn:aerospike:errors:validation:invalid-email-format

urn:aerospike:errors:validation:invalid-date-format

urn:aerospike:errors:validation:invalid-url-format

urn:aerospike:errors:validation:out-of-range

urn:aerospike:errors:validation:too-long

urn:aerospike:errors:validation:too-short

Example:

urn:aerospike:errors:validation:failed

**description**

An optional human-readable description of the validation error

string

object

**_key_**

additional properties

any

**message**

Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.

string

Example:

The requested cluster could not be found.

##### Example

Example:

{ "type": "urn:aerospike:errors:system:internal", "title": "Internal Server Error", "status": 500, "detail": "An unexpected error occurred. Please try again later.", "instance": "string", "context": { "resource": "cluster", "id": "abc-123" }, "message": "An unexpected error occurred. Please try again later." }