Database Migration API

Name: Database Migration API API
Brand: Database Migration API
Availability: InStock

✓ Official Vendor SpecStorageDatabaseoauth241 EndpointsREST

For Agents

Drive database migrations into Cloud SQL, AlloyDB, and Spanner programmatically. Lets agents create connection profiles, run migration jobs, and manage conversion workspaces without the Cloud Console.

Quickstart

Get started with Database Migration API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"create a database migration job to cloud sql"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Database Migration API API.

Create connection profiles for MySQL, PostgreSQL, Oracle, and SQL Server source databases

Run continuous-replication migration jobs from on-prem or cloud sources to Cloud SQL or AlloyDB

Convert Oracle and SQL Server schemas to PostgreSQL using conversion workspaces

Generate SSH and TCP proxy scripts for self-managed source connectivity

GET STARTED

Start building with Database Migration API API

Explore with Jentic

View OpenAPI Document

Use for: I need to migrate a MySQL database from on-prem to Cloud SQL, Create a connection profile for a PostgreSQL source database, Promote the migration job to cut over to the destination, Convert an Oracle schema to PostgreSQL inside a conversion workspace

Not supported: Does not run application data backfills, perform query-level transformations, or replicate non-database event streams — use for managed homogeneous and heterogeneous database migrations into Cloud SQL, AlloyDB, and Spanner only.

Use Cases

Patterns agents use Database Migration API API for, with concrete tasks.

★ Continuous-Replication Migration to Cloud SQL

Move a production MySQL or PostgreSQL database from on-prem or another cloud into Cloud SQL with continuous replication and a near-zero-downtime cutover. The API creates source and destination connection profiles, starts the migration job in DUMP_AND_CONTINUOUS mode, and exposes a promote operation when the team is ready to switch traffic. Most one-database migrations complete in hours plus the replication lag.

Create source and destination connection profiles, start a migration job named 'mysql-prod-to-cloudsql' in CONTINUOUS mode, verify it, and promote when source and destination report consistent state

Heterogeneous Oracle-to-PostgreSQL Conversion

Convert an Oracle schema to PostgreSQL by creating a conversion workspace, importing the source DDL, applying conversion rules, and exporting the converted schema. The API exposes describeDatabaseEntities and describeConversionWorkspaceRevisions to inspect the conversion result before applying it to a destination AlloyDB or Cloud SQL for PostgreSQL instance.

Create a conversion workspace 'oracle-finance-cw', describe its database entities, apply conversion to a PostgreSQL destination, and report any UNSUPPORTED entities back to the user

Migration CI/CD with Verification Gates

Wire migration jobs into a release pipeline: createConnectionProfile and createMigrationJob from the build environment, verifyMigrationJob as a quality gate, and promote only when the gate passes. The API's restart and stop operations let pipelines retry transient failures or abort cleanly. This supports repeatable database refreshes for staging environments.

Run verifyMigrationJob on 'staging-refresh-2026-06', wait for the operation to complete, and only call promoteMigrationJob if verification reports OK

AI Agent Migration Operator

An AI agent can drive database migrations end-to-end through Jentic without touching the Console. Jentic search returns the matching connection-profile, migration-job, or conversion-workspace operation, the agent loads its schema, and Jentic executes against datamigration.googleapis.com using vault-stored credentials. This removes the multi-day OAuth and long-running-operation plumbing work.

Use Jentic to search 'create a database migration job', load the createMigrationJob schema, and execute it from the configured source profile to a Cloud SQL destination

Key Endpoints

41 endpoints — the google cloud database migration api drives the lifecycle of homogeneous and heterogeneous database migrations into cloud sql, alloydb, and spanner.

METHOD

PATH

DESCRIPTION

POST

/v1/{+parent}/connectionProfiles

Create a source or destination connection profile

POST

/v1/{+parent}/migrationJobs

Create a migration job

POST

/v1/{+name}:verify

Verify a migration job before promotion

POST

/v1/{+name}:promote

Promote the migration job to cut over

POST

/v1/{+migrationJob}:generateSshScript

Generate SSH script for self-managed source

POST

/v1/{+conversionWorkspace}:describeDatabaseEntities

Inspect entities in a conversion workspace

POST

/v1/{+parent}/connectionProfiles

Create a source or destination connection profile

POST

/v1/{+parent}/migrationJobs

Create a migration job

POST

/v1/{+name}:verify

Verify a migration job before promotion

POST

/v1/{+name}:promote

Promote the migration job to cut over

POST

/v1/{+migrationJob}:generateSshScript

Generate SSH script for self-managed source

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Google OAuth client secrets and refresh tokens are stored encrypted in the Jentic vault. Agents receive scoped, short-lived access tokens for datamigration.googleapis.com; raw credentials never enter the agent context.

Intent-based discovery

Agents search Jentic by intent (e.g. 'create a database migration job') and Jentic returns the matching operation with its input schema, so the agent calls the right endpoint without browsing the discovery doc.

Time to first call

Direct Database Migration integration: 3-5 days for OAuth, connection-profile schema work, and operation polling. Through Jentic: under 1 hour.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Cloud SQL Admin API

Cloud SQL Admin manages the destination instances that Database Migration writes into.

Choose Cloud SQL Admin for instance creation, backups, and flag changes on the destination. Use Database Migration to populate it from a source.

Complementary

AlloyDB Admin API

AlloyDB Admin manages PostgreSQL-compatible destinations for Oracle and PostgreSQL migrations.

Choose AlloyDB Admin when the destination is AlloyDB. Use Database Migration to drive the migration job into it.

Alternative

Datastream API

Datastream provides change-data-capture streams; Database Migration provides a managed end-to-end migration with cutover.

Choose Datastream when the use case is ongoing CDC into BigQuery or Cloud Storage. Use Database Migration when the goal is a one-time database move with promotion.

FAQs

Specific to using Database Migration API API through Jentic.

What authentication does the Database Migration API use?

The Database Migration API uses OAuth 2.0 with the cloud-platform scope. Through Jentic the OAuth client and refresh tokens live in the Jentic vault and the agent receives short-lived scoped tokens, so raw Google credentials never enter the agent context.

Can I migrate Oracle to PostgreSQL with this API?

Yes. Create a ConversionWorkspace, import the Oracle DDL, call describeDatabaseEntities to inspect the converted entities, and apply the conversion to a PostgreSQL destination (Cloud SQL for PostgreSQL or AlloyDB). Heterogeneous MySQL-to-PostgreSQL is also supported through the same workflow.

What are the rate limits for the Database Migration API?

Google enforces standard Cloud quotas on datamigration.googleapis.com: per-project rate limits on read/write calls and limits on concurrent migration jobs per region. Quotas are visible in the Cloud Console under IAM and admin, quotas, filtered to datamigration.googleapis.com.

How do I cut over a migration through Jentic?

Search Jentic for 'promote a database migration job', load the schema for POST /v1/{+name}:promote, and execute with the migration-job resource name. Jentic returns the long-running operation; poll until done before pointing application traffic at the destination.

Is the Database Migration API free?

Migrations into Cloud SQL are free for the migration phase; you pay only the standard Cloud SQL or AlloyDB charges of the destination instance plus any egress from the source. Migrations into other targets and ongoing replication beyond cutover may attract additional fees per the official pricing page.

How do I connect to a self-managed source database?

Call POST /v1/{+migrationJob}:generateSshScript or generateTcpProxyScript to retrieve a script that opens a reverse-SSH tunnel or TCP proxy from your bastion host to Google's migration service. Run the script on the bastion before starting the migration job.