List clusters.
GET /database/clusters
Retrieves a list of all clusters accessible to the user. The list can be filtered by status.
Authorizations
Parameters
Query Parameters
Filter clusters to exclude any matching one or more of the specified statuses. Provide statuses as a single comma-separated list (e.g., ?status_ne=deleting,failed).
Example
Example:The maximum number of items to return in a single response. Used for pagination. Must be between 1 and 100.
Example
Example: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 clusters
Response Headers
ID uniquely identifying the request/response cycle.
Response Schema
object
Number of items returned in the current result set.
Pagination metadata
object
Total number of items available
Maximum number of items per page
Number of items skipped before the current result set
object
Unique identifier for this resource within Aerospike Cloud
object
Host name that clients will use to connect to the cluster. Correlates to the AEROSPIKE_CLOUD_HOST
variable in documentation and code samples.
PEM encoded TLS certificate for the cluster.
object
The ARN of the S3 bucket the logs reside in
A list of role ARNs authorized to read the log bucket
object
Cloud provider for the infrastructure
Instance type for vertical scaling
AWS region where resources will be deployed
Number of availability zones to spread resources across
AWS availability zone IDs for aerospike nodes
The /19 IPv4 CIDR block for the database VPC
The network ID of the database
The account ID of the database
object
General Purpose SSD (gp2)
Size of the EBS volume in gigabytes
object
General Purpose SSD (gp3)
IOPS for gp3 (min 3000, max 16000). Max 500 IOPS per GB (not enforced by schema).
Size of the EBS volume in gigabytes
object
Provisioned IOPS SSD (io1)
IOPS for io1 (min 100, max 64000). Max 50 IOPS per GB (not enforced by schema).
Size of the EBS volume in gigabytes (min 4 for io1)
object
Provisioned IOPS SSD (io2)
IOPS for io2 (min 100, max 64000). Max 1000 IOPS per GB (not enforced by schema).
Size of the EBS volume in gigabytes (min 4 for io2)
object
Number of nodes in the cluster (horizontal scaling)
Persist data using local disks or network storage. If omitted, data is stored in-memory without persistence.
object
Number of nodes in the cluster (horizontal scaling)
Persist data using network storage. If omitted, data is stored only on local SSDs without additional persistence.
object
Number of nodes in the cluster (horizontal scaling)
Aerospike server configuration
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
The address, port and TLS name of the node. The TLS name is optional.
object
object
Example
{
"meta": {
"clusters": [
{
"connectionDetails": {
"logging": {
"authorizedRoles": [
"infrastructure": {
"zoneIds": [
"aerospikeCloud": {
"aerospikeServer": {
"service": {
"feature-key-files": [
"logging": [
{
"network": {
"tls": [
{
"namespaces": [
{
"geo2dsphere-within": {
"sets": [
{
"mod-lua": {
"security": {
"ldap": {
"role-query-patterns": [
"log": {
"report-data-op": [
"report-data-op-role": [
"report-data-op-user": [
"xdr": {
"dcs": [
{
"node-address-ports": [
"namespaces": [
{
"ignore-bins": [
"ignore-sets": [
"ship-bins": [
"ship-sets": [
"health": {
401
Access token is missing or invalid
Response Headers
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
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.
A short, human-readable summary of the problem type
The HTTP status code
A human-readable explanation specific to this occurrence
A URI reference that identifies the specific occurrence
Context for resource-related errors (not-found, already-exists)
object
Type of resource (e.g., cluster, database, organization)
Identifier of the resource
Structured context for validation errors
object
JSON Pointer paths to missing required fields
Details about invalid field values
object
JSON Pointer path to the invalid field
URN identifying the specific validation error type
An optional human-readable description of the validation error
object
Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.
Example
Example:403
Permission denied
Response Headers
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
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.
A short, human-readable summary of the problem type
The HTTP status code
A human-readable explanation specific to this occurrence
A URI reference that identifies the specific occurrence
Context for resource-related errors (not-found, already-exists)
object
Type of resource (e.g., cluster, database, organization)
Identifier of the resource
Structured context for validation errors
object
JSON Pointer paths to missing required fields
Details about invalid field values
object
JSON Pointer path to the invalid field
URN identifying the specific validation error type
An optional human-readable description of the validation error
object
Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.
Example
Example:500
Internal Server Error
Response Headers
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
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.
A short, human-readable summary of the problem type
The HTTP status code
A human-readable explanation specific to this occurrence
A URI reference that identifies the specific occurrence
Context for resource-related errors (not-found, already-exists)
object
Type of resource (e.g., cluster, database, organization)
Identifier of the resource
Structured context for validation errors
object
JSON Pointer paths to missing required fields
Details about invalid field values
object
JSON Pointer path to the invalid field
URN identifying the specific validation error type
An optional human-readable description of the validation error
object
Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.
Example
Example: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
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.
A short, human-readable summary of the problem type
The HTTP status code
A human-readable explanation specific to this occurrence
A URI reference that identifies the specific occurrence
Context for resource-related errors (not-found, already-exists)
object
Type of resource (e.g., cluster, database, organization)
Identifier of the resource
Structured context for validation errors
object
JSON Pointer paths to missing required fields
Details about invalid field values
object
JSON Pointer path to the invalid field
URN identifying the specific validation error type
An optional human-readable description of the validation error
object
Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.