API docs by Redocly

Astra DB Serverless Data API (1.0.20)

Download OpenAPI specification:Download

URL: https://stargate.io License: Apache 2.0 Terms of Service

The Astra DB Serverless Data API modifies and queries data stored as unstructured JSON documents in collections. See the documentation site for additional information.

General

Executes general commands.

Execute command

Executes a single general command.

Authorizations:
Token
Request Body schema: application/json
Any of
name
required
string [ 1 .. 48 ] characters [a-zA-Z][a-zA-Z0-9_]*

Name of the keyspace

object (CreateKeyspace.Options)

Options for creating a new keyspace.

Responses

Request samples

Content type
application/json
Example
{
  • "createKeyspace": {
    }
}

Response samples

Content type
application/json
Example
{
  • "status": {
    }
}

Keyspaces

Executes keyspace commands.

Execute command

Executes a single command against a collection.

Authorizations:
Token
path Parameters
keyspace
required
string <= 48 characters [a-zA-Z][a-zA-Z0-9_]*
Example: cycling

The keyspace where the collection is located.

Request Body schema: application/json
Any of
name
required
string [ 1 .. 48 ] characters [a-zA-Z][a-zA-Z0-9_]*

Name of the collection

object

Configuration options for the collection

Responses

Request samples

Content type
application/json
Example
{
  • "createCollection": {
    }
}

Response samples

Content type
application/json
Example
{
  • "status": {
    }
}

Documents

Executes document commands against a single collection.

Execute command

Executes a single command against a collection.

Authorizations:
Token
path Parameters
keyspace
required
string <= 48 characters [a-zA-Z][a-zA-Z0-9_]*
Example: cycling

The keyspace where the collection is located.

collection
required
string <= 48 characters [a-zA-Z][a-zA-Z0-9_]*
Example: events

The name of the collection.

Request Body schema: application/json
Any of
object (JsonNode)
object (FilterClause)

Responses

Request samples

Content type
application/json
Example
{
  • "countDocuments": {
    }
}

Response samples

Content type
application/json
Example
{
  • "status": {
    }
}