Give Feedback

pydo.databases.list()

Generated on 7 Jul 2026 from pydo version v0.39.0

Copy page as Markdown View page as Markdown

Usage

client.databases.list(
    database_cluster_uuid="9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
)

Returns JSONRaises HttpResponseError

Description

To list all of the databases in a clusters, send a GET request to /v2/databases/{database_cluster_uuid}/dbs.

The result will be a JSON object with a dbs key. This will be set to an array of database objects, each of which will contain the standard database attributes.

Note: Database management is not supported for Caching or Valkey clusters.

Parameters

database_cluster_uuid string required: A unique identifier for a database cluster.

Request Sample

Show Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

get_resp = client.databases.list(database_cluster_uuid="a7aba9d")

Response Example

Show Response Example

{
  "dbs": [
    {
      "name": "alpha"
    },
    {
      "name": "defaultdb"
    }
  ]
}

More Information

See /v2/databases/{database_cluster_uuid}/dbs in the API reference for additional detail on responses, headers, parameters, and more.