Get your organization

GET

/organization

Get your organization

Authorizations

• publicOauth2
  read:org

Responses

200

An organization

Response Headers

X-Request-Id

string

Example:

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

ID uniquely identifying the request/response cycle.

Response Schema

object

id

required

Unique identifier for this resource within Aerospike Cloud

string

Example:

e2e81cba-446e-4ff9-9b92-9a9992af44c6

name

string

Example:

My organization

billingId

string

/^$|^cus_[a-zA-z0-9]+/

Example:

cus_OPMnlfzpujhunk

billingPlan

string

default: BILLING_PLAN_ENTERPRISE

Allowed values:

BILLING_PLAN_ENTERPRISE

salesforceAccountId

string

Example:

001ak00000llBrOAAU

entitlements

Array

object

entitlementUrn

string

/^urn:aerospike:.+/

Example:

urn:aerospike:node:count-general

quantity

Number of resources allowed

integer

format: int32

Example:

3

used

Number of resources currently in use

integer

format: int32

Example:

1

Example

Content type: application/json

Copied!

{ 

{

"id": "e2e81cba-446e-4ff9-9b92-9a9992af44c6",

"name": "My organization",

"billingId": "cus_OPMnlfzpujhunk",

"billingPlan": "BILLING_PLAN_ENTERPRISE",

"salesforceAccountId": "001ak00000llBrOAAU",

"entitlements": [ 

]

}

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

404

Resource not found

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:resource:not-found", "title": "Resource Not Found", "status": 404, "detail": "The requested resource could not be found.", "instance": "string", "context": { "resource": "cluster", "id": "abc-123" }, "message": "The requested resource could not be found." }

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

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