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.
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. |
{- "roles": [
- "roleID-UUID"
], - "orgId": "uuid"
}
{- "clientId": "string",
- "secret": "string",
- "orgId": "uuid",
- "roles": [
- "org-write"
], - "token": "uuid"
}
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 |
{- "roles": [
- "org-write"
]
}
[- {
- "clientId": "string",
- "secret": "string",
- "orgId": "uuid",
- "roles": [
- "org-write"
], - "token": "uuid"
}
]
Use these DevOps APIs to manage Astra databases. Park, Unpark, and Resize operations are for Astra Classic databases only.
Get a list of databases visible to the user
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 |
[- {
- "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": [
- "park, terminate"
], - "message": "Auto parked due to inactivity",
}
]
Takes a user provided databaseInfo and returns the uuid for a new database
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. |
{- "name": "mySplendidDatabase",
- "keyspace": "myKeyspace",
- "cloudProvider": "AWS",
- "tier": "developer",
- "capacityUnits": 1,
- "region": "us-west-2",
- "dbType": "vector"
}
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
Returns specified database
databaseID required | string String representation of the database ID |
{- "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": [
- "park, terminate"
], - "message": "Auto parked due to inactivity",
}
Adds the specified keyspace to the database
databaseID required | string String representation of the database ID |
keyspaceName required | string Name of database keyspace |
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
Removes the specified keyspace from the database
databaseID required | string String representation of the database ID |
keyspaceName required | string Name of database keyspace |
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
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:
databaseID required | string String representation of the database ID |
all | boolean Default: false Optional parameter to obtain secure-connect-*.zip for one (false) or many (true) datacenters. If false, |
{- "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"
}
]
}
Enables metrics exporting to an external system. Note: updates replace any existing config.
databaseID required | string String representation of the database ID |
required | object (KafkaTelemetryRequestBlock) Telemetry Config Block for Kafka servers |
{- "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"
}
}
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
Get the current Telemetry configuration for the database
databaseID required | string String representation of the database ID |
{- "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
databaseID required | string String representation of the database ID |
preparedStateOnly | boolean Default: false For internal use only. Used to safely terminate prepared databases. |
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
Suspends a database
databaseID required | string String representation of the database ID |
freeConsumed | integer Default: -1 Represents, from 0 to 100, the free credits percentage consumed. |
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
Resizes a database. Total number of capacity units desired should be specified.
databaseID required | string String representation of the database ID |
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 |
{- "capacityUnits": 4
}
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
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
databaseID required | string String representation of the database ID |
all | boolean Default: false Allows retrieving datacenters in TERMINATED state along with ACTIVE ones |
[- {
- "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,
}
]
Adds the list of datacenters. Supported in AWS, Azure, and Google Cloud.
databaseID required | string String representation of the database ID |
Map containing capacityUnits key with a value greater than the current number of capacity units (max increment of 3 additional capacity units)
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 |
[- {
- "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,
}
]
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
Terminates a datacenter
databaseID required | string String representation of the database ID |
datacenterID required | string String representation of the datacenter ID |
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
Sets a database password to the one specified in POST body
databaseID required | string String representation of the database ID |
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) |
{- "username": "dbusername",
- "password": "MyNewSecur3Passw0rd"
}
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
Enables audit log exporting to an external system.
orgID required | string String representation of the organization ID |
required | any (PulsarTelemetryRequestBlock) Telemetry Config |
{- "pulsar": {
- "endpoint": "pulsar+ssl://pulsar.example.com",
- "auth_strategy": "token",
- "topic": "persistent://test/default/my-topic-123",
- "auth_name": "foobar",
- "token": "AstraTelemetry123"
}
}
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
Get the current audit log configuration or verify the setup status for the organization.
orgID required | string String representation of the organization ID |
{- "pulsar": {
- "endpoint": "pulsar+ssl://pulsar.example.com",
- "auth_strategy": "token",
- "topic": "persistent://test/default/my-topic-123",
- "auth_name": "foobar",
- "token": "AstraTelemetry123"
}
}
Remove audit logging for the organization.
orgID required | string String representation of the organization ID |
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
Create a new organization under the given enterprise.
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 |
{- "name": "string",
- "email": "string",
- "adminUserID": "string",
- "enterpriseID": "string"
}
{- "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"
}
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)
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 |
{- "startDate": "2021-05-06T06:13:23.57Z",
- "endDate": "2021-05-06T06:13:23.57Z",
- "clusterIDs": [
- "string"
], - "orgIDs": [
- "string"
]
}
{- "totalCost": null,
- "costs": [
- {
- "orgId": "abcfc07b-3217-494e-9831-b5058a92961f",
- "clusterID": "d75f25b7-d668-4ff9-9ed6-21a2f22f4568",
- "region": "us-east-1",
- "cost": "101.57878268880637"
}
]
}
[- [
- {
- "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"
}
]
]
The model for create role body
name required | string |
required | object (Policy) A policy for a role in Astra. |
{- "name": "string",
- "policy": {
- "description": "string",
- "resources": [
- "drn:astra:org:__ORG_ID__"
], - "actions": [
- "db-all-keyspace-create"
], - "effect": "allow"
}
}
{- "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"
}
Retrieve the details for a role for a given organization
roleID required | string id for the role |
[- {
- "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
roleID required | string id for the role |
The model for update role body
name required | string |
required | object (Policy) A policy for a role in Astra. |
{- "name": "string",
- "policy": {
- "description": "string",
- "resources": [
- "drn:astra:org:__ORG_ID__"
], - "actions": [
- "db-all-keyspace-create"
], - "effect": "allow"
}
}
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
Invite a user to an organization or resend an invitation with new invitation details, such as an updated expiration
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 |
{- "email": "string",
- "orgID": "string",
- "roles": [
- "string"
]
}
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
{- "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"
}
]
}
]
}
userID required | string id for the user |
{- "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"
}
]
}
userID required | string id for the user |
roles required | Array of strings |
{- "roles": [
- "string"
]
}
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
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. |
{- "roles": [
- "roleID-UUID"
], - "orgId": "uuid"
}
{- "clientId": "string",
- "secret": "string",
- "orgId": "uuid",
- "roles": [
- "org-write"
], - "token": "uuid"
}
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 |
{- "roles": [
- "org-write"
]
}
[- {
- "clientId": "string",
- "secret": "string",
- "orgId": "uuid",
- "roles": [
- "org-write"
], - "token": "uuid"
}
]
[- {
- "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
}
}
]
databaseID required | string String representation of the database ID |
{- "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
}
}
databaseID required | string String representation of the database ID |
Array of objects (AddressRequest) A listing of the allowed addresses | |
object (AccessListConfigurations) |
{- "addresses": [
- {
- "address": "137.187.23.0/24",
- "enabled": true,
- "description": "This address allows the database connections from the prod environment"
}
], - "configurations": {
- "accessListEnabled": true
}
}
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
databaseID required | string String representation of the database ID |
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 |
[- {
- "address": "137.187.23.0/24",
- "enabled": true,
- "description": "This address allows the database connections from the prod environment"
}
]
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
databaseID required | string String representation of the database ID |
Array of objects (AddressRequest) A listing of the allowed addresses | |
object (AccessListConfigurations) |
{- "addresses": [
- {
- "address": "137.187.23.0/24",
- "enabled": true,
- "description": "This address allows the database connections from the prod environment"
}
], - "configurations": {
- "accessListEnabled": true
}
}
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
databaseID required | string String representation of the database ID |
addresses | Array of strings Array of addresses |
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
{- "addresses": [
- {
- "address": "137.187.23.0/24",
- "enabled": true,
- "description": "This address allows the database connections from the prod environment"
}
], - "configurations": {
- "accessListEnabled": true
}
}
View, create, modify, or delete the access list that restricts access to the DevOps API for an Astra organization.
Retrieves a DevOps API Access List for a specific organization by ID.
orgId required | string The ID of the Astra DB organization. |
{- "addresses": [
- {
- "address": "string",
- "description": "string",
- "enabled": true,
- "lastUpdateDateTime": "string",
- "createdAt": "string"
}
]
}
Creates a new DevOps API Access List for a specific organization by ID.
orgId required | string The ID of the Astra DB organization. |
request to create a new access list for the DevOps API
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. |
[- {
- "address": "string",
- "description": "string",
- "enabled": true
}
]
{- "addresses": [
- {
- "address": "string",
- "description": "string",
- "enabled": true,
- "lastUpdateDateTime": "string",
- "createdAt": "string"
}
]
}
Replaces an existing DevOps API Access List with a new one for a specific Astra DB organization by ID.
orgId required | string The ID of the Astra DB organization. |
request to replace an existing access list for the DevOps API with the submitted one
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. |
[- {
- "address": "string",
- "description": "string",
- "enabled": true
}
]
{- "addresses": [
- {
- "address": "string",
- "description": "string",
- "enabled": true,
- "lastUpdateDateTime": "string",
- "createdAt": "string"
}
]
}
Updates an existing DevOps API Access List for a specific Astra DB organization by ID.
orgId required | string The ID of the Astra DB organization. |
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. |
{- "address": "string",
- "description": "string",
- "enabled": true
}
{- "addresses": [
- {
- "address": "string",
- "description": "string",
- "enabled": true,
- "lastUpdateDateTime": "string",
- "createdAt": "string"
}
]
}
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.
orgId required | string The ID of the Astra DB organization. |
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
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
{- "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 cluster
clusterID required | string <uuid> Database ID |
{- "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 a private link connection in a specific datacenter
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. |
{- "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"
}
]
}
Configure private link by providing the allowed principal to connect with
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. |
The model for adding a private link allowed principal
allowedPrincipals | Array of strings (AllowedPrincipals) List of principals to do action for private link |
{- "allowedPrincipals": [
- "arn:aws:iam::123456789012:role/admin"
]
}
{- "serviceName": "com.amazonaws.vpce.us-east-1.vpce-svc-1148ea04af491da11",
- "allowedPrincipals": [
- "arn:aws:iam::123456789012:role/admin"
]
}
Configure private link by providing the allowed principal to connect with
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. |
The model for adding a private link allowed principal
allowedPrincipals | Array of strings (AllowedPrincipals) List of principals to do action for private link |
{- "allowedPrincipals": [
- "arn:aws:iam::123456789012:role/admin"
]
}
{- "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
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. |
The model for removing a private link allowed principal
allowedPrincipal | string The allowed-principal |
{- "allowedPrincipal": "arn:aws:iam::123456789012:role/admin"
}
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
Complete Private Link connection by providing your endpoint
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. |
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 |
{- "endpointID": "vpce-svc-1148ea04af8675309",
- "description": "ecomm-team-billing-app-prod"
}
{- "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
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 |
{- "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
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 |
The model for updating the description for an endpoint
description | string User defined description of the endpoint |
{- "description": "ecomm-team-billing-app"
}
{- "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
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 |
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
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.
[- "string"
]
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.
[- "string"
]
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
Retrieves VPC peering connection details (if any exist) for Astra database
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 |
{- "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 between an Astra database's VPC and the VPC provided
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 |
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 |
{- "tenantId": "string",
- "subscriptionId": "string",
- "resourceGroupName": "string",
- "virtualNetworkName": "string"
}
{- "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 a VPC peering connection for an Astra database on the given cloud provider
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 |
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
A service to create a new Customer Key registration used for serverless database encryption in an organization.
KMS details that need to be created.
orgId | string <uuid> The unique identifier for the organization. |
object (AWS-KMS) | |
object (GCP-KMS) |
{- "orgId": "368600f6-a1e7-42f1-8266-2960de5313f3",
- "aws": {
- "keyID": "string",
- "region": "string"
}, - "gcp": {
- "keyID": "string",
- "region": "string"
}
}
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
A service to retrieve the existing Customer Keys of an organization.
[- {
- "OrganizationID": "string",
- "CloudProvider": "string",
- "KeyID": "string",
- "Region": "string"
}
]
A service to create a new Customer Key registration used for serverless database encryption in an organization.
KMS details that need to be created.
orgId | string <uuid> The unique identifier for the organization. |
object (AWS-KMS) | |
object (GCP-KMS) |
{- "orgId": "368600f6-a1e7-42f1-8266-2960de5313f3",
- "aws": {
- "keyID": "string",
- "region": "string"
}, - "gcp": {
- "keyID": "string",
- "region": "string"
}
}
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
A service to retrieve the existing Customer Keys of an organization.
[- {
- "OrganizationID": "string",
- "CloudProvider": "string",
- "KeyID": "string",
- "Region": "string"
}
]
A service to create a new Customer Key registration used for classic database encryption in an organization.
KMS details that need to be created.
orgId | string <uuid> The unique identifier for the organization. |
object (AWS-KMS) | |
object (GCP-KMS) |
{- "orgId": "368600f6-a1e7-42f1-8266-2960de5313f3",
- "aws": {
- "keyID": "string",
- "region": "string"
}, - "gcp": {
- "keyID": "string",
- "region": "string"
}
}
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
A service to retrieve the existing Customer Keys of an organization.
[- {
- "OrganizationID": "string",
- "CloudProvider": "string",
- "KeyID": "string",
- "Region": "string"
}
]
Retrieves a Serverless Customer Key in an organization for a given cloud-provider & region combination.
provider required | string The name of the provider, such as: aws. |
region required | string The region in which the key exists. |
{- "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 for a given cloud-provider & region combination.
provider required | string The name of the provider, such as: aws. |
region required | string The region in which the key exists. |
{- "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 Cloud provider accounts for a given cloud-provider & region combination to which customers need to grant their KMS keys access to for serverless keys.
provider required | string The name of the provider, such as: aws. |
region required | string The region in which the key exists. |
[- {
- "organization_id": "string",
- "provider_id": "string",
- "provider": "string"
}
]
Assigns a new cloud account for an organization given a cloud provider that will be used for classic database encryption.
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
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.
provider required | string The name of the provider, such as: aws. |
region required | string The region in which the key exists. |
[- {
- "organization_id": "string",
- "provider_id": "string",
- "provider": "string"
}
]
Returns all supported tier, cloud, region, count, and capacity combinations
[- {
- "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 all region, cloud, name, zone and classification info available in serverless
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. |
[- {
- "cloudProvider": "aws",
- "name": "us-west-2",
- "displayName": "US West (Oregon)",
- "zone": "na",
- "classification": "standard",
- "enabled": true,
- "reservedForQualifiedUsers": true,
- "region_type": "vector"
}
]
Initialize a new SSTables based migration.
databaseID required | string String representation of the database ID |
concurrency | string Sets the desired concurrency for the import. |
targetSubsetSizeGB | string Sets the target subset size for the import. |
{- "migrationID": "string",
- "status": "INITIALIZING",
- "concurrency": 0,
- "targetSubsetSizeGB": 0.1
}
Initialize a new SSTables based migration.
databaseID required | string String representation of the database ID |
datacenterID required | string String representation of the datacenter ID |
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. |
{- "migrationID": "string",
- "status": "INITIALIZING",
- "concurrency": 0,
- "targetSubsetSizeGB": 0.1
}
Launch an SSTables based migration.
databaseID required | string String representation of the database ID |
migrationID required | string String representation of the active migration ID |
{- "migrationID": "string",
- "status": "INITIALIZING",
- "concurrency": 0,
- "targetSubsetSizeGB": 0.1
}
pause a migration in the import phase
databaseID required | string String representation of the database ID |
migrationID required | string string representation of the active migration ID |
{- "migrationID": "string",
- "status": "INITIALIZING",
- "concurrency": 0,
- "targetSubsetSizeGB": 0.1
}
resume a migration in the paused phase
databaseID required | string String representation of the database ID |
migrationID required | string string representation of the active migration ID |
{- "migrationID": "string",
- "status": "INITIALIZING",
- "concurrency": 0,
- "targetSubsetSizeGB": 0.1
}
abort a migration
databaseID required | string String representation of the database ID |
migrationID required | string string representation of the active migration ID |
{- "migrationID": "string",
- "status": "INITIALIZING",
- "concurrency": 0,
- "targetSubsetSizeGB": 0.1
}
deletes all artifacts after a concluded migration (complete/failed/aborted)
databaseID required | string String representation of the database ID |
migrationID required | string string representation of the active migration ID |
option.cleanupTime | string Optional parameter indicating the desired time of the cleanup. Format: unix timestamp, e.g. 2024-09-06T15:30:00Z |
{- "migrationID": "string",
- "status": "INITIALIZING",
- "concurrency": 0,
- "targetSubsetSizeGB": 0.1
}
Get status information about an SSTables based migration.
databaseID required | string String representation of the database ID |
migrationID required | string String representation of the active migration ID |
{- "migrationID": "string",
- "status": "INITIALIZING",
- "concurrency": 0,
- "targetSubsetSizeGB": 0.1
}
Use the DevOps API to manage provisioned capacity units for eligible organizations and databases.
Gets the PCU groups
PCU group UUIDs
pcuGroupUUIDs | Array of strings PCU group UIDs |
orgID | string OrganizationID of the PCU group, ignored for authenticated users |
{- "pcuGroupUUIDs": [
- 1
], - "orgID": "some-org"
}
[- {
- "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"
}
]
Given PCU group information, creates a PCU group
PCU group model.
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 |
[- {
- "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"
}
]
[- {
- "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"
}
]
Given PCU group information, updates the PCU groups
PCU Group model.
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 |
[- {
- "pcuGroupUUID": "9aaddbb5-4622-447c-9bc5-b036bb9d7ed8",
- "title": "some title",
- "instanceType": "standard",
- "provisionType": "shared",
- "min": 1,
- "max": 1,
- "reserved": 1,
- "description": "some-description"
}
]
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
Given a PCU group UUID, returns all associated datacenters and their status
pcuGroupUUID required | string The PCU group UUID to get the associated datacenters and their status |
[- {
- "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"
}
]
Given PCU group UUID and datacenter UUID, creates a PCU group association
pcuGroupUUID required | string The PCU group UUID part of this association |
datacenterUUID required | string The datacenter UUID part of this association |
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
Given datacenter UUID and PCU group UUID, delete the association
pcuGroupUUID required | string The PCU group UUID part of this association |
datacenterUUID required | string The datacenter UUID part of this association |
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}