doctl databases get

Go to Navigation


doctl databases get <database-cluster-id> [flags]




Retrieves the following details about the specified database cluster:

  • The database ID, in UUID format
  • The name you gave the database cluster
  • The database engine. Possible values: redis, pg, mysql , mongodb, or kafka
  • The engine version, such as 14 for PostgreSQL version 14
  • The number of nodes in the database cluster
  • The region the database cluster resides in, such as sfo2, nyc1
  • The current status of the database cluster, such as online
  • The size of the machine running the database instance, such as db-s-1vcpu-1gb)
  • A connection string for the database cluster
  • The date and time when the database cluster was created

This command requires the ID of a database cluster, which you can retrieve by calling:

doctl databases list


The following example retrieves the details for a database cluster with the ID f81d4fae-7dec-11d0-a765-00a0c91e6bf6 and uses the --format flag to return only the database’s ID, engine, and engine version:

doctl databases get f81d4fae-7dec-11d0-a765-00a0c91e6bf6


Option Description
--format Columns for output in a comma-separated list. Possible values: ID, Name, Engine, Version, NumNodes, Region, Status, Size, URI, Created, StorageMib.
--help , -h Help for this command
--no-header Return raw data with no headers
Default: false
Command Description
doctl databases Display commands that manage databases

Global Flags

Option Description
--access-token, -t API V2 access token
--api-url, -u Override default API endpoint
--config, -c Specify a custom config file
  • macOS: ${HOME}/Library/Application Support/doctl/config.yaml
  • Linux: ${XDG_CONFIG_HOME}/doctl/config.yaml
  • Windows: %APPDATA%\doctl\config.yaml
--context Specify a custom authentication context name
--http-retry-max Set maximum number of retries for requests that fail with a 429 or 500-level error
Default: 5
--http-retry-wait-max Set the minimum number of seconds to wait before retrying a failed request
Default: 30
--http-retry-wait-min Set the maximum number of seconds to wait before retrying a failed request
Default: 1
--interactive Enable interactive behavior. Defaults to true if the terminal supports it (default false)
Default: false
--output, -o Desired output format [text|json]
Default: text
--trace Show a log of network activity while performing a command
Default: false
--verbose, -v Enable verbose output
Default: false