Download OpenAPI specification:Download
Use these REST APIs to perform lifecycle actions for DataStax Astra databases and DataStax Astra Streaming Pulsar instances.
The Astra DB DevOps APIs are for interacting with Astra databases and all aspects of their lifecycle.
Get a list of databases visible to the user.
org-db-view
) include | string Default: "nonterminated" Enum: "nonterminated" "all" "active" "pending" "preparing" "prepared" "initializing" "parked" "parking" "unparking" "terminating" "terminated" "resizing" "error" "maintenance" "hibernating" "hibernated" "resuming" 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": "serverless",
- "capacityUnits": 1,
- "region": "us-west-2",
- "user": "db_admin",
- "password": "*****",
- "additionalKeyspaces": [
- "additionalKeyspace"
]
}, - "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
}, - "availableActions": [
- "park, terminate"
], - "message": "Auto parked due to inactivity",
}
]
Takes a user provided databaseInfo and returns the uuid for a new database.
org-db-create
) Definition of new database.
name required | string Name of the database--user friendly identifier. |
keyspace required | string Keyspace name in database. |
cloudProvider required | string Enum: "AWS" "GCP" This is the cloud provider where the database lives. |
tier required | string Value: "serverless" With the exception of classic databases, all databases are serverless. Classic databases can no longer be created with the DevOps API. |
capacityUnits required | integer [ 1 .. 1 ] Capacity units were used for classic databases, but are not used for serverless databases. Enter 1 CU for serverless databases. Classic databases can no longer be created with the DevOps API. |
region required | string Region refers to the cloud region. |
{- "name": "mySplendidDatabase",
- "keyspace": "myKeyspace",
- "cloudProvider": "AWS",
- "tier": "serverless",
- "capacityUnits": 1,
- "region": "us-west-2"
}
{- "errors": [
- {
- "ID": 123,
- "message": "Something is broken"
}
]
}
Returns specified database.
org-db-view
) 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": "serverless",
- "capacityUnits": 1,
- "region": "us-west-2",
- "user": "db_admin",
- "password": "*****",
- "additionalKeyspaces": [
- "additionalKeyspace"
]
}, - "creationTime": "2012-11-01T22:08:41+00:00",
- "terminationTime": "2019-11-01T22:08:41+00:00",
- "status": "ACTIVE",
- "storage": {
- "nodeCount": 6,
- "replicationFactor": 3,
- "totalStora