Give Feedback

pydo.databases.update_online_migration()

Generated on 9 Jun 2026 from pydo version v0.36.0

Copy page as Markdown View page as Markdown

Usage

client.databases.update_online_migration(
    database_cluster_uuid="9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
    body={
        "source": {...},
        "disable_ssl": False,
        "ignore_dbs": [...],
    },
)

Returns JSONRaises HttpResponseError

Description

To start an online migration, send a PUT request to /v2/databases/{database_cluster_uuid}/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.

Parameters

database_cluster_uuid string required

A unique identifier for a database cluster.

source object required

Show child properties

host string optional

Example: backend-do-user-19081923-0.db.ondigitalocean.com

The FQDN pointing to the database cluster's current primary node.

port integer optional

Example: 25060

The port on which the database cluster is listening.

dbname string optional

Example: defaultdb

The name of the default database.

username string optional

Example: doadmin

The default user for the database.

password string optional

Example: wv78n3zpz42xezdk

The randomly generated password for the default user.

disable_ssl boolean optional

Example: False

Enables SSL encryption when connecting to the source database.

ignore_dbs array of strings optional

Example: ['db0', 'db1']

List of databases that should be ignored during migration.

Default: []

Request Sample

Show Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

req = {
  "source": {
    "host": "source-do-user-6607903-0.b.db.ondigitalocean.com",
    "dbname": "defaultdb",
    "port": 25060,
    "username": "doadmin",
    "password": "paakjnfe10rsrsmf"
  },
  "disable_ssl": False
  "ignore_dbs": ["db0","db1"]
}

update_resp = client.databases.update_online_migration(database_cluster_uuid="a7a8bas", body=req)

Response Example

Show Response Example

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

More Information

See /v2/databases/{database_cluster_uuid}/online-migration in the API reference for additional detail on responses, headers, parameters, and more.