Find all databases (HTTP)

For details about additional languages, see:

Lists all databases.

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

Returns 200 Success and an array of objects that each describe a database.

Example response, truncated for brevity:

[
  {
    "id": "DATABASE_ID",
    "orgId": "organizations/ORGANIZATION_ID",
    "ownerId": "users/USER_ID",
    "info": {
      "name": "DB_NAME",
      "keyspace": "INITIAL_KEYSPACE_NAME",
      "cloudProvider": "CLOUD_PROVIDER",
      "region": "REGION",
      "additionalKeyspaces": [
        "SECOND_KEYSPACE_NAME"
      ],
      "dbType": "vector"
    },
    "creationTime": "2012-11-01T22:08:41+00:00",
    "terminationTime": "2019-11-01T22:08:41+00:00",
    "status": "ACTIVE",
    # Response truncated for brevity
  }
]

Parameters

Use the DevOps API to get information about all databases in an organization.

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

Command signature

curl -sS -L -X GET "https://api.astra.datastax.com/v2/databases?include=STRING&provider=STRING&starting_after=STRING&limit=INTEGER" \
--header "Authorization: Bearer APPLICATION_TOKEN" \
--header "Content-Type: application/json"

Name Type Summary

Name	Type	Summary
`include`	`str`	Optional. Filters the returned databases by status. Can be one of: `nonterminated`, `all`, `active`, `associating`, `pending`, `preparing`, `prepared`, `initializing`, `parked`, `parking`, `unparking`, `terminating`, `terminated`, `resizing`, `error`, `maintenance`, `suspended`, `suspending`. Some of these status are short-lived or do not apply to Astra DB Serverless databases. Default: `nonterminated`
`provider`	`str`	Optional. Filters the returned databases by cloud provider. Can be one of: `ALL`, `GCP`, `AWS`, `AZURE`. Default: `ALL`
`starting_after`	`string`	Optional. Pass the database ID of the last item on the previous page to get the next page.
`limit`	`int`	Optional. The number of results per page. Maximum: 100 Default: 25

include

str

Optional. Filters the returned databases by status.

Can be one of: nonterminated, all, active, associating, pending, preparing, prepared, initializing, parked, parking, unparking, terminating, terminated, resizing, error, maintenance, suspended, suspending.

Some of these status are short-lived or do not apply to Astra DB Serverless databases.

Default: nonterminated

provider

str

Optional. Filters the returned databases by cloud provider.

Can be one of: ALL, GCP, AWS, AZURE.

Default: ALL

starting_after

string

Optional. Pass the database ID of the last item on the previous page to get the next page.

limit

int

Optional. The number of results per page.

Maximum: 100

Default: 25

Examples

The following examples demonstrate how to list databases.

curl -sS -L -X GET "https://api.astra.datastax.com/v2/databases" \
  --header "Authorization: Bearer APPLICATION_TOKEN" \
  --header "Content-Type: application/json"

Find all databases (HTTP)

Result

Parameters

Examples

Was this helpful?

Give Feedback