GET /v2/databases
To list all of the database clusters available on your account, send a GET request to /v2/databases. To limit the results to database clusters with a specific tag, include the tag_name query parameter set to the name of the tag. For example, /v2/databases?tag_name=$TAG_NAME.
The result will be a JSON object with a databases key. This will be set to an array of database objects, each of which will contain the standard database attributes.
The embedded connection and private_connection objects will contain the information needed to access the database cluster. For multi-node clusters, the standby_connection and standby_private_connection objects will contain the information needed to connect to the cluster's standby node(s).
The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster.
Servers
- https://api.digitalocean.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
tag_name |
String | No |
Limits the results to database clusters with a specific tag. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.