Version 5.0

Migrate for Compute Engine API

Use the Migrate for Compute Engine API to programmatically migrate workloads.

Service: vmmigration.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://vmmigration.googleapis.com

REST Resource: v1alpha1.projects.locations

Methods
get GET /v1alpha1/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1alpha1/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1alpha1.projects.locations.groups

Methods
addGroupMigration POST /v1alpha1/{group=projects/*/locations/*/groups/*}:addGroupMigration
Adds a MigratingVm to a Group.
create POST /v1alpha1/{parent=projects/*/locations/*}/groups
Creates a new Group in a given project and location.
delete DELETE /v1alpha1/{name=projects/*/locations/*/groups/*}
Deletes a single Group.
get GET /v1alpha1/{name=projects/*/locations/*/groups/*}
Gets details of a single Group.
list GET /v1alpha1/{parent=projects/*/locations/*}/groups
Lists Groups in a given project and location.
patch PATCH /v1alpha1/{group.name=projects/*/locations/*/groups/*}
Updates the parameters of a single Group.
removeGroupMigration POST /v1alpha1/{group=projects/*/locations/*/groups/*}:removeGroupMigration
Removes a MigratingVm from a Group.

REST Resource: v1alpha1.projects.locations.operations

Methods
cancel POST /v1alpha1/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1alpha1/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1alpha1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1alpha1/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1alpha1.projects.locations.sources

Methods
create POST /v1alpha1/{parent=projects/*/locations/*}/sources
Creates a new Source in a given project and location.
delete DELETE /v1alpha1/{name=projects/*/locations/*/sources/*}
Deletes a single Source.
fetchInventory GET /v1alpha1/{source=projects/*/locations/*/sources/*}:fetchInventory
List remote source's inventory of VMs.
get GET /v1alpha1/{name=projects/*/locations/*/sources/*}
Gets details of a single Source.
list GET /v1alpha1/{parent=projects/*/locations/*}/sources
Lists Sources in a given project and location.
patch PATCH /v1alpha1/{source.name=projects/*/locations/*/sources/*}
Updates the parameters of a single Source.

REST Resource: v1alpha1.projects.locations.sources.datacenterConnectors

Methods
create POST /v1alpha1/{parent=projects/*/locations/*/sources/*}/datacenterConnectors
Creates a new DatacenterConnector in a given Source.
delete DELETE /v1alpha1/{name=projects/*/locations/*/sources/*/datacenterConnectors/*}
Deletes a single DatacenterConnector.
get GET /v1alpha1/{name=projects/*/locations/*/sources/*/datacenterConnectors/*}
Gets details of a single DatacenterConnector.
list GET /v1alpha1/{parent=projects/*/locations/*/sources/*}/datacenterConnectors
Lists DatacenterConnectors in a given Source.

REST Resource: v1alpha1.projects.locations.sources.migratingVms

Methods
create POST /v1alpha1/{parent=projects/*/locations/*/sources/*}/migratingVms
Creates a new MigratingVm in a given Source.
delete DELETE /v1alpha1/{name=projects/*/locations/*/sources/*/migratingVms/*}
Deletes a single MigratingVm.
finalizeMigration POST /v1alpha1/{migratingVm=projects/*/locations/*/sources/*/migratingVms/*}:finalizeMigration
Marks a migration as completed, deleting migration resources that are no longer being used.
get GET /v1alpha1/{name=projects/*/locations/*/sources/*/migratingVms/*}
Gets details of a single MigratingVm.
list GET /v1alpha1/{parent=projects/*/locations/*/sources/*}/migratingVms
Lists MigratingVms in a given Source.
patch PATCH /v1alpha1/{migratingVm.name=projects/*/locations/*/sources/*/migratingVms/*}
Updates the parameters of a single MigratingVm.
pauseMigration POST /v1alpha1/{migratingVm=projects/*/locations/*/sources/*/migratingVms/*}:pauseMigration
Pauses a migration for a VM.
resumeMigration POST /v1alpha1/{migratingVm=projects/*/locations/*/sources/*/migratingVms/*}:resumeMigration
Resumes a migration for a VM.
startMigration POST /v1alpha1/{migratingVm=projects/*/locations/*/sources/*/migratingVms/*}:startMigration
Starts migration for a VM.

REST Resource: v1alpha1.projects.locations.sources.migratingVms.cloneJobs

Methods
cancel POST /v1alpha1/{name=projects/*/locations/*/sources/*/migratingVms/*/cloneJobs/*}:cancel
Initiates the cancellation of a running clone job.
create POST /v1alpha1/{parent=projects/*/locations/*/sources/*/migratingVms/*}/cloneJobs
Initiates a Clone of a specific migrating VM.
get GET /v1alpha1/{name=projects/*/locations/*/sources/*/migratingVms/*/cloneJobs/*}
Gets details of a single CloneJob.
list GET /v1alpha1/{parent=projects/*/locations/*/sources/*/migratingVms/*}/cloneJobs
Lists CloneJobs of a given migrating VM.

REST Resource: v1alpha1.projects.locations.sources.migratingVms.cutoverJobs

Methods
cancel POST /v1alpha1/{name=projects/*/locations/*/sources/*/migratingVms/*/cutoverJobs/*}:cancel
Initiates the cancellation of a running cutover job.
create POST /v1alpha1/{parent=projects/*/locations/*/sources/*/migratingVms/*}/cutoverJobs
Initiates a Cutover of a specific migrating VM.
get GET /v1alpha1/{name=projects/*/locations/*/sources/*/migratingVms/*/cutoverJobs/*}
Gets details of a single CutoverJob.
list GET /v1alpha1/{parent=projects/*/locations/*/sources/*/migratingVms/*}/cutoverJobs
Lists CutoverJobs of a given migrating VM.

REST Resource: v1alpha1.projects.locations.sources.utilizationReports

Methods
create POST /v1alpha1/{parent=projects/*/locations/*/sources/*}/utilizationReports
Creates a new UtilizationReport.
delete DELETE /v1alpha1/{name=projects/*/locations/*/sources/*/utilizationReports/*}
Deletes a single Utilization Report.
get GET /v1alpha1/{name=projects/*/locations/*/sources/*/utilizationReports/*}
Gets a single Utilization Report.
list GET /v1alpha1/{parent=projects/*/locations/*/sources/*}/utilizationReports
Lists Utilization Reports of the given Source.

REST Resource: v1alpha1.projects.locations.targetProjects

Methods
create POST /v1alpha1/{parent=projects/*/locations/*}/targetProjects
Creates a new TargetProject in a given project.
delete DELETE /v1alpha1/{name=projects/*/locations/*/targetProjects/*}
Deletes a single TargetProject.
get GET /v1alpha1/{name=projects/*/locations/*/targetProjects/*}
Gets details of a single TargetProject.
list GET /v1alpha1/{parent=projects/*/locations/*}/targetProjects
Lists TargetProjects in a given project.
patch PATCH /v1alpha1/{targetProject.name=projects/*/locations/*/targetProjects/*}
Updates the parameters of a single TargetProject.

REST Resource: v1alpha1.projects.locations.targets

Methods
create POST /v1alpha1/{parent=projects/*/locations/*}/targets
Creates a new Target in a given project.
delete DELETE /v1alpha1/{name=projects/*/locations/*/targets/*}
Deletes a single Target.
get GET /v1alpha1/{name=projects/*/locations/*/targets/*}
Gets details of a single Target.
list GET /v1alpha1/{parent=projects/*/locations/*}/targets
Lists Targets in a given project.
patch PATCH /v1alpha1/{target.name=projects/*/locations/*/targets/*}
Updates the parameters of a single Target.