How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

DataStax Database Operations API

Use these DevOps APIs to manage Astra databases.

DataStax Database Operations API is one of 17 APIs that DataStax publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Database Operations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 22 operations across 15 paths, and defines 36 schemas. It is described by OpenAPI 3.0.0, at version 2.3.0.

Requests are made against a single base URL, https://api.astra.datastax.com/.

22 operations 15 paths 36 schemas 2 DELETE6 GET12 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.3.0
Base URL
https://api.astra.datastax.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

DataStax Database Operations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — An application token must be passed in header in order to access the API. https://docs.datastax.com/en/astra-db-serverless/administration/manage-application-to…

Paths & Operations 22

Across 15 paths, the API surfaces 22 operations — 2 DELETE, 6 GET, 12 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Database Operations 22

Use these DevOps APIs to manage Astra databases.

GET
/v2/databases
Returns a list of databases
listDatabases 4 params → 2004004015XX
POST
/v2/databases
Create a new database
createDatabase body → 201400401422500
GET
/v2/databases/{databaseID}
Finds database by ID
getDatabase 1 param → 2004004014045XX
POST
/v2/databases/{databaseID}/keyspaces/{keyspaceName}
Adds keyspace into database
addKeyspace 2 params → 2014014044094225XX
DELETE
/v2/databases/{databaseID}/keyspaces/{keyspaceName}
Removes keyspace
removeKeyspace 2 params → 2044004014045XX
POST
/v2/databases/{databaseID}/keyspaces/{keyspaceName}/actions/alterWithGraphEngine
Alter keyspace to enable graph engine
alterKeyspaceWithGraphEngine 2 params → 202204400401500
POST
/v2/databases/{databaseID}/secureBundleURL
Obtain zip for connecting to the database
generateSecureBundleURL 2 params → 2004004014044095XX
POST
/v2/databases/{databaseID}/telemetry/metrics
Configure Astra Remote Telemetry
configureTelemetry 1 param body → 2024004014034044095XX
GET
/v2/databases/{databaseID}/telemetry/metrics
Retrieve Remote Telemetry configuration
getTelemetryConfig 1 param → 2004004014034044095XX
POST
/v2/databases/{databaseID}/terminate
Terminates a database
terminateDatabase 2 params → 2024004014044095XX
POST
/v2/databases/{databaseID}/resize
Resizes a database
resizeDatabase 1 param body → 2024004014044095XX
GET
/v2/databases/{databaseID}/datacenters
List all database datacenters
listDatacenters 2 params → 2004015XX
POST
/v2/databases/{databaseID}/datacenters
Adds datacenters
addDatacenters 1 param body → 2014004014045XX
POST
/v2/databases/{databaseID}/datacenters/{datacenterID}/terminate
Terminates a datacenter
terminateDatacenter 2 params → 2024004014044095XX
POST
/v2/databases/{databaseID}/resetPassword
Resets Password
resetPassword 1 param body → 2024004014044095XX
PUT
/v2/databases/{databaseID}/engineType
Updates the database engine type
updateEngineType 1 param body → 2024004014045XX
POST
/v3/databases/{databaseID}/cdc
Enable CDC for a Database
enableCDC 1 param body → 2014004014044095XX
PUT
/v3/databases/{databaseID}/cdc
Update CDC config
updateCDC 1 param body → 2014004014044095XX
GET
/v3/databases/{databaseID}/cdc
List all active CDC configs
getCDC 1 param → 2004014045XX
DELETE
/v3/databases/{databaseID}/cdc
Delete CDC for tables in Database
deleteCDC 1 param body → 2044004014044095XX
GET
/v3/databases/{databaseID}/keyspaces/{keyspaceName}/tables/{tableName}/cdc
Check CDC status for a table
getCDCStatus 3 params → 2004014045XX
POST
/v2/databases/{databaseID}/keyspaces/{keyspaceName}/tables/{tableName}/solr/createCorewithconfigs
Create a Solr index for an E tier Managed Cluster (Classic) database.
createSolrIndex 6 params → 202204400401500

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are Datacenter (19 properties), Database (14 properties), DatabaseInfoCreate (8 properties), DatabaseInfo (8 properties). Each schema is shown below with its type and property counts.

CredsURL
object
CredsURL from which the creds zip may be downloaded
8 properties 1 required
RemotePrometheusBasicAuthTelemetryRequest
SplunkTelemetryRequest
object
Telemetry Config for Splunk. The metric name is formatted differently from other sinks, using dot to connect namespaces. The format entails defaultnamespace.ku…
1 property 1 required
DeleteCDCRequest
object
Request schema for deleting CDC on a database
2 properties 2 required
Database
object
Database contains the key information about a database
14 properties 5 required
KafkaTelemetryRequest
object
Telemetry Config for Kafka
1 property 1 required
CredsURLList
array
an array of credsURL
Datacenter
object
Datacenter is the definition of a cassandra datacenter
19 properties 4 required
DatadogTelemetryRequestBlock
object
Telemetry Config Block for Datadog servers
2 properties 1 required
DatabaseInfoCreate
object
DatabaseInfo is the user-provided information describing a database
8 properties 5 required
RemotePrometheusTelemetryRequestBlock
Telemetry Config for Prometheus Remote Write
KafkaTelemetryRequestBlock
object
Telemetry Config Block for Kafka servers
6 properties 5 required
PulsarTelemetryRequestBlock
Telemetry Config
StatusEnum
string
DatabaseInfo
object
DatabaseInfo is the user-provided information describing a database
8 properties
Error
object
ModelError information that is returned to users
2 properties 2 required
PulsarOAuth2TelemetryRequest
RemotePrometheusBearerAuthTelemetryRequest
GetCDCResponse
object
Request schema for enabling CDC on a database
5 properties 6 required
RemotePrometheusTelemetryRequest
object
Telemetry Config for Prometheus Remote Write
1 property 1 required
Errors
object
Errors is a collection of individual Error objects
1 property 1 required
RemotePrometheusAuthRequest
object
The base object for a Prometheus Remote Write object
2 properties 2 required
EnableCDCRequest
object
Request schema for enabling CDC on a database
3 properties 3 required
KafkaBootstrapServer
string
A Hostname and Port combination for a Kafka Bootstrap Server
UserPassword
object
UserPassword specifies a username and new password. The specified password will be updated for the specified database user
2 properties
PulsarTelemetryRequest
object
Telemetry Config for Pulsar servers
1 property 1 required
PulsarTokenAuthTelemetryRequest
CapacityUnits
object
CapacityUnits is the amount of space available for horizontal scaling for a Managed Cluster (Classic) database. This parameter has no relationship to Provision…
1 property
CloudWatchTelemetryRequestBlock
object
Telemetry Config Block for CloudWatch servers
3 properties 3 required
Storage
object
Storage contains the information about how much storage space a cluster has available
5 properties 3 required
SplunkTelemetryRequestBlock
object
Telemetry Config Block for Splunk servers
5 properties 3 required
ListCDCResponse
object
Request schema for enabling CDC on a database
5 properties 5 required
PulsarAuthRequest
object
The base object for a Pulsar object
4 properties 3 required
EngineType
object
EngineType is the type of database engine used by the database
1 property
CloudWatchTelemetryRequest
object
Telemetry Config Block for AWS CloudWatch
1 property 1 required
DatadogTelemetryRequest
object
Telemetry Config Block for Datadog
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datastax-database-operations-api-openapi.yml Raw ↑

Other APIs DataStax publishes across the network.

DataStax Access List API
DataStax Authentication API
DataStax Clone API
DataStax Customer Keys API
DataStax DevOps Access List API
DataStax Enterprise Operations API
DataStax Migrations API
DataStax Organization Operations API
DataStax PCU API
DataStax Private Link API
DataStax Regions API
DataStax Roles API
Where this information came from

This is an independent, third-party profile of DataStax Database Operations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.