Introduction The IBM Cloud Databases v5 API is a supplemental layer that adds the capability to manage IBM Cloud Databases through a REST API. The API is designed to provide users and developers the ability to examine their database deployments, upgrade deployments, manage users, manage connections, monitor tasks, and work with backups. Prior versions of the API documentation can be found at: - IBM Cloud Databases v4 APIhttps://cloud.ibm.com/apidocs/cloud-databases-api/cloud-databases-api-v4 Endpoint URLs The API is available at these public endpoints: - https://api.us-south.databases.cloud.ibm.com/v5/ibm/ - https://api.eu-de.databases.cloud.ibm.com/v5/ibm/ - https://api.jp-tok.databases.cloud.ibm.com/v5/ibm/ - https://api.osl01.databases.cloud.ibm.com/v5/ibm/ - https://api.au-syd.databases.cloud.ibm.com/v5/ibm/ - https://api.us-east.databases.cloud.ibm.com/v5/ibm/ - https://api.eu-gb.databases.cloud.ibm.com/v5/ibm/ - https://api.seo01.databases.cloud.ibm.com/v5/ibm/ - https://api.che01.databases.cloud.ibm.com/v5/ibm/ The API is also available at these private endpoints: - https://api.us-south.private.databases.cloud.ibm.com/v5/ibm/ - https://api.eu-de.private.databases.cloud.ibm.com/v5/ibm/ - https://api.jp-tok.private.databases.cloud.ibm.com/v5/ibm/ - https://api.osl01.private.databases.cloud.ibm.com/v5/ibm/ - https://api.au-syd.private.databases.cloud.ibm.com/v5/ibm/ - https://api.us-east.private.databases.cloud.ibm.com/v5/ibm/ - https://api.eu-gb.private.databases.cloud.ibm.com/v5/ibm/ - https://api.seo01.private.databases.cloud.ibm.com/v5/ibm/ - https://api.che01.private.databases.cloud.ibm.com/v5/ibm/ You must use the endpoint from the same region as your deployment. A deployment's endpoint is also available on its Overview tab or in any generated service credentials. Authentication Access to the API uses token authentication, by using the header Authorization: Bearer Method Path Summary GET /deployables List all deployable databases GET /regions List all deployable regions GET /deployments/{id} Get deployment information POST /deployments/{id}/users/{user_type} Creates a user based on user type PATCH /deployments/{id}/users/{user_type}/{username} Update a user's password or role. DELETE /deployments/{id}/users/{user_type}/{username} Deletes a user based on user type GET /deployments/{id}/users/{user_id}/ Discover user name and password information for a deployment for a user with an endpoint type. PATCH /deployments/{id}/configuration Change your database configuration GET /deployments/{id}/configuration/schema Get the schema of the database configuration GET /deployments/{id}/remotes List read-only replica information PATCH /deployments/{id}/remotes Modify read-only replication on a deployment POST /deployments/{id}/remotes/resync Resync read-only replica POST /deployments/{id}/remotes/promotion Promote read-only replica to a full deployment GET /deployments/{id}/tasks List currently running tasks on a deployment GET /tasks/{id} Get information about a task GET /backups/{backup_id} Get information about a backup GET /deployments/{id}/backups List currently available backups from a deployment POST /deployments/{id}/backups Initiate an on-demand backup GET /deployments/{id}/point_in_time_recovery_data Get earliest point-in-time-recovery timestamp GET /deployments/{id}/users/{user_type}/{user_id}/connections/{endpoint_type} Discover connection information for a deployment for a user with an endpoint type. POST /deployments/{id}/users/{user_type}/{user_id}/connections/{endpoint_type} Discover connection information for a deployment for a user with substitutions and an endpoint type. GET /deployments/{id}/users/{user_type}/{user_id}/connections Discover connection information for a deployment for a user. POST /deployments/{id}/users/{user_type}/{user_id}/connections Discover connection information for a deployment for a user with substitutions. GET /deployments/{id}/groups List currently available scaling groups from a deployment GET /deployables/{type}/groups Get default scaling groups for a new deployment PATCH /deployments/{id}/groups/{group_id} Set scaling values on a specified group. GET /deployments/{id}/groups/{group_id}/autoscaling Get the autoscaling configuration from a deployment PATCH /deployments/{id}/groups/{group_id}/autoscaling Set the autoscaling configuration from a deployment DELETE /deployments/{id}/management/database_connections Kill connections to a PostgreSQL or EnterpriseDB deployment POST /deployments/{id}/elasticsearch/file_syncs Sync files uploaded to Elasticsearch deployment POST /deployments/{id}/postgresql/logical_replication_slots Create a new logical replication slot DELETE /deployments/{id}/postgresql/logical_replication_slots/{name} Delete a logical replication slot GET /deployments/{id}/allowlists/ip_addresses Retrieve the allowlisted addresses and ranges for a deployment. PUT /deployments/{id}/allowlists/ip_addresses Set the allowlist for a deployment. POST /deployments/{id}/allowlists/ip_addresses Add an address or range to the allowlist for a deployment. DELETE /deployments/{id}/allowlists/ip_addresses/{ipaddress} Delete an address or range from the allowlist of a deployment. POST /capability/{capability_id} Discover capability information. GET /deployments/{id}/capability/{capability_id} Discover capability information from a deployment. GET /backups/{backup_id}/capability/{capability_id} Discover capability information from a backup. PATCH /deployments/{id}/version Upgrade your database version