doctl databases replica get
Generated on 10 Jun 2025
from doctl
version
v1.130.0
Usage
doctl databases replica get <database-cluster-id> <replica-name> [flags]
Aliases
g
Description
Gets the following details for the specified read-only replica of the specified database cluster:
- The name of the replica
- The information required to connect to the read-only replica
- The region where the database cluster is located, such as
nyc3
orsfo2
- The status of the replica. Possible values:
creating
,forking
,active
- When the read-only replica was created, in ISO8601 date/time format
This command requires that you pass in the replica’s name, which you can retrieve by querying a database ID:
doctl databases replica list <database-cluster-id>
This command requires the ID of a database cluster, which you can retrieve by calling:
doctl databases list
Example
The following example retrieves the details for a read-only replica named example-replica
for a database cluster with the ID ca9f591d-f38h-5555-a0ef-1c02d1d1e35
:
doctl databases replica get ca9f591d-f38h-5555-a0ef-1c02d1d1e35 example-replica
Flags
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 |
Related Commands
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 Default: |
--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 |