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

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

trial

object

startedAt

Milliseconds since unix epoch

string

Example:

1697669479000

expiresAt

Milliseconds since unix epoch

string

Example:

0

terminated

boolean

databaseId

string

format: uuid

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

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "invalid_token",

"message": "The access token expired."

}

403

Permission denied

Response Headers

X-Request-Id

string

Example:

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

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}

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

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}

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

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}