doctl databases replica get

Go to Navigation


doctl databases replica get <database-id> <replica-name> [flags]




Gets the following details for the specified read-only replica for the specified database cluster:

  • The name of the replica
  • Information required to connect to the read-only replica
  • The region where the database cluster is located (e.g. nyc3, sfo2)
  • The status of the replica (possible values are creating, forking, or active)
  • A time value given in ISO8601 combined date and time format that represents when the read-only replica was created.

This command requires that you pass in the replica’s name, which you can retrieve by querying a database ID:

doctl databases replica list ca9f591d-5555-5555-a0ef-1c02d1d1e352

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

doctl databases list


Option Description
--format Columns for output in a comma-separated list. Possible values: ```Name, ID, Region, Status, URI, Created`.
--help , -h Help for this command
--no-header Return raw data with no headers
Default: false
Command Description
doctl databases replica Display commands to manage read-only database replicas

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
--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