VM Migration API
Use the Migrate to Virtual Machines API to programmatically migrate workloads.
Developer tools#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
Use the Migrate to Virtual Machines API to programmatically migrate workloads.
Endpoints 39
projects.locations.targetProjects
- GETGets details of a single TargetProject
/v1/:nameGets details of a single TargetProject. NOTE: TargetProject is a global resource; hence the only supported value for location is global. - DELETEDeletes a single TargetProject
/v1/:name?requestId=stringDeletes a single TargetProject. NOTE: TargetProject is a global resource; hence the only supported value for location is global. - PATCHUpdates the parameters of a single TargetProject
/v1/:name?requestId=string&updateMask=stringUpdates the parameters of a single TargetProject. NOTE: TargetProject is a global resource; hence the only supported value for location is global. - GETLists TargetProjects in a given project
/v1/:parent/targetProjects?filter=string&orderBy=string&pageSize=0&pageToken=stringLists TargetProjects in a given project. NOTE: TargetProject is a global resource; hence the only supported value for location is global. - POSTCreates a new TargetProject in a given project
/v1/:parent/targetProjects?requestId=string&targetProjectId=stringCreates a new TargetProject in a given project. NOTE: TargetProject is a global resource; hence the only supported value for location is global.
projects.locations
- 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.groups
- POSTAdds a MigratingVm to a Group.
/v1/:group:addGroupMigrationAdds a MigratingVm to a Group. - GETLists Groups in a given project and location.
/v1/:parent/groups?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Groups in a given project and location. - POSTCreates a new Group in a given project and location.
/v1/:parent/groups?groupId=string&requestId=stringCreates a new Group in a given project and location. - POSTRemoves a MigratingVm from a Group.
/v1/:group:removeGroupMigrationRemoves a MigratingVm from a Group.
projects.locations.imageImports
- GETLists ImageImports in a given project.
/v1/:parent/imageImports?filter=string&orderBy=string&pageSize=0&pageToken=stringLists ImageImports in a given project. - POSTCreates a new ImageImport in a given project.
/v1/:parent/imageImports?imageImportId=string&requestId=stringCreates a new ImageImport in a given project.
projects.locations.sources.migratingVms.cutoverJobs
- POSTInitiates the cancellation of a running cutover job.
/v1/:name:cancelInitiates the cancellation of a running cutover job. - GETLists the CutoverJobs of a migrating VM
/v1/:parent/cutoverJobs?filter=string&orderBy=string&pageSize=0&pageToken=stringLists the CutoverJobs of a migrating VM. Only 25 most recent CutoverJobs are listed. - POSTInitiates a Cutover of a specific migrating VM
/v1/:parent/cutoverJobs?cutoverJobId=string&requestId=stringInitiates a Cutover of a specific migrating VM. The returned LRO is completed when the cutover job resource is created and the job is initiated.
projects.locations.imageImports.imageImportJobs
- GETLists ImageImportJobs in a given project.
/v1/:parent/imageImportJobs?filter=string&orderBy=string&pageSize=0&pageToken=stringLists ImageImportJobs in a given project.
projects.locations.operations
- 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.
projects.locations.sources
- GETLists Sources in a given project and location.
/v1/:parent/sources?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Sources in a given project and location. - POSTCreates a new Source in a given project and location.
/v1/:parent/sources?requestId=string&sourceId=stringCreates a new Source in a given project and location. - GETList remote source's inventory of VMs
/v1/:source:fetchInventory?forceRefresh=true&pageSize=0&pageToken=stringList remote source's inventory of VMs. The remote source is the onprem vCenter (remote in the sense it's not in Compute Engine). The inventory describes the… - GETList remote source's inventory of storage resources
/v1/:source:fetchStorageInventory?forceRefresh=true&pageSize=0&pageToken=string&type=STORAGE_TYPE_UNSPECIFIEDList remote source's inventory of storage resources. The remote source is another cloud vendor (e.g. AWS, Azure). The inventory describes the list of existing…
projects.locations.sources.datacenterConnectors
- GETLists DatacenterConnectors in a given Source.
/v1/:parent/datacenterConnectors?filter=string&orderBy=string&pageSize=0&pageToken=stringLists DatacenterConnectors in a given Source. - POSTCreates a new DatacenterConnector in a given Source.
/v1/:parent/datacenterConnectors?datacenterConnectorId=string&requestId=stringCreates a new DatacenterConnector in a given Source. - POSTUpgrades the appliance relate to this DatacenterConnector to the in-place updateable version.
/v1/:datacenterConnector:upgradeApplianceUpgrades the appliance relate to this DatacenterConnector to the in-place updateable version.
projects.locations.sources.diskMigrationJobs
- GETLists DiskMigrationJobs in a given Source.
/v1/:parent/diskMigrationJobs?filter=string&orderBy=string&pageSize=0&pageToken=stringLists DiskMigrationJobs in a given Source. - POSTCreates a new disk migration job in a given Source.
/v1/:parent/diskMigrationJobs?diskMigrationJobId=string&requestId=stringCreates a new disk migration job in a given Source. - POSTRuns the disk migration job.
/v1/:name:runRuns the disk migration job.
projects.locations.sources.migratingVms
- GETLists MigratingVms in a given Source.
/v1/:parent/migratingVms?filter=string&orderBy=string&pageSize=0&pageToken=string&view=MIGRATING_VM_VIEW_UNSPECIFIEDLists MigratingVms in a given Source. - POSTCreates a new MigratingVm in a given Source.
/v1/:parent/migratingVms?migratingVmId=string&requestId=stringCreates a new MigratingVm in a given Source. - POSTExtend the migrating VM time to live.
/v1/:migratingVm:extendMigrationExtend the migrating VM time to live. - POSTMarks a migration as completed, deleting migration resources that are no longer being used
/v1/:migratingVm:finalizeMigrationMarks a migration as completed, deleting migration resources that are no longer being used. Only applicable after cutover is done. - POSTPauses a migration for a VM
/v1/:migratingVm:pauseMigrationPauses a migration for a VM. If cycle tasks are running they will be cancelled, preserving source task data. Further replication cycles will not be triggered… - POSTResumes a migration for a VM
/v1/:migratingVm:resumeMigrationResumes a migration for a VM. When called on a paused migration, will start the process of uploading data and creating snapshots; when called on a completed… - POSTStarts migration for a VM
/v1/:migratingVm:startMigrationStarts migration for a VM. Starts the process of uploading data and creating snapshots, in replication cycles scheduled by the policy.
projects.locations.sources.migratingVms.cloneJobs
- GETLists the CloneJobs of a migrating VM
/v1/:parent/cloneJobs?filter=string&orderBy=string&pageSize=0&pageToken=stringLists the CloneJobs of a migrating VM. Only 25 most recent CloneJobs are listed. - POSTInitiates a Clone of a specific migrating VM.
/v1/:parent/cloneJobs?cloneJobId=string&requestId=stringInitiates a Clone of a specific migrating VM.
projects.locations.sources.migratingVms.replicationCycles
- GETLists ReplicationCycles in a given MigratingVM.
/v1/:parent/replicationCycles?filter=string&orderBy=string&pageSize=0&pageToken=stringLists ReplicationCycles in a given MigratingVM.
projects.locations.sources.utilizationReports
- GETLists Utilization Reports of the given Source.
/v1/:parent/utilizationReports?filter=string&orderBy=string&pageSize=0&pageToken=string&view=UTILIZATION_REPORT_VIEW_UNSPECIFIEDLists Utilization Reports of the given Source. - POSTCreates a new UtilizationReport.
/v1/:parent/utilizationReports?requestId=string&utilizationReportId=stringCreates a new UtilizationReport.
API details
- Base URL
https://vmmigration.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 39 operations on 27 pathsPOST 20GET 17PATCH 1DELETE 1
- Main resources
- projects.locations.sources.migratingVms 7projects.locations.targetProjects 5projects.locations.groups 4projects.locations.sources 4projects.locations.sources.datacenterConnectors 3projects.locations.sources.diskMigrationJobs 3projects.locations.sources.migratingVms.cutoverJobs 3projects.locations.imageImports 2projects.locations.sources.migratingVms.cloneJobs 2projects.locations.sources.utilizationReports 2
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the VM Migration API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the VM Migration API collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Gets details of a single TargetProject” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the VM Migration API?
Use the Migrate to Virtual Machines API to programmatically migrate workloads. It is listed under Developer tools and has 39 endpoints.
Who publishes the VM 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 VM Migration API?
Requests go to https://vmmigration.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the VM 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 VM Migration API have?
39 operations on 27 paths (20 POST, 17 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.sources.migratingVms, projects.locations.targetProjects, projects.locations.groups, projects.locations.sources.
Is forking the VM Migration API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.