Astra DevOps API (2.3.0)

Download OpenAPI specification:Download

Use this REST API to manage your DataStax Astra DB organizations and perform lifecycle actions for your Astra DB databases.

To get started, use the /v2/clientIdSecrets endpoints to create a token to authenticate your API calls.

Authentication

Generate and revoke tokens that are used to authenticate DevOps API operations.

Create a new AstraCS token

Authorizations:

BearerAuth

Request Body schema: application/json

The model for creating a token

roles required	Array of strings The roles with which the token will be created.
orgId	string The UUID of the organization under which the token will be created (optional). If not provided, the token will be created under the organization/enterprise of the token making the request.

Responses

Request samples

Payload

Content type

application/json

{"roles": ["roleID-UUID"
],
"orgId": "uuid"
}

Response samples

200
400
401
403
500

Content type

application/json

{"clientId": "string",
"secret": "string",
"orgId": "uuid",
"roles": ["org-write"
],
"token": "uuid"
}

Get a list of tokens for an org

Authorizations:

BearerAuth

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"clients": [{"clientId": "IFmJlTkNvptFzTDEQpQIEJud",
"roles": ["string"
]
}
]
}
]

Deletes a token

Authorizations:

BearerAuth

path Parameters

clientId

required

string

clientID to revoke token for

Responses

Response samples

400
401
403
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Get a list of clients for an org

Authorizations:

BearerAuth

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"clients": [{"clientId": "IFmJlTkNvptFzTDEQpQIEJud",
"roles": ["string"
]
}
]
}
]

generateTokenForClient

Authorizations:

BearerAuth

Request Body schema: application/json

The model for generating token for client

roles

required

Array of strings

The roles with which the token will be generated. https://docs.datastax.com/en/astra-db-serverless/administration/manage-database-access.html

Responses

Request samples

Payload

Content type

application/json

{"roles": ["org-write"
]
}

Response samples

200
400
401
403
500

Content type

application/json

[{"clientId": "string",
"secret": "string",
"orgId": "uuid",
"roles": ["org-write"
],
"token": "uuid"
}
]

Revokes a token

Authorizations:

BearerAuth

path Parameters

clientId

required

string

clientID to revoke token for

Responses

Response samples

400
401
403
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Database Operations

Use these DevOps APIs to manage Astra databases. Resize is for Astra Classic databases only.

Returns a list of databases

Get a list of databases visible to the user

Authorizations:

BearerAuth

query Parameters

include	string Default: "nonterminated" Enum: "nonterminated" "all" "active" "pending" "preparing" "prepared" "initializing" "parked" "parking" "unparking" "terminating" "terminated" "resizing" "error" "maintenance" "suspended" "suspending" Allows filtering so that databases in listed states are returned
provider	string Default: "ALL" Enum: "ALL" "GCP" "AWS" "AZURE" Allows filtering so that databases from a given provider are returned
starting_after	string Optional parameter for pagination purposes. Used as this value for starting retrieving a specific page of results
limit	integer [ 1 .. 100 ] Default: 25 Optional parameter for pagination purposes. Specify the number of items for one page of data

Responses

Response samples

200
400
401
5XX

Content type

application/json

[{"id": "1234-5678-91011121-3141",
"orgId": "organizations/7142-1283-54249566-3707",
"ownerId": "users/8243-2404-85664728-0889",
"info": {"name": "mySplendidDatabase",
"keyspace": "myKeyspace",
"cloudProvider": "AWS",
"tier": "developer",
"capacityUnits": 1,
"region": "us-west-2",
"additionalKeyspaces": ["additionalKeyspace"
],
"dbType": "vector"
},
"creationTime": "2012-11-01T22:08:41+00:00",
"terminationTime": "2019-11-01T22:08:41+00:00",
"status": "ACTIVE",
"storage": {"nodeCount": 6,
"replicationFactor": 3,
"totalStorage": 800,
"usedStorage": 348,
"displayStorage": 348
},
"availableActions": ["addKeyspace, terminate"
],
"message": "Auto parked due to inactivity",
"grafanaUrl": "http://path-to-grafana:port",
"cqlshUrl": "http://path-to-cqlsh:port/cqlsh",
"graphqlUrl": "http://path-to-graqphl:port/api/graphql",
"dataEndpointUrl": "http://path-to-dataendpoint:port/api/rest"
}
]

Create a new database

Takes a user provided databaseInfo and returns the uuid for a new database

Authorizations:

BearerAuth

Request Body schema: application/json
required

Definition of new database

name required	string Name of the database--user friendly identifier
keyspace	string (Optional) Keyspace name in database. If not passed, keyspace is created with name "default_keyspace"
cloudProvider required	string Enum: "AWS" "GCP" "AZURE" CloudProvider where the database lives
tier required	string Enum: "developer" "C10" "C20" "C40" "D10" "D20" "D40" "serverless" Tier defines the compute power (vertical scaling) for the database, developer gcp is the free tier.
capacityUnits required	integer [ 1 .. 100 ] CapacityUnits is the amount of space available (horizontal scaling) for the database. For free tier the max CU's is 1, and 100 for CXX/DXX the max is 12 on startup.
region required	string Region refers to the cloud region.
dbType	string Value: "vector" Type of the serverless database, currently only supported value is "vector". "vector" creates a cassandra database with vector support. Field not being inputted creates default serverless database.

Responses

Request samples

Payload

Content type

application/json

{"name": "mySplendidDatabase",
"keyspace": "myKeyspace",
"cloudProvider": "AWS",
"tier": "developer",
"capacityUnits": 1,
"region": "us-west-2",
"dbType": "vector"
}

Response samples

400
401
422
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Finds database by ID

Returns specified database

Authorizations:

BearerAuth

path Parameters

databaseID

required

string

String representation of the database ID

Responses

Response samples

200
400
401
404
5XX

Content type

application/json

{"id": "1234-5678-91011121-3141",
"orgId": "organizations/7142-1283-54249566-3707",
"ownerId": "users/8243-2404-85664728-0889",
"info": {"name": "mySplendidDatabase",
"keyspace": "myKeyspace",
"cloudProvider": "AWS",
"tier": "developer",
"capacityUnits": 1,
"region": "us-west-2",
"additionalKeyspaces": ["additionalKeyspace"
],
"dbType": "vector"
},
"creationTime": "2012-11-01T22:08:41+00:00",
"terminationTime": "2019-11-01T22:08:41+00:00",
"status": "ACTIVE",
"storage": {"nodeCount": 6,
"replicationFactor": 3,
"totalStorage": 800,
"usedStorage": 348,
"displayStorage": 348
},
"availableActions": ["addKeyspace, terminate"
],
"message": "Auto parked due to inactivity",
"grafanaUrl": "http://path-to-grafana:port",
"cqlshUrl": "http://path-to-cqlsh:port/cqlsh",
"graphqlUrl": "http://path-to-graqphl:port/api/graphql",
"dataEndpointUrl": "http://path-to-dataendpoint:port/api/rest"
}

Adds keyspace into database

Adds the specified keyspace to the database

Authorizations:

BearerAuth

path Parameters

databaseID required	string String representation of the database ID
keyspaceName required	string Name of database keyspace

Responses

Response samples

401
404
409
422
5XX

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Removes keyspace

Removes the specified keyspace from the database

Authorizations:

BearerAuth

path Parameters

databaseID required	string String representation of the database ID
keyspaceName required	string Name of database keyspace

Responses

Response samples

400
401
404
5XX

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Obtain zip for connecting to the database

Returns a temporary URL to download a zip file with certificates for connecting to the database. The URL expires after five minutes.

There are two types of the secure bundle URL:

Internal - Use with VPC peering connections to use private networking and avoid public internet for communication.
External - Use with any connection where the public internet is sufficient for communication between the application and the Astra database with MTLS.

Both types support MTLS for communication via the driver.

Authorizations:

BearerAuth

path Parameters

databaseID

required

string

String representation of the database ID

query Parameters

all	boolean Default: false Optional parameter to obtain secure-connect-*.zip for one (false) or many (true) datacenters. If false, `200` returns `CredsURL` (download URLs for one datacenter). If true, `200` returns `CredsURLList` (download URLs for multiple datacenters).

Responses

Response samples

Content type

application/json

Example

CredsURL

{"downloadURL": "nifty.cloud.datastax.com:9092",
"downloadURLInternal": "internal-nifty.cloud.datastax.com:9092",
"downloadURLMigrationProxy": "proxy-nifty.cloud.datastax.com:9092",
"downloadURLMigrationProxyInternal": "proxy-nifty.cloud.datastax.com:9092",
"datcenterID": "dde308f5-a8b0-474d-afd6-81e5689e3e25",
"region": "us-east-1",
"cloudProvider": "AWS",
"customDomainBundles": [{"domain": "example.domain.com",
"cqlFQDN": "dde308f5-a8b0-474d-afd6-81e5689e3e25-us-east-1.db.example.domain.com",
"apiFQDN": "dde308f5-a8b0-474d-afd6-81e5689e3e25-us-east-1.apps.example.domain.com",
"dashboardFQDN": "dde308f5-a8b0-474d-afd6-81e5689e3e25-us-east-1.dashboard.example.domain.com",
"downloadURL": "nifty.cloud.datastax.com:9092"
}
]
}

Configure Astra Remote Telemetry

Enables metrics exporting to an external system. Note: updates replace any existing config.

Authorizations:

BearerAuth

path Parameters

databaseID

required

string

String representation of the database ID

Request Body schema: application/json

Any of

required

object (KafkaTelemetryRequestBlock)

Telemetry Config Block for Kafka servers

Responses

Request samples

Payload

Content type

application/json

Example

KafkaTelemetryRequest

{"kafka": {"bootstrap_servers": ["kafka-0.yourdomain.com:9092"
],
"topic": "astra_metrics_events",
"sasl_mechanism": "GSSAPI",
"sasl_username": "kafkauser",
"sasl_password": "kafkapassword",
"security_protocol": "SASL_PLAINTEXT"
}
}

Response samples

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Retrieve Remote Telemetry configuration

Get the current Telemetry configuration for the database

Authorizations:

BearerAuth

path Parameters

databaseID

required

string

String representation of the database ID

Responses

Response samples

Content type

application/json

Example

KafkaTelemetryRequest

{"kafka": {"bootstrap_servers": ["kafka-0.yourdomain.com:9092"
],
"topic": "astra_metrics_events",
"sasl_mechanism": "GSSAPI",
"sasl_username": "kafkauser",
"sasl_password": "kafkapassword",
"security_protocol": "SASL_PLAINTEXT"
}
}

Terminates a database

Authorizations:

BearerAuth

path Parameters

databaseID

required

string

String representation of the database ID

query Parameters

preparedStateOnly

boolean

Default: false

For internal use only. Used to safely terminate prepared databases.

Responses

Response samples

400
401
404
409
5XX

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Suspends a database

Authorizations:

BearerAuth

path Parameters

databaseID

required

string

String representation of the database ID

query Parameters

freeConsumed

integer

Default: -1

Represents, from 0 to 100, the free credits percentage consumed.

Responses

Response samples

400
401
404
409
5XX

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Resizes a database

Resizes a database. Total number of capacity units desired should be specified.

Authorizations:

BearerAuth

path Parameters

databaseID

required

string

String representation of the database ID

Request Body schema: application/json
required

Map containing capacityUnits key with a value greater than the current number of capacity units (max increment of 3 additional capacity units)

capacityUnits

integer [ 1 .. 100 ]

CapacityUnits can be increased by a max of three additional capacity units per operation. Reducing capacity units is not supported at this time

Responses

Request samples

Payload

Content type

application/json

{"capacityUnits": 4
}

Response samples

400
401
404
409
5XX

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

List all database datacenters

Returns the list of configured ACTIVE datacenters for the given database, if you want to get the TERMINATED along with ACTIVE send query param all=true

Authorizations:

BearerAuth

path Parameters

databaseID

required

string

String representation of the database ID

query Parameters

all	boolean Default: false Allows retrieving datacenters in TERMINATED state along with ACTIVE ones

Responses

Response samples

200
401
5XX

Content type

application/json

[{"id": "1234-5678-91011121-3141-1",
"name": "dc-1234-5678-91011121-3141",
"tier": "Developer",
"status": "ACTIVE",
"cloudProvider": "GCP",
"region": "us-east1",
"regionZone": "na",
"regionClassification": "standard",
"capacityUnits": 1,
"grafanaUrl": "http://path-to-grafana:port",
"cqlshUrl": "http://path-to-cqlsh:port/cqlsh",
"graphqlUrl": "http://path-to-graqphl:port/api/graphql",
"dataEndpointUrl": "http://path-to-dataendpoint:port/api/rest",
"secureBundleUrl": "http://s3-signed-bundle-url",
"secureBundleInternalUrl": "http://s3-signed-internal-bundle-url",
"secureBundleMigrationProxyUrl": "http://s3-signed-proxy-bundle-url",
"secureBundleMigrationProxyInternalUrl": "http://s3-signed-proxy-internal-bundle-url"
}
]

Adds datacenters

Adds the list of datacenters. Supported in AWS, Azure, and Google Cloud.

Authorizations:

BearerAuth

path Parameters

databaseID

required

string

String representation of the database ID

Request Body schema: application/json
required

Map containing capacityUnits key with a value greater than the current number of capacity units (max increment of 3 additional capacity units)

Array

id	string
name	string
tier required	string
status required	string
cloudProvider required	string
region required	string
regionZone	string Enum: "emea" "apac" "na" "sa"
regionClassification	string Enum: "standard" "premium" "premium_plus"
capacityUnits	integer CapacityUnits is the amount of space available (horizontal scaling) for the database
grafanaUrl	string
cqlshUrl	string
graphqlUrl	string
dataEndpointUrl	string
secureBundleUrl	string
secureBundleInternalUrl	string
secureBundleMigrationProxyUrl	string
secureBundleMigrationProxyInternalUrl	string

Responses

Request samples

Payload

Content type

application/json

[{"id": "1234-5678-91011121-3141-1",
"name": "dc-1234-5678-91011121-3141",
"tier": "Developer",
"status": "ACTIVE",
"cloudProvider": "GCP",
"region": "us-east1",
"regionZone": "na",
"regionClassification": "standard",
"capacityUnits": 1,
"grafanaUrl": "http://path-to-grafana:port",
"cqlshUrl": "http://path-to-cqlsh:port/cqlsh",
"graphqlUrl": "http://path-to-graqphl:port/api/graphql",
"dataEndpointUrl": "http://path-to-dataendpoint:port/api/rest",
"secureBundleUrl": "http://s3-signed-bundle-url",
"secureBundleInternalUrl": "http://s3-signed-internal-bundle-url",
"secureBundleMigrationProxyUrl": "http://s3-signed-proxy-bundle-url",
"secureBundleMigrationProxyInternalUrl": "http://s3-signed-proxy-internal-bundle-url"
}
]

Response samples

400
401
404
5XX

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Terminates a datacenter

Authorizations:

BearerAuth

path Parameters

databaseID required	string String representation of the database ID
datacenterID required	string String representation of the datacenter ID

Responses

Response samples

400
401
404
409
5XX

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Resets Password

Sets a database password to the one specified in POST body

Authorizations:

BearerAuth

path Parameters

databaseID

required

string

String representation of the database ID

Request Body schema: application/json
required

Map containing username and password. The specified password will be updated for the specified database user

username	string
password	string New password (min 6 characters)

Responses

Request samples

Payload

Content type

application/json

{"username": "dbusername",
"password": "MyNewSecur3Passw0rd"
}

Response samples

400
401
404
409
5XX

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Organization Operations

DevOps APIs for your Astra organization.

Get the current organization from the passed token

Retrieve the details for the organization in the provided token

Authorizations:

BearerAuth

Responses

Response samples

Content type

application/json

[{"id": "d04d1eb2-6a52-483e-ab16-faaad3d077a9"
}
]

Configure Audit Logging

Enables audit log exporting to an external system.

Authorizations:

BearerAuth

path Parameters

orgID

required

string

String representation of the organization ID

Request Body schema: application/json

Any of

required

any (PulsarTelemetryRequestBlock)

Telemetry Config

Responses

Request samples

Payload

Content type

application/json

{"pulsar": {"endpoint": "pulsar+ssl://pulsar.example.com",
"auth_strategy": "token",
"topic": "persistent://test/default/my-topic-123",
"auth_name": "foobar",
"token": "AstraTelemetry123"
}
}

Response samples

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Retrieve Remote Audit Log Configuration or Check Status

Get the current audit log configuration or verify the setup status for the organization.

Authorizations:

BearerAuth

path Parameters

orgID

required

string

String representation of the organization ID

Responses

Response samples

Content type

application/json

{"pulsar": {"endpoint": "pulsar+ssl://pulsar.example.com",
"auth_strategy": "token",
"topic": "persistent://test/default/my-topic-123",
"auth_name": "foobar",
"token": "AstraTelemetry123"
}
}

Delete Audit Log Configuration

Remove audit logging for the organization.

Authorizations:

BearerAuth

path Parameters

orgID

required

string

String representation of the organization ID

Responses

Response samples

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Enterprise Operations

DevOps APIs for your Astra enterprise.

Create an organization under an enterprise.

Create a new organization under the given enterprise.

Authorizations:

BearerAuth

Request Body schema: application/json

name required	string The name of the organization
email required	string The email of the organization
adminUserID required	string The datastax UUID of the user who will be the admin of the organization
enterpriseID required	string The UUID of the enterprise under which the organization needs to be created

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "string",
"adminUserID": "string",
"enterpriseID": "string"
}

Response samples

Content type

application/json

{"OrganizationName": "acme production org",
"OrganizationID": "8f112467-7b55-4f0a-877f-c97e2bc10074",
"OrganizationEmail": "admin@acme-enterprises.com",
"MarketplaceData": { },
"CreatedAt": "2024-06-14T15:41:45.395919529Z",
"LastModified": "2024-06-14T15:41:45.395919529Z",
"OrgType": "organization",
"EnterpriseId": "9df02cbd-fb84-47c0-a5cf-b7a912928a4e",
"OrganizationGroupId": "f9336a4e-e489-4db2-ab29-0939af587268"
}

Get Enterprise usage report for a given enterprise Id and request payload

Provides the usage report for a given enterprise Id and request payload breakdown across multiple cluster region combination within given window (not more than 90 days)

Authorizations:

BearerAuth

Request Body schema: application/json
required

Consists of the start and end time for the usage report, requested orgids, clusters

startDate required	string start date time in ISO RFC3339 format
endDate required	string end date time in ISO RFC3339 format
clusterIDs	Array of strings List of the cluster IDs
orgIDs	Array of strings List of the org IDs

Responses

Request samples

Payload

Content type

application/json

{"startDate": "2021-05-06T06:13:23.57Z",
"endDate": "2021-05-06T06:13:23.57Z",
"clusterIDs": ["string"
],
"orgIDs": ["string"
]
}

Response samples

Content type

application/json

{"totalCost": null,
"costs": [{"orgId": "abcfc07b-3217-494e-9831-b5058a92961f",
"clusterID": "d75f25b7-d668-4ff9-9ed6-21a2f22f4568",
"region": "us-east-1",
"cost": "101.57878268880637"
}
]
}

Roles

Use the DevOps Roles APIs to manage roles in your Astra organization.

Get all roles for an organization

Authorizations:

BearerAuth

Responses

Response samples

200
401
403
404
500

Content type

application/json

[[{"id": "string",
"name": "string",
"policy": {"description": "string",
"resources": ["drn:astra:org:__ORG_ID__"
],
"actions": ["db-all-keyspace-create"
],
"effect": "allow"
},
"last_update_datetime": "2019-08-24T14:15:22Z",
"last_update_userid": "string"
}
]
]

Create a role in an organization

Authorizations:

BearerAuth

Request Body schema: application/json

The model for create role body

name required	string
required	object (Policy) A policy for a role in Astra.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"policy": {"description": "string",
"resources": ["drn:astra:org:__ORG_ID__"
],
"actions": ["db-all-keyspace-create"
],
"effect": "allow"
}
}

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"policy": {"description": "string",
"resources": ["drn:astra:org:__ORG_ID__"
],
"actions": ["db-all-keyspace-create"
],
"effect": "allow"
},
"last_update_datetime": "2019-08-24T14:15:22Z",
"last_update_userid": "string"
}

Get a role for an organization

Retrieve the details for a role for a given organization

Authorizations:

BearerAuth

path Parameters

roleID

required

string

id for the role

Responses

Response samples

Content type

application/json

[{"id": "string",
"name": "string",
"policy": {"description": "string",
"resources": ["drn:astra:org:__ORG_ID__"
],
"actions": ["db-all-keyspace-create"
],
"effect": "allow"
},
"last_update_datetime": "2019-08-24T14:15:22Z",
"last_update_userid": "string"
}
]

Update a role within an organization

Authorizations:

BearerAuth

path Parameters

roleID

required

string

id for the role

Request Body schema: application/json

The model for update role body

name required	string
required	object (Policy) A policy for a role in Astra.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"policy": {"description": "string",
"resources": ["drn:astra:org:__ORG_ID__"
],
"actions": ["db-all-keyspace-create"
],
"effect": "allow"
}
}

Response samples

400
401
403
404
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Delete a role by ID

Authorizations:

BearerAuth

path Parameters

roleID

required

string

id for the role

Responses

Response samples

400
401
404
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Users

Use the DevOps Users APIs to manage users in your Astra organization.

Invite a user to an organization

Invite a user to an organization or resend an invitation with new invitation details, such as an updated expiration

Authorizations:

BearerAuth

Request Body schema: application/json

email required	string The email of the user being invited
orgID required	string The unique system generated identifier of the organization
roles required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"orgID": "string",
"roles": ["string"
]
}

Response samples

400
401
403
404
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Get an organization's users

Authorizations:

BearerAuth

Responses

Response samples

200
401
404
500

Content type

application/json

{"orgID": "string",
"orgName": "string",
"users": [{"userID": "3476f3bb-10df-4d2f-ac2b-f05c65676724",
"email": "joe@datastax.com",
"status": "active",
"roles": [{"id": "string",
"name": "string",
"policy": {"description": "string",
"resources": ["drn:astra:org:__ORG_ID__"
],
"actions": ["db-all-keyspace-create"
],
"effect": "allow"
},
"last_update_datetime": "2019-08-24T14:15:22Z",
"last_update_userid": "string"
}
]
}
]
}

Get an organization's user

Authorizations:

BearerAuth

path Parameters

userID

required

string

id for the user

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"userID": "3476f3bb-10df-4d2f-ac2b-f05c65676724",
"email": "joe@datastax.com",
"status": "active",
"roles": [{"id": "string",
"name": "string",
"policy": {"description": "string",
"resources": ["drn:astra:org:__ORG_ID__"
],
"actions": ["db-all-keyspace-create"
],
"effect": "allow"
},
"last_update_datetime": "2019-08-24T14:15:22Z",
"last_update_userid": "string"
}
]
}

Remove or uninvite a user from an organization

Authorizations:

BearerAuth

path Parameters

userID

required

string

id for the user

Responses

Response samples

400
401
403
404
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Update organization roles for a user

Authorizations:

BearerAuth

path Parameters

userID

required

string

id for the user

Request Body schema: application/json

roles

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"roles": ["string"
]
}

Response samples

400
401
403
404
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Token

Generate and revoke tokens that are used to authenticate DevOps API operations.

Create a new AstraCS token

Authorizations:

BearerAuth

Request Body schema: application/json

The model for creating a token

roles required	Array of strings The roles with which the token will be created.
orgId	string The UUID of the organization under which the token will be created (optional). If not provided, the token will be created under the organization/enterprise of the token making the request.

Responses

Request samples

Payload

Content type

application/json

{"roles": ["roleID-UUID"
],
"orgId": "uuid"
}

Response samples

200
400
401
403
500

Content type

application/json

{"clientId": "string",
"secret": "string",
"orgId": "uuid",
"roles": ["org-write"
],
"token": "uuid"
}

Get a list of tokens for an org

Authorizations:

BearerAuth

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"clients": [{"clientId": "IFmJlTkNvptFzTDEQpQIEJud",
"roles": ["string"
]
}
]
}
]

Deletes a token

Authorizations:

BearerAuth

path Parameters

clientId

required

string

clientID to revoke token for

Responses

Response samples

400
401
403
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Get a list of clients for an org

Authorizations:

BearerAuth

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"clients": [{"clientId": "IFmJlTkNvptFzTDEQpQIEJud",
"roles": ["string"
]
}
]
}
]

generateTokenForClient

Authorizations:

BearerAuth

Request Body schema: application/json

The model for generating token for client

roles

required

Array of strings

The roles with which the token will be generated. https://docs.datastax.com/en/astra-db-serverless/administration/manage-database-access.html

Responses

Request samples

Payload

Content type

application/json

{"roles": ["org-write"
]
}

Response samples

200
400
401
403
500

Content type

application/json

[{"clientId": "string",
"secret": "string",
"orgId": "uuid",
"roles": ["org-write"
],
"token": "uuid"
}
]

Revokes a token

Authorizations:

BearerAuth

path Parameters

clientId

required

string

clientID to revoke token for

Responses

Response samples

400
401
403
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Access List

View, create, modify, or delete the IP access list for an Astra database.

Get all access lists for an organization

Authorizations:

BearerAuth

Responses

Response samples

200
401
403
404
500

Content type

application/json

[{"organizationId": "303a3598-0905-4b5d-9db2-4bf2f9790973",
"databaseId": "8fbcfe1d-56fa-4ed0-9aff-f57029feef1b",
"addresses": [{"address": "137.187.23.0/24",
"enabled": true,
"description": "This address allows the database connections from the prod environment",
"lastUpdateDateTime": "2021-01-21T17:32:28Z"
}
],
"configurations": {"accessListEnabled": true
}
}
]

Get the access list for a database

Authorizations:

BearerAuth

path Parameters

databaseID

required

string

String representation of the database ID

Responses

Response samples

Content type

application/json

{"organizationId": "303a3598-0905-4b5d-9db2-4bf2f9790973",
"databaseId": "8fbcfe1d-56fa-4ed0-9aff-f57029feef1b",
"addresses": [{"address": "137.187.23.0/24",
"enabled": true,
"description": "This address allows the database connections from the prod environment",
"lastUpdateDateTime": "2021-01-21T17:32:28Z"
}
],
"configurations": {"accessListEnabled": true
}
}

Upsert the access list for a database. This endpoint replaces the entire access list with what is present in the request body.

Authorizations:

BearerAuth

path Parameters

databaseID

required

string

String representation of the database ID

Request Body schema: application/json

	Array of objects (AddressRequest) A listing of the allowed addresses
	object (AccessListConfigurations)

Responses

Request samples

Payload

Content type

application/json

{"addresses": [{"address": "137.187.23.0/24",
"enabled": true,
"description": "This address allows the database connections from the prod environment"
}
],
"configurations": {"accessListEnabled": true
}
}

Response samples

400
401
403
404
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Add addresses to the access list for a database

Authorizations:

BearerAuth

path Parameters

databaseID

required

string

String representation of the database ID

Request Body schema: application/json

Array

address required	string^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]\|[1-2][0... The address (ip address and subnet mask in CIDR notation) of the address to allow
enabled required	boolean The indication if the access address is enabled or not
description required	string Description of this addresses use

Responses

Request samples

Payload

Content type

application/json

[{"address": "137.187.23.0/24",
"enabled": true,
"description": "This address allows the database connections from the prod environment"
}
]

Response samples

400
401
403
404
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Update the access list for a database. This endpoint updates existing fields in the access list if they exist

Authorizations:

BearerAuth

path Parameters

databaseID

required

string

String representation of the database ID

Request Body schema: application/json

	Array of objects (AddressRequest) A listing of the allowed addresses
	object (AccessListConfigurations)

Responses

Request samples

Payload

Content type

application/json

{"addresses": [{"address": "137.187.23.0/24",
"enabled": true,
"description": "This address allows the database connections from the prod environment"
}
],
"configurations": {"accessListEnabled": true
}
}

Response samples

400
401
403
404
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Delete a list of addresses or the access list for a database. If the addresses query parameter is not present it will delete the entire access list. If the addresses query parameter is present it will delete only the given addresses from the access list

Authorizations:

BearerAuth

path Parameters

databaseID

required

string

String representation of the database ID

query Parameters

addresses

Array of strings

Array of addresses

Responses

Response samples

401
403
404
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Validate the structure of an access list

Authorizations:

BearerAuth

Responses

Response samples

200
401
500

Content type

application/json

{"valid": true,
"validationFailures": ["string"
]
}

Get a template of an access list

Authorizations:

BearerAuth

Responses

Response samples

200
401
500

Content type

application/json

{"addresses": [{"address": "137.187.23.0/24",
"enabled": true,
"description": "This address allows the database connections from the prod environment"
}
],
"configurations": {"accessListEnabled": true
}
}

DevOps Access List

View, create, modify, or delete the access list that restricts access to the DevOps API for an Astra organization.

Get DevOps API Access List

Retrieves a DevOps API Access List for a specific organization by ID.

Authorizations:

BearerAuth

path Parameters

orgId

required

string

The ID of the Astra DB organization.

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"addresses": [{"address": "string",
"description": "string",
"enabled": true,
"lastUpdateDateTime": "string",
"createdAt": "string"
}
]
}

Create DevOps API Access List

Creates a new DevOps API Access List for a specific organization by ID.

Authorizations:

BearerAuth

path Parameters

orgId

required

string

The ID of the Astra DB organization.

Request Body schema: application/json
required

request to create a new access list for the DevOps API

Array

address	string Address of the CIDR or IP.
description	string Description of what this address is for.
enabled	boolean Flag stating whether this address is in use.

Responses

Request samples

Payload

Content type

application/json

[{"address": "string",
"description": "string",
"enabled": true
}
]

Response samples

Content type

application/json

{"addresses": [{"address": "string",
"description": "string",
"enabled": true,
"lastUpdateDateTime": "string",
"createdAt": "string"
}
]
}

Replace DevOps API Access List

Replaces an existing DevOps API Access List with a new one for a specific Astra DB organization by ID.

Authorizations:

BearerAuth

path Parameters

orgId

required

string

The ID of the Astra DB organization.

Request Body schema: application/json
required

request to replace an existing access list for the DevOps API with the submitted one

Array

address	string Address of the CIDR or IP.
description	string Description of what this address is for.
enabled	boolean Flag stating whether this address is in use.

Responses

Request samples

Payload

Content type

application/json

[{"address": "string",
"description": "string",
"enabled": true
}
]

Response samples

200
400
401
403
500

Content type

application/json

{"addresses": [{"address": "string",
"description": "string",
"enabled": true,
"lastUpdateDateTime": "string",
"createdAt": "string"
}
]
}

Update DevOps API Access List

Updates an existing DevOps API Access List for a specific Astra DB organization by ID.

Authorizations:

BearerAuth

path Parameters

orgId

required

string

The ID of the Astra DB organization.

Request Body schema: application/json
required

request to add an IP address to an existing DevOps API Access List

address	string Address of the CIDR or IP.
description	string Description of what this address is for.
enabled	boolean Flag stating whether this address is in use.

Responses

Request samples

Payload

Content type

application/json

{"address": "string",
"description": "string",
"enabled": true
}

Response samples

Content type

application/json

{"addresses": [{"address": "string",
"description": "string",
"enabled": true,
"lastUpdateDateTime": "string",
"createdAt": "string"
}
]
}

Remove entire DevOps API Access List from an Astra DB organization.

Removes an entire DevOps API Access List for a specific organization by ID. This will disable the DevOps API Access List feature for the specified organization.

Authorizations:

BearerAuth

path Parameters

orgId

required

string

The ID of the Astra DB organization.

Responses

Response samples

400
401
403
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Private Link

Use the DevOps Private Link APIs to manage private link endpoints for your Astra databases.

Gets info about all private link connections for a specific org

Authorizations:

BearerAuth

Responses

Response samples

Content type

application/json

{"clusters": [{"clusterID": "string",
"datacenters": [{"serviceName": "com.amazonaws.vpce.us-east-1.vpce-svc-1148ea04af491da11",
"allowedPrincipals": ["arn:aws:iam::123456789012:role/admin"
],
"datacenterID": "string",
"endpoints": [{"endpointID": "vpce-svc-1148ea04af491da11",
"description": "ecomm-team-billing-app",
"linkID": "126845687",
"status": "Accepted",
"createdDateTime": "2009-11-10T23:00:00"
}
]
}
]
}
]
}

Gets info about all private link connections for a specific cluster

Gets info about all private link connections for a cluster

Authorizations:

BearerAuth

path Parameters

clusterID

required

string <uuid>

Database ID

Responses

Response samples

Content type

application/json

{"clusterID": "string",
"datacenters": [{"serviceName": "com.amazonaws.vpce.us-east-1.vpce-svc-1148ea04af491da11",
"allowedPrincipals": ["arn:aws:iam::123456789012:role/admin"
],
"datacenterID": "string",
"endpoints": [{"endpointID": "vpce-svc-1148ea04af491da11",
"description": "ecomm-team-billing-app",
"linkID": "126845687",
"status": "Accepted",
"createdDateTime": "2009-11-10T23:00:00"
}
]
}
]
}

Gets info about private link in a datacenter

Gets info about a private link connection in a specific datacenter

Authorizations:

BearerAuth

path Parameters

clusterID required	string <uuid> Database ID
datacenterID required	string <uuid> Datacenter ID from the Astra Portal. There is a unique Datacenter ID for each database region.

Responses

Response samples

Content type

application/json

{"serviceName": "com.amazonaws.vpce.us-east-1.vpce-svc-1148ea04af491da11",
"allowedPrincipals": ["arn:aws:iam::123456789012:role/admin"
],
"datacenterID": "string",
"endpoints": [{"endpointID": "vpce-svc-1148ea04af491da11",
"description": "ecomm-team-billing-app",
"linkID": "126845687",
"status": "Accepted",
"createdDateTime": "2009-11-10T23:00:00"
}
]
}

Add an allowed principal to the private link service

Configure private link by providing the allowed principal to connect with

Authorizations:

BearerAuth

path Parameters

clusterID required	string <uuid> Database ID
datacenterID required	string <uuid> Datacenter ID from the Astra Portal. There is a unique Datacenter ID for each database region.

Request Body schema: application/json

The model for adding a private link allowed principal

allowedPrincipals

Array of strings (AllowedPrincipals)

List of principals to do action for private link

Responses

Request samples

Payload

Content type

application/json

{"allowedPrincipals": ["arn:aws:iam::123456789012:role/admin"
]
}

Response samples

Content type

application/json

{"serviceName": "com.amazonaws.vpce.us-east-1.vpce-svc-1148ea04af491da11",
"allowedPrincipals": ["arn:aws:iam::123456789012:role/admin"
]
}

Add an allowed principal to the private link service

Configure private link by providing the allowed principal to connect with

Authorizations:

BearerAuth

path Parameters

clusterID required	string <uuid> Database ID
datacenterID required	string <uuid> Datacenter ID from the Astra Portal. There is a unique Datacenter ID for each database region.

Request Body schema: application/json

The model for adding a private link allowed principal

allowedPrincipals

Array of strings (AllowedPrincipals)

List of principals to do action for private link

Responses

Request samples

Payload

Content type

application/json

{"allowedPrincipals": ["arn:aws:iam::123456789012:role/admin"
]
}

Response samples

Content type

application/json

{"serviceName": "com.amazonaws.vpce.us-east-1.vpce-svc-1148ea04af491da11",
"allowedPrincipals": ["arn:aws:iam::123456789012:role/admin"
]
}

Remove an allowed principal from the private link service

Authorizations:

BearerAuth

path Parameters

clusterID required	string <uuid> Database ID
datacenterID required	string <uuid> Datacenter ID from the Astra Portal. There is a unique Datacenter ID for each database region.

Request Body schema: application/json

The model for removing a private link allowed principal

allowedPrincipal

string

The allowed-principal

Responses

Request samples

Payload

Content type

application/json

{"allowedPrincipal": "arn:aws:iam::123456789012:role/admin"
}

Response samples

400
401
404
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Accept an endpoint to the private link service

Complete Private Link connection by providing your endpoint

Authorizations:

BearerAuth

path Parameters

clusterID required	string <uuid> Database ID
datacenterID required	string <uuid> Datacenter ID from the Astra Portal. There is a unique Datacenter ID for each database region.

Request Body schema: application/json

The model for an AWS Private Link connection creation request

endpointID	string The user's endpoint created in their cloud provider account
description	string The human readable description of the endpoint

Responses

Request samples

Payload

Content type

application/json

{"endpointID": "vpce-svc-1148ea04af8675309",
"description": "ecomm-team-billing-app-prod"
}

Response samples

Content type

application/json

{"endpointID": "vpce-svc-1148ea04af491da11",
"description": "ecomm-team-billing-app",
"linkID": "126845687",
"status": "Accepted",
"createdDateTime": "2009-11-10T23:00:00"
}

Gets info about a private link endpoint

Authorizations:

BearerAuth

path Parameters

clusterID required	string <uuid> Database ID
datacenterID required	string <uuid> Datacenter ID from the Astra Portal. There is a unique Datacenter ID for each database region.
endpointID required	string Endpoint ID

Responses

Response samples

Content type

application/json

{"endpointID": "vpce-svc-1148ea04af491da11",
"description": "ecomm-team-billing-app",
"linkID": "126845687",
"status": "Accepted",
"createdDateTime": "2009-11-10T23:00:00"
}

Update the description for a private link endpoint

Authorizations:

BearerAuth

path Parameters

clusterID required	string <uuid> Database ID
datacenterID required	string <uuid> Datacenter ID from the Astra Portal. There is a unique Datacenter ID for each database region.
endpointID required	string Endpoint ID

Request Body schema: application/json

The model for updating the description for an endpoint

description

string

User defined description of the endpoint

Responses

Request samples

Payload

Content type

application/json

{"description": "ecomm-team-billing-app"
}

Response samples

Content type

application/json

{"endpointID": "vpce-svc-1148ea04af491da11",
"description": "ecomm-team-billing-app",
"linkID": "126845687",
"status": "Accepted",
"createdDateTime": "2009-11-10T23:00:00"
}

Reject an endpoint from the private link service

Authorizations:

BearerAuth

path Parameters

clusterID required	string <uuid> Database ID
datacenterID required	string <uuid> Datacenter ID from the Astra Portal. There is a unique Datacenter ID for each database region.
endpointID required	string Endpoint ID

Responses

Response samples

400
401
404
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Return the list of custom domains used by an organization for access via one or more private links.

Returns a list of custom domains used by an organization. The list contains those user defined domain names or domain name prefixes that are used as suffixes when accessing the databases in the various datacenters via private links.

Authorizations:

BearerAuth

Responses

Response samples

200
400
401
404
5XX

Content type

application/json

["string"
]

Define a new set of custom domains for usage with private links.

Sets a set of custom domains used by an organization. The input list should contain those user defined domain names or domain name prefixes that will be used as suffixes when accessing the databases in the various datacenters via private links.

Authorizations:

BearerAuth

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

400
401
404
5XX

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

VPC Peering

Use the DevOps VPC Peering APIs to manage VPC peering for Astra Classic databases.

Retrieves VPC peering connection information for an Astra database in a given cloud provider

Retrieves VPC peering connection details (if any exist) for Astra database

Authorizations:

BearerAuth

path Parameters

provider required	string Enum: "aws" "azure" "gcp" The name of the provider, such as 'aws', 'azure' or 'gcp'
databaseID required	string The ID for the database

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"connectionId": "string",
"status": "string",
"currentVpc": {"provider": "aws",
"account": "string",
"vpcId": "string",
"cidrBlock": "137.187.23.0/24"
},
"otherVpc": {"provider": "aws",
"account": "string",
"vpcId": "string",
"cidrBlock": "137.187.23.0/24"
}
}

Creates a VPC peering connection

Creates a VPC peering connection between an Astra database's VPC and the VPC provided

Authorizations:

BearerAuth

path Parameters

provider required	string Enum: "aws" "azure" "gcp" The name of the provider, such as 'aws', 'azure' or 'gcp'
databaseID required	string The ID for the database

Request Body schema: application/json

One of

tenantId required	string ID of the Azure tenant the subscription resides in
subscriptionId required	string ID of the subscription the resource group and virtual network reside in
resourceGroupName required	string Name of the Resource Group the virtual network resides in
virtualNetworkName required	string Name of the Virtual Network the peering is connecting to

Responses

Request samples

Payload

Content type

application/json

Example

AzureVPC

{"tenantId": "string",
"subscriptionId": "string",
"resourceGroupName": "string",
"virtualNetworkName": "string"
}

Response samples

201
401
403
404
500

Content type

application/json

{"connectionId": "string",
"status": "string",
"currentVpc": {"provider": "aws",
"account": "string",
"vpcId": "string",
"cidrBlock": "137.187.23.0/24"
},
"otherVpc": {"provider": "aws",
"account": "string",
"vpcId": "string",
"cidrBlock": "137.187.23.0/24"
}
}

Deletes an existing VPC peering connection

Deletes a VPC peering connection for an Astra database on the given cloud provider

Authorizations:

BearerAuth

path Parameters

provider required	string Enum: "aws" "azure" "gcp" The name of the provider, such as 'aws', 'azure' or 'gcp'
databaseID required	string The ID for the database

Responses

Response samples

401
403
404
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Customer Keys

Manage customer keys for your Astra organization.

Creates a new Customer Key used for serverless database encryption for an organization

A service to create a new Customer Key registration used for serverless database encryption in an organization.

Authorizations:

BearerAuth

Request Body schema: application/json

KMS details that need to be created.

orgId	string <uuid> The unique identifier for the organization.
	object (AWS-KMS)
	object (GCP-KMS)

Responses

Request samples

Payload

Content type

application/json

{"orgId": "368600f6-a1e7-42f1-8266-2960de5313f3",
"aws": {"keyID": "string",
"region": "string"
},
"gcp": {"keyID": "string",
"region": "string"
}
}

Response samples

400
401
403
404
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Retrieves all Serverless keys in an organization

A service to retrieve the existing Customer Keys of an organization.

Authorizations:

BearerAuth

Responses

Response samples

Content type

application/json

[{"OrganizationID": "string",
"CloudProvider": "string",
"KeyID": "string",
"Region": "string"
}
]

Creates a new Customer Key used for serverless database encryption for an organization

A service to create a new Customer Key registration used for serverless database encryption in an organization.

Authorizations:

BearerAuth

Request Body schema: application/json

KMS details that need to be created.

orgId	string <uuid> The unique identifier for the organization.
	object (AWS-KMS)
	object (GCP-KMS)

Responses

Request samples

Payload

Content type

application/json

{"orgId": "368600f6-a1e7-42f1-8266-2960de5313f3",
"aws": {"keyID": "string",
"region": "string"
},
"gcp": {"keyID": "string",
"region": "string"
}
}

Response samples

400
401
403
404
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Retrieves all Serverless keys in an organization

A service to retrieve the existing Customer Keys of an organization.

Authorizations:

BearerAuth

Responses

Response samples

Content type

application/json

[{"OrganizationID": "string",
"CloudProvider": "string",
"KeyID": "string",
"Region": "string"
}
]

Creates a new Customer Key used for classic database encryption for an organization

A service to create a new Customer Key registration used for classic database encryption in an organization.

Authorizations:

BearerAuth

Request Body schema: application/json

KMS details that need to be created.

orgId	string <uuid> The unique identifier for the organization.
	object (AWS-KMS)
	object (GCP-KMS)

Responses

Request samples

Payload

Content type

application/json

{"orgId": "368600f6-a1e7-42f1-8266-2960de5313f3",
"aws": {"keyID": "string",
"region": "string"
},
"gcp": {"keyID": "string",
"region": "string"
}
}

Response samples

400
401
403
404
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Retrieves all Classic keys in an organization

A service to retrieve the existing Customer Keys of an organization.

Authorizations:

BearerAuth

Responses

Response samples

Content type

application/json

[{"OrganizationID": "string",
"CloudProvider": "string",
"KeyID": "string",
"Region": "string"
}
]

Retrieves a Serverless Customer Key in an organization

Retrieves a Serverless Customer Key in an organization for a given cloud-provider & region combination.

Authorizations:

BearerAuth

path Parameters

provider required	string The name of the provider, such as: aws.
region required	string The region in which the key exists.

Responses

Response samples

Content type

application/json

{"orgId": "ccd0aa59-facd-4a42-b27f-49dba057833d",
"aws": {"keyID": "arn:aws:kms:us-east-1:111111111:key/aabbbb-a00f-4c38-9e92-b46ff1ed181d",
"region": "us-east-1"
}
}

Retrieves a Classic Customer Key in an organization

Retrieves a Classic Customer Key in an organization for a given cloud-provider & region combination.

Authorizations:

BearerAuth

path Parameters

provider required	string The name of the provider, such as: aws.
region required	string The region in which the key exists.

Responses

Response samples

Content type

application/json

{"orgId": "ccd0aa59-facd-4a42-b27f-49dba057833d",
"aws": {"keyID": "arn:aws:kms:us-east-1:111111111:key/aabbbb-a00f-4c38-9e92-b46ff1ed181d",
"region": "us-east-1"
}
}

Retrieves an array of Serverless Storage Cloud provider accounts

Retrieves an array of Cloud provider accounts for a given cloud-provider & region combination to which customers need to grant their KMS keys access to for serverless keys.

Authorizations:

BearerAuth

path Parameters

provider required	string The name of the provider, such as: aws.
region required	string The region in which the key exists.

Responses

Response samples

Content type

application/json

[{"organization_id": "string",
"provider_id": "string",
"provider": "string"
}
]

Assigns a new cloud account to an organization that will be used for classic database encryption

Assigns a new cloud account for an organization given a cloud provider that will be used for classic database encryption.

Authorizations:

BearerAuth

Responses

Response samples

400
401
403
404
500

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Retrieves an array of Classic Cloud provider accounts

Retrieves an array of Cloud provider accounts for a given cloud-provider & region combination to which customers need to grant their KMS keys access to for Classic keys.

Authorizations:

BearerAuth

path Parameters

provider required	string The name of the provider, such as: aws.
region required	string The region in which the key exists.

Responses

Response samples

Content type

application/json

[{"organization_id": "string",
"provider_id": "string",
"provider": "string"
}
]

Regions

Get available regions by database type, user, or organization.

Returns supported regions and availability for a given user / org

Returns all supported tier, cloud, region, count, and capacity combinations

Authorizations:

BearerAuth

Responses

Response samples

200
401
5XX

Content type

application/json

[{"tier": "Free",
"cloudProvider": "GCP",
"region": "us-east1",
"cost": {"costPerMinCents": 0,
"costPerHourCents": 0,
"costPerDayCents": 0,
"costPerMonthCents": 0,
"costPerMinParkedCents": 0,
"costPerHourParkedCents": 0,
"costPerDayParkedCents": 0,
"costPerMonthParkedCents": 0
},
"databaseCountUsed": 0,
"databaseCountLimit": 1,
"capacityUnitsUsed": 0,
"capacityUnitsLimit": 30,
"defaultStoragePerCapacityUnitGb": 500
}
]

Returns the list of available regions for serverless

Returns all region, cloud, name, zone and classification info available in serverless

Authorizations:

BearerAuth

query Parameters

region-type

string

Default: ""

Region type query parameter to retrieve regions supporting serverless and/or vector dbs. By default this API only returns serverless db regions for backward compatibility. To retrieve vector supported regions please pass query parameter region-type=vector. Valid values for this parameter are empty region-type query parameter (default behavior to retrieve serverless regions), all (to retrieve both vector and serverless regions) and vector (to retrieve vector regions). Any invalid value will be ignored and API will show the default behavior i.e. return serverless regions only.

filter-by-org

string

Default: "disabled"

Filter by org query parameter retrieves regions based on current organization ID. By default this API returns all regions for backward compatibility. To retrieve vector supported regions please pass query parameter region-type=vector. Another valid values for this parameter is 'disabled' (default), i.e. retrieve serverless regions without filtering out by current org. Any invalid value will be ignored and API will show the default behavior.

Responses

Response samples

200
401
5XX

Content type

application/json

[{"cloudProvider": "aws",
"name": "us-west-2",
"displayName": "US West (Oregon)",
"zone": "na",
"classification": "standard",
"enabled": true,
"reservedForQualifiedUsers": true,
"region_type": "vector"
}
]

Migrations

Use the DevOps API to manage SSTables-based migrations

initialize a new migration

Initialize a new SSTables based migration.

Authorizations:

BearerAuth

path Parameters

databaseID

required

string

String representation of the database ID

query Parameters

concurrency	string Sets the desired concurrency for the import.
targetSubsetSizeGB	string Sets the target subset size for the import.

Responses

Response samples

200
401
403
500

Content type

application/json

{"migrationID": "string",
"status": "INITIALIZING",
"concurrency": 0,
"targetSubsetSizeGB": 0.1
}

initialize a new migration

Initialize a new SSTables based migration.

Authorizations:

BearerAuth

path Parameters

databaseID required	string String representation of the database ID
datacenterID required	string String representation of the datacenter ID

query Parameters

concurrency	string Sets the desired concurrency for the import.
targetSubsetSizeGB	string Sets the target subset size for the import.
option.*	string Optional SSTable Import parameters. E.g. ?option.targetSubsetSizeGb=6.5. These options are not exposed via the devops API.

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"migrationID": "string",
"status": "INITIALIZING",
"concurrency": 0,
"targetSubsetSizeGB": 0.1
}

launch a migration

Launch an SSTables based migration.

Authorizations:

BearerAuth

path Parameters

databaseID required	string String representation of the database ID
migrationID required	string String representation of the active migration ID

Responses

Response samples

Content type

application/json

{"migrationID": "string",
"status": "INITIALIZING",
"concurrency": 0,
"targetSubsetSizeGB": 0.1
}

pause a migration

pause a migration in the import phase

Authorizations:

BearerAuth

path Parameters

databaseID required	string String representation of the database ID
migrationID required	string string representation of the active migration ID

Responses

Response samples

Content type

application/json

{"migrationID": "string",
"status": "INITIALIZING",
"concurrency": 0,
"targetSubsetSizeGB": 0.1
}

resume a paused migration

resume a migration in the paused phase

Authorizations:

BearerAuth

path Parameters

databaseID required	string String representation of the database ID
migrationID required	string string representation of the active migration ID

Responses

Response samples

Content type

application/json

{"migrationID": "string",
"status": "INITIALIZING",
"concurrency": 0,
"targetSubsetSizeGB": 0.1
}

abort a migration

Authorizations:

BearerAuth

path Parameters

databaseID required	string String representation of the database ID
migrationID required	string string representation of the active migration ID

Responses

Response samples

Content type

application/json

{"migrationID": "string",
"status": "INITIALIZING",
"concurrency": 0,
"targetSubsetSizeGB": 0.1
}

cleanup a migration

deletes all artifacts after a concluded migration (complete/failed/aborted)

Authorizations:

BearerAuth

path Parameters

databaseID required	string String representation of the database ID
migrationID required	string string representation of the active migration ID

query Parameters

option.cleanupTime

string

Optional parameter indicating the desired time of the cleanup. Format: unix timestamp, e.g. 2024-09-06T15:30:00Z

Responses

Response samples

Content type

application/json

{"migrationID": "string",
"status": "INITIALIZING",
"concurrency": 0,
"targetSubsetSizeGB": 0.1
}

get migration status

Get status information about an SSTables based migration.

Authorizations:

BearerAuth

path Parameters

databaseID required	string String representation of the database ID
migrationID required	string String representation of the active migration ID

Responses

Response samples

Content type

application/json

{"migrationID": "string",
"status": "INITIALIZING",
"concurrency": 0,
"targetSubsetSizeGB": 0.1
}

PCU

Use the DevOps API to manage provisioned capacity units for eligible organizations and databases.

Gets the PCU groups

Authorizations:

BearerAuth

Request Body schema: application/json
required

PCU group UUIDs

pcuGroupUUIDs	Array of strings PCU group UIDs
orgID	string OrganizationID of the PCU group, ignored for authenticated users

Responses

Request samples

Payload

Content type

application/json

{"pcuGroupUUIDs": [1
],
"orgID": "some-org"
}

Response samples

200
400
5XX

Content type

application/json

[{"uuid": "9aaddbb5-4622-447c-9bc5-b036bb9d7ed8",
"orgId": "org-id",
"title": "some title",
"cloudProvider": ["AWS",
"GCP",
"AZURE"
],
"region": "us-east-1",
"instanceType": "standard",
"provisionType": "shared",
"min": 1,
"max": 1,
"reserved": 1,
"description": "some description",
"createdAt": "2021-06-01T12:00:00.000Z",
"updatedAt": "2021-06-01T12:00:00.000Z",
"createdBy": "user",
"updatedBy": "user"
}
]

Creates a PCU group

Given PCU group information, creates a PCU group

Authorizations:

BearerAuth

Request Body schema: application/json
required

PCU group model.

Array (= 1 items)

orgID	string OrganizationID of the PCU group, ignored for authenticated users
title	string Title of the PCU group
cloudProvider	string Cloud provider of the PCU group
region	string Region of the PCU group
instanceType	string Instance type of the PCU group
provisionType	string Provision type of the PCU group
min	integer Minimum shared hourly PCUs in the PCU group
max	integer Maximum shared hourly PCUs in the PCU group
reserved	integer Absolute required PCUs in the PCU group
description	string Description of the PCU group

Responses

Request samples

Payload

Content type

application/json

[{"orgID": "some-org",
"title": "some title",
"cloudProvider": ["AWS",
"GCP",
"AZURE"
],
"region": "us-east-1",
"instanceType": "standard",
"provisionType": "shared",
"min": 1,
"max": 1,
"reserved": 1,
"description": "some-description"
}
]

Response samples

201
400
5XX

Content type

application/json

[{"uuid": "9aaddbb5-4622-447c-9bc5-b036bb9d7ed8",
"orgId": "org-id",
"title": "some title",
"cloudProvider": ["AWS",
"GCP",
"AZURE"
],
"region": "us-east-1",
"instanceType": "standard",
"provisionType": "shared",
"min": 1,
"max": 1,
"reserved": 1,
"description": "some description",
"createdAt": "2021-06-01T12:00:00.000Z",
"updatedAt": "2021-06-01T12:00:00.000Z",
"createdBy": "user",
"updatedBy": "user"
}
]

Updates one or more PCU groups

Given PCU group information, updates the PCU groups

Authorizations:

BearerAuth

Request Body schema: application/json
required

PCU Group model.

Array (= 1 items)

pcuGroupUUID	string UUID of the PCU group to update
title	string Title of the PCU group
instanceType	string Instance type of the PCU group
provisionType	string Provision type of the PCU group
min	integer Minimum shared hourly PCUs in the PCU group
max	integer Maximum shared hourly PCUs in the PCU group
reserved	integer Absolute required PCUs in the PCU group
description	string Description of the PCU group

Responses

Request samples

Payload

Content type

application/json

[{"pcuGroupUUID": "9aaddbb5-4622-447c-9bc5-b036bb9d7ed8",
"title": "some title",
"instanceType": "standard",
"provisionType": "shared",
"min": 1,
"max": 1,
"reserved": 1,
"description": "some-description"
}
]

Response samples

400
5XX

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Gets a PCU group UUID returns all associated datacenters and their status

Given a PCU group UUID, returns all associated datacenters and their status

Authorizations:

BearerAuth

path Parameters

pcuGroupUUID

required

string

The PCU group UUID to get the associated datacenters and their status

Responses

Response samples

200
400
5XX

Content type

application/json

[{"datacenterUUID": "48de8fc3-b8ec-4ed2-8951-4aeaf4c9e626",
"pcuGroupUUID": "48de8fc3-b8ec-4ed2-8951-4aeaf4c9e626",
"provisioningStatus": "Accepted",
"createdAt": "2021-06-01T12:00:00.000Z",
"updatedAt": "2021-06-01T12:00:00.000Z",
"createdBy": "user",
"updatedBy": "user"
}
]

Creates a PCU group association

Given PCU group UUID and datacenter UUID, creates a PCU group association

Authorizations:

BearerAuth

path Parameters

pcuGroupUUID required	string The PCU group UUID part of this association
datacenterUUID required	string The datacenter UUID part of this association

Responses

Response samples

400
5XX

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

Deletes a PCU group association

Given datacenter UUID and PCU group UUID, delete the association

Authorizations:

BearerAuth

path Parameters

pcuGroupUUID required	string The PCU group UUID part of this association
datacenterUUID required	string The datacenter UUID part of this association

Responses

Response samples

400
5XX

Content type

application/json

{"errors": [{"ID": 123,
"message": "Something is broken"
}
]
}

list the snapshots of a DB

Authorizations:

BearerAuth

path Parameters

databaseID

required

string

String representation of the database ID

query Parameters

from	string Example: from=2006-01-02T15:04:05Z07:00 optional timestamp from which to list the snapshots
to	string Example: to=2006-01-02T15:04:05Z07:00 optional timestamp until which to list the snapshots
sourceRegion	string When set then identifies which region to use as the source.

start a clone operation

Start a clone operation.

Authorizations:

BearerAuth

path Parameters

databaseID required	string String representation of the database ID
sourceDBID required	string The ID of the DB that is being cloned from.

query Parameters

snapshotID required	string The ID of the snapshot in the source DB used as the basis of the clone operation.
sourceRegion	string When set then identifies which region to use as the source.

Responses

Response samples

Content type

application/json

{"operationID": "string",
"status": "RUNNING"
}

get the status of a clone operation

Get the status of a clone operation.

Authorizations:

BearerAuth

path Parameters

databaseID required	string String representation of the database ID
operationID required	string The ID of the clone operation.

Responses

Response samples

Content type

application/json

{"operationID": "string",
"status": "RUNNING"
}

start a restore operation

Start a restore operation.

Authorizations:

BearerAuth

path Parameters

databaseID

required

string

String representation of the database ID

query Parameters

snapshotID

required

string

The ID of the snapshot in the source DB used as the basis of the restore operation.

Responses

Response samples

Content type

application/json

{"operationID": "string",
"status": "RUNNING"
}

get the status of a restore operation

Get the status of a restore operation.

Authorizations:

BearerAuth

path Parameters

databaseID required	string String representation of the database ID
operationID required	string The ID of the restore operation.

Responses

Response samples

Content type

application/json

{"operationID": "string",
"status": "RUNNING"
}

Astra DevOps API (2.3.0)

Authentication

Create a new AstraCS token

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

Get a list of tokens for an org

Authorizations:

Responses

Response samples

Deletes a token

Authorizations:

path Parameters

Responses

Response samples

Get a list of clients for an org

Authorizations:

Responses

Response samples

generateTokenForClient

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

Revokes a token

Authorizations:

path Parameters

Responses

Response samples

Database Operations

Returns a list of databases

Authorizations:

query Parameters

Responses

Response samples

Create a new database

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Finds database by ID

Authorizations:

path Parameters

Responses

Response samples

Adds keyspace into database

Authorizations:

path Parameters

Responses

Response samples

Removes keyspace

Authorizations:

path Parameters

Responses

Response samples

Obtain zip for connecting to the database

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Configure Astra Remote Telemetry

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve Remote Telemetry configuration

Authorizations:

path Parameters

Responses

Response samples

Terminates a database

Authorizations:

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required