PUT /v2/databases/{database_cluster_uuid}/online-migration
To start an online migration, send a PUT request to /v2/databases/$DATABASE_ID/online-migration endpoint. Migrating a cluster establishes a connection with an existing cluster and replicates its contents to the target cluster. Online migration is only available for MySQL, PostgreSQL, Redis, and Valkey clusters.
If the existing database is continuously being written to, the migration process will continue for up to two weeks unless it is manually stopped. Online migration is only available for MySQL, PostgreSQL, Redis, and Valkey clusters.
Servers
- https://api.digitalocean.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
database_cluster_uuid |
String | Yes |
A unique identifier for a database cluster. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
source |
Object | Yes | |
source.port |
Integer | No |
The port on which the database cluster is listening. |
source.username |
String | No |
The default user for the database. |
source.dbname |
String | No |
The name of the default database. |
source.password |
String | No |
The randomly generated password for the default user. |
source.host |
String | No |
The FQDN pointing to the database cluster's current primary node. |
disable_ssl |
Boolean | No |
Enables SSL encryption when connecting to the source database. |
ignore_dbs[] |
Array | No |
List of databases that should be ignored during migration. |
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.