List API keys.

Authorizations

publicOauth2

read:api-key

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.

200

A collection of API keys

Response Headers

X-Request-Id

string

Example:

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

ID uniquely identifying the request/response cycle.

Response Schema

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

apiKeys

required

Array<object>

An API key

object

name

required

string

clientId

required

string

Example

Copied!

{

"count": 10,

"meta": {

"total": 1000,
"limit": 10,
"offset": 10

},

"apiKeys": [

{

"name": "string",

"clientId": "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

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:

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

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:

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

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:

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

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." }

501

The endpoint has not been implemented yet.

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:

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

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:unavailable", "title": "Not Implemented", "status": 501, "detail": "This endpoint has not been implemented yet.", "instance": "string", "context": { "resource": "cluster", "id": "abc-123" }, "message": "This endpoint has not been implemented yet." }

List API keys.

Authorizations

Parameters

Query Parameters

Example

Responses

200

Response Headers

Response Schema

Example

401

Response Headers

Response Schema

Example

403

Response Headers

Response Schema

Example

500

Response Headers

Response Schema

Example

501

Response Schema

Example