Google

Database Migration API

Manage Cloud Database Migration Service resources on Google Cloud Platform.

Data & analytics#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Manage Cloud Database Migration Service resources on Google Cloud Platform.

Endpoints 44

projects.locations

  • GETFetches a set of static IP addresses that need to be allowlisted by the customer when using the static-IP connectivity…/v1/:name:fetchStaticIps?fetchReservedPublicIps=true&pageSize=0&pageToken=stringFetches a set of static IP addresses that need to be allowlisted by the customer when using the static-IP connectivity method.
  • GETLists information about the supported locations for this service/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…

projects.locations.privateConnections

  • GETGets details of a single private connection./v1/:nameGets details of a single private connection.
  • DELETEDeletes a single Database Migration Service private connection./v1/:name?requestId=stringDeletes a single Database Migration Service private connection.
  • GETGets the access control policy for a resource/v1/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
  • POSTSets the access control policy on the specified resource/v1/:resource:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
  • POSTReturns permissions that a caller has on the specified resource/v1/:resource:testIamPermissionsReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND…
  • GETRetrieves a list of private connections in a given project and location./v1/:parent/privateConnections?filter=string&orderBy=string&pageSize=0&pageToken=stringRetrieves a list of private connections in a given project and location.
  • POSTCreates a new private connection in a given project and location./v1/:parent/privateConnections?privateConnectionId=string&requestId=string&skipValidation=true&validateOnly=trueCreates a new private connection in a given project and location.

projects.locations.migrationJobs

  • PATCHUpdates the parameters of a single migration job./v1/:name?requestId=string&updateMask=stringUpdates the parameters of a single migration job.
  • GETLists migration jobs in a given project and location./v1/:parent/migrationJobs?filter=string&orderBy=string&pageSize=0&pageToken=stringLists migration jobs in a given project and location.
  • POSTCreates a new migration job in a given project and location./v1/:parent/migrationJobs?migrationJobId=string&requestId=stringCreates a new migration job in a given project and location.
  • POSTDemotes the destination database to become a read replica of the source/v1/:name:demoteDestinationDemotes the destination database to become a read replica of the source. This is applicable for the following migrations: 1. MySQL to Cloud SQL for MySQL 2.…
  • GETRetrieves objects from the source database that can be selected for data migration/v1/:name:fetchSourceObjectsRetrieves objects from the source database that can be selected for data migration. This is applicable for the following migrations: 1. PostgreSQL to Cloud…
  • POSTGenerate a SSH configuration script to configure the reverse SSH connectivity./v1/:migrationJob:generateSshScriptGenerate a SSH configuration script to configure the reverse SSH connectivity.
  • POSTGenerate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy./v1/:migrationJob:generateTcpProxyScriptGenerate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.
  • POSTPromote a migration job, stopping replication to the destination and promoting the destination to be a standalone…/v1/:name:promotePromote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.
  • POSTRestart a stopped or failed migration job, resetting the destination instance to its original state and starting the…/v1/:name:restartRestart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.
  • POSTResume a migration job that is currently stopped and is resumable (was stopped during CDC phase)./v1/:name:resumeResume a migration job that is currently stopped and is resumable (was stopped during CDC phase).
  • POSTStart an already created migration job./v1/:name:startStart an already created migration job.
  • POSTStops a running migration job./v1/:name:stopStops a running migration job.
  • POSTVerify a migration job, making sure the destination can reach the source and that all configuration and prerequisites…/v1/:name:verifyVerify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.

projects.locations.connectionProfiles

  • GETRetrieves a list of all connection profiles in a given project and location./v1/:parent/connectionProfiles?filter=string&orderBy=string&pageSize=0&pageToken=stringRetrieves a list of all connection profiles in a given project and location.
  • POSTCreates a new connection profile in a given project and location./v1/:parent/connectionProfiles?connectionProfileId=string&requestId=string&skipValidation=true&validateOnly=trueCreates a new connection profile in a given project and location.

projects.locations.conversionWorkspaces

  • POSTApplies draft tree onto a specific destination database./v1/:name:applyApplies draft tree onto a specific destination database.
  • POSTMarks all the data in the conversion workspace as committed./v1/:name:commitMarks all the data in the conversion workspace as committed.
  • POSTCreates a draft tree schema for the destination database./v1/:name:convertCreates a draft tree schema for the destination database.
  • GETLists conversion workspaces in a given project and location./v1/:parent/conversionWorkspaces?filter=string&pageSize=0&pageToken=stringLists conversion workspaces in a given project and location.
  • POSTCreates a new conversion workspace in a given project and location./v1/:parent/conversionWorkspaces?conversionWorkspaceId=string&requestId=stringCreates a new conversion workspace in a given project and location.
  • GETRetrieves a list of committed revisions of a specific conversion workspace./v1/:conversionWorkspace:describeConversionWorkspaceRevisions?commitId=stringRetrieves a list of committed revisions of a specific conversion workspace.
  • GETDescribes the database entities tree for a specific conversion workspace and a specific tree type/v1/:conversionWorkspace:describeDatabaseEntities?commitId=string&filter=string&pageSize=0&pageToken=string&tree=DB_TREE_TYPE_UNSPECIFIED&uncommitted=true&view=DATABASE_ENTITY_VIEW_UNSPECIFIEDDescribes the database entities tree for a specific conversion workspace and a specific tree type. Database entities are not resources like conversion…
  • GETAn internal, RPC only method that returns a list of the (filtered) entities with minimal information required for the…/v1/:conversionWorkspace:fetchEntitiesStatusView?fetchView=FETCH_VIEW_UNSPECIFIED&filter=string&pageSize=0&pageToken=string&tree=DB_TREE_TYPE_UNSPECIFIEDAn internal, RPC only method that returns a list of the (filtered) entities with minimal information required for the entities tree view.
  • GETList issues of conversion workspace operations e.g/v1/:conversionWorkspace:fetchIssues?allIssues=true&filter=string&pageSize=0&pageToken=string&tree=DB_TREE_TYPE_UNSPECIFIEDList issues of conversion workspace operations e.g. conversion.
  • POSTRolls back a conversion workspace to the last committed snapshot./v1/:name:rollbackRolls back a conversion workspace to the last committed snapshot.
  • GETSearches/lists the background jobs for a specific conversion workspace/v1/:conversionWorkspace:searchBackgroundJobs?completedUntilTime=string&maxSize=0&returnMostRecentPerJobType=trueSearches/lists the background jobs for a specific conversion workspace. The background jobs are not resources like conversion workspaces or mapping rules, and…
  • POSTImports a snapshot of the source database into the conversion workspace./v1/:name:seedImports a snapshot of the source database into the conversion workspace.
  • POSTUpdates the draft DDL of an entity./v1/:conversionWorkspace:setDraftEntityDdlUpdates the draft DDL of an entity.

projects.locations.conversionWorkspaces.mappingRules

  • GETLists the mapping rules for a specific conversion workspace./v1/:parent/mappingRules?pageSize=0&pageToken=stringLists the mapping rules for a specific conversion workspace.
  • POSTCreates a new mapping rule for a given conversion workspace./v1/:parent/mappingRules?mappingRuleId=string&requestId=stringCreates a new mapping rule for a given conversion workspace.
  • POSTImports the mapping rules for a given conversion workspace/v1/:parent/mappingRules:importImports the mapping rules for a given conversion workspace. Supports various formats of external rules files.

projects.locations.migrationJobs.objects

  • GETUse this method to list the objects of a specific migration job./v1/:parent/objects?pageSize=0&pageToken=stringUse this method to list the objects of a specific migration job.
  • POSTUse this method to look up a migration job object by its source object identifier./v1/:parent/objects:lookupUse this method to look up a migration job object by its source object identifier.

projects.locations.operations

  • POSTStarts asynchronous cancellation on a long-running operation/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the…
  • GETLists operations that match the specified filter in the request/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

API details

Base URL
https://datamigration.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
44 operations on 37 pathsPOST 25GET 17PATCH 1DELETE 1
Main resources
projects.locations.conversionWorkspaces 13projects.locations.migrationJobs 13projects.locations.privateConnections 7projects.locations.conversionWorkspaces.mappingRules 3projects.locations 2projects.locations.connectionProfiles 2projects.locations.migrationJobs.objects 2projects.locations.operations 2
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Database Migration API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Database Migration API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Fetches a set of static IP addresses that need to be allowlisted by the customer when using the static-IP connectivity…” (GET /v1/:name:fetchStaticIps?fetchReservedPublicIps=true&pageSize=0&pageToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Database Migration API?

Manage Cloud Database Migration Service resources on Google Cloud Platform. It is listed under Data & analytics and has 44 endpoints.

Who publishes the Database Migration API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Database Migration API?

Requests go to https://datamigration.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Database Migration API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.

How many endpoints does the Database Migration API have?

44 operations on 37 paths (25 POST, 17 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.conversionWorkspaces, projects.locations.migrationJobs, projects.locations.privateConnections, projects.locations.conversionWorkspaces.mappingRules.

Is forking the Database Migration API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.