List supported cloud providers.

GET

/database/cloud-providers

Returns a list of supported cloud providers and regions.

Authorizations

• publicOauth2

Parameters

Query Parameters

filter

Optional filters for cloud provider, region, and instance type characteristics.

object

cloudProvider

string

Example:

aws

region

string

Example:

us-east-1

minDisks

integer

minStorageGiB

integer

minMemoryGiB

integer

Responses

200

Set of available cloud providers

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 result.

integer

Example:

1

results

Array<object>

object

id

required

The ID of the cloud provider.

string

Allowed values:

aws

azure

gcp

name

required

Human friendly (i.e. branded) name of the cloud provider.

string

Example:

Amazon Web Services (AWS)

regions

required

Array<object>

object

name

required

string

Example:

us-east-1

instanceTypes

required

Array<object>

object

instanceType

required

string

Example:

trn1.32xlarge

vcpus

required

integer

Example:

128

memoryGib

required

integer

Example:

512

localStorage

required

object

numberOfDisks

required

integer

Example:

4

diskSizeGib

required

integer

Example:

1900

totalSizeGib

required

integer

Example:

7600

supportedArchitectures

required

Array<string>

Allowed values:

x86_64

arm64

Example

Content type: application/json

Copied!

{ 

{

"count": 1,

"results": [ 

{ 

"id": "aws",

"name": "Amazon Web Services (AWS)",

"regions": [ 

{ 

"name": "us-east-1",

"instanceTypes": [ 

{ 

"instanceType": "trn1.32xlarge",

"vcpus": 128,

"memoryGib": 512,

"localStorage": { 

"numberOfDisks": 4,

"diskSizeGib": 1900,

"totalSizeGib": 7600

},

"supportedArchitectures": [ 

"x86_64"

]

}

]

}

]

}

]

}

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

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

object

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

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

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

object

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

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

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:

object

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

object

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

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