Create a database (HTTP)

For details about additional languages, see:

Creates a database.

To replicate a database to additional datacenters, see Deploy an Astra DB Serverless database to multiple regions.

You need an application token with permission to create and configure databases, such as the Organization Administrator role.

For more information, see Get endpoint and token.

Result

Creates a database and returns 201 Created and the database ID.

It takes several minutes for the database to initialize and reach ACTIVE status.

Parameters

Use the DevOps API to create a database.

The application token must have sufficient permissions to perform the requested operations, such as the Organization Administrator role.

Command signature

curl -sS -L -X POST "https://api.astra.datastax.com/v2/databases" \
--header "Authorization: Bearer APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
  "name": "STRING",
  "keyspace": "STRING",
  "cloudProvider": "STRING",
  "region": "STRING",
  "dbType": "STRING",
  "tier": "serverless",
  "capacityUnits": INTEGER,
  "pcuGroupUUID": "STRING"
}'

Name Type Summary

name

string

The name for the database.

Database names must follow these rules:

Must start and end with a letter or number
Can contain letters, numbers, and the special characters & + - _ ( ) < > . , @
Cannot exceed 50 characters

keyspace

string

Optional if dbType is vector. The name for the database’s initial keyspace.

Default if dbType is vector: default_keyspace

cloudProvider

string

The cloud provider that should host the database. Can be one of: aws, gcp, azure.

region

string

The cloud provider region in which to create the database.

The available regions depend on your Astra plan and the database type. To find available regions, see Find available regions (HTTP).

dbType

string

Whether the database is a Serverless (vector) database or a Serverless (non-vector) database.

To create a Serverless (vector) database, set this parameter to vector.

To create a Serverless (non-vector) database, omit this parameter.

The Data API is supported for Serverless (vector) and Serverless (non-vector) databases generally. However, vector and reranking functionalities aren’t compatible with all databases, tables, or collections.

tier

string

The database tier. Must be serverless.

capacityUnits

integer

Must be 1. The number of capacity units for the database. This is unrelated to PCU group capacity.

pcuGroupUUID

string

Optional. The ID of the PCU group to use for provisioning the database. The specified PCU group must have the same cloud provider and region as the database. Only applicable for organizations that use PCU groups.

Default: No PCU group

Examples

The following examples demonstrate how to create a database.

curl -sS -L -X POST "https://api.astra.datastax.com/v2/databases" \
  --header "Authorization: Bearer APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "name": "DATABASE_NAME",
  "keyspace": "",
  "cloudProvider": "gcp",
  "region": "us-east1",
  "dbType": "vector",
  "tier": "serverless",
  "capacityUnits": 1
}'

Create a database (HTTP)

Result

Parameters

Examples

Was this helpful?

Give Feedback