Skip to content

List organization audit logs

GET
/audit-logs

Returns audit log entries for all write operations (POST, PUT, PATCH, DELETE) within the organization for the specified time range. Audit logs are sorted by timestamp in descending order (newest first).

The time range is limited to a maximum of 30 days.

Authorizations

Parameters

Query Parameters

startTime
required
string
format: date-time

Start of the time range for audit log retrieval (inclusive). Must be in ISO 8601 format with timezone (e.g., 2024-01-01T00:00:00Z).

Example
Example:
2024-01-01T00:00:00Z
endTime
required
string
format: date-time

End of the time range for audit log retrieval (exclusive). Must be in ISO 8601 format with timezone (e.g., 2024-01-31T23:59:59Z). Must be after startTime and within 30 days of startTime.

Example
Example:
2024-01-31T23:59:59Z
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 audit log entries

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

A paginated collection of audit log entries

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
auditLogs
required

List of audit log entries

Array<object>

An audit log entry recording a write operation (POST, PUT, PATCH, DELETE) performed in the organization.

object
timestamp
required

ISO 8601 timestamp with millisecond precision when the action occurred

string
format: date-time
Example:
2024-01-15T14:30:00.507Z
actorType
required

Type of actor that performed the action

string
Allowed values:
user
api_key
Example:
user
userId

Aerospike Cloud user ID (present when actorType=user)

string
format: uuid
Example:
bd3a3411-374d-4f76-af61-6e3c57dead6e
userEmail

Email address of the user (present when actorType=user)

string
format: email
Example:
user@example.com
apiKeyId

API key client ID (present when actorType=api_key)

string
Example:
client_xyz
method
required

HTTP method of the request

string
Allowed values:
POST
PUT
PATCH
DELETE
Example:
DELETE
path
required

The actual API path that was accessed

string
Example:
/v1/database/clusters/abc/credentials/xyz
resource
required

Normalized resource path template with :id placeholders

string
Example:
/v1/database/clusters/:id/credentials/:id
statusCode
required

HTTP response status code

integer
>= 100
<= 599
Example:
200
requestId
required

Unique correlation/trace ID for request tracing

string
Example:
9de588f11c70e242864a365f34a68ecc
ipAddress
required

Client IP address from which the request originated

string
format: ipv4
Example:
10.20.11.29
userAgent
required

Client user agent string

string
Example:
axios/1.13.2
Example
Content type: application/json
{ 
{
"count": 10,
"meta": { 
"total": 1000,
"limit": 10,
"offset": 10
},
"auditLogs": [ 
{ 
"timestamp": "2024-01-15T14:30:00.507Z",
"actorType": "user",
"userId": "bd3a3411-374d-4f76-af61-6e3c57dead6e",
"userEmail": "user@example.com",
"apiKeyId": "client_xyz",
"method": "DELETE",
"path": "/v1/database/clusters/abc/credentials/xyz",
"resource": "/v1/database/clusters/:id/credentials/:id",
"statusCode": 200,
"requestId": "9de588f11c70e242864a365f34a68ecc",
"ipAddress": "10.20.11.29",
"userAgent": "axios/1.13.2"
}
]
}

400

Invalid input

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:validation:failed", "title": "Validation Error", "status": 400, "detail": "The provided information is not in the correct format.", "instance": "string", "context": { "invalid": [ { "field": "/name", "type": "urn:aerospike:errors:validation:too-long" }, { "field": "/region", "type": "urn:aerospike:errors:validation:too-short" } ] }, "message": "The provided information is not in the correct format." }

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

Was this page helpful?

What type of feedback are you giving?

What would you like us to know?

+Capture screenshot

Can we reach out to you?