v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB

DigitalOcean-public.v2-new_Databases

Start an 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, Caching, 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, Caching, and Valkey clusters.

put/v2/databases/{database_cluster_uuid}/online-migration

Path parameters

database_cluster_uuidstring uuid required

A unique identifier for a database cluster.

Request body

disable_sslboolean

Enables SSL encryption when connecting to the source database.

ignore_dbsstring[]

List of databases that should be ignored during migration.

Example request

{
  "source": {
    "host": "backend-do-user-19081923-0.db.ondigitalocean.com",
    "port": 25060,
    "dbname": "defaultdb",
    "username": "doadmin",
    "password": "wv78n3zpz42xezdk"
  },
  "ignore_dbs": [
    "db0",
    "db1"
  ]
}

Response

A JSON object.

idstring

The ID of the most recent migration.

status'running' | 'syncing' | 'canceled' | 'error' | 'done'

The current status of the migration.

created_atstring

The time the migration was initiated, in ISO 8601 format.

Example response

{
  "id": "77b28fc8-19ff-11eb-8c9c-c68e24557488",
  "status": "running",
  "created_at": "2020-10-29T15:57:38Z"
}