Skip to content
OpenParablePublic APIs

VM Migration API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

Use the Migrate to Virtual Machines API to programmatically migrate workloads.

VM Migration API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 31 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://vmmigration.googleapis.com/
Version
v1alpha1
Endpoints
31
OpenAPI
Specification ↗
Spec updated
2023-04-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://vmmigration.googleapis.com/v1alpha1/NAME" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://vmmigration.googleapis.com/v1alpha1/NAME", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://vmmigration.googleapis.com/v1alpha1/NAME",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
POST/v1alpha1/{datacenterConnector}:upgradeApplianceUpgrades the appliance relate to this DatacenterConnector to the in-place updateable version.
POST/v1alpha1/{group}:addGroupMigrationAdds a MigratingVm to a Group.
POST/v1alpha1/{group}:removeGroupMigrationRemoves a MigratingVm from a Group.
POST/v1alpha1/{migratingVm}:finalizeMigrationMarks a migration as completed, deleting migration resources that are no longer being used. Only applicable after cutover is done.
POST/v1alpha1/{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 wh
POST/v1alpha1/{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 cut
POST/v1alpha1/{migratingVm}:startMigrationStarts migration for a VM. Starts the process of uploading data and creating snapshots, in replication cycles scheduled by the policy.
GET/v1alpha1/{name}Gets details of a single TargetProject. NOTE: TargetProject is a global resource; hence the only supported value for location is `global`.
PATCH/v1alpha1/{name}Updates the parameters of a single TargetProject. NOTE: TargetProject is a global resource; hence the only supported value for location is `global`.
DELETE/v1alpha1/{name}Deletes a single TargetProject. NOTE: TargetProject is a global resource; hence the only supported value for location is `global`.
GET/v1alpha1/{name}/locationsLists information about the supported locations for this service.
GET/v1alpha1/{name}/operationsLists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
POST/v1alpha1/{name}:cancelInitiates the cancellation of a running cutover job.
GET/v1alpha1/{parent}/cloneJobsLists CloneJobs of a given migrating VM.
POST/v1alpha1/{parent}/cloneJobsInitiates a Clone of a specific migrating VM.
GET/v1alpha1/{parent}/cutoverJobsLists CutoverJobs of a given migrating VM.
POST/v1alpha1/{parent}/cutoverJobsInitiates a Cutover of a specific migrating VM. The returned LRO is completed when the cutover job resource is created and the job is initiated.
GET/v1alpha1/{parent}/datacenterConnectorsLists DatacenterConnectors in a given Source.
POST/v1alpha1/{parent}/datacenterConnectorsCreates a new DatacenterConnector in a given Source.
GET/v1alpha1/{parent}/groupsLists Groups in a given project and location.
POST/v1alpha1/{parent}/groupsCreates a new Group in a given project and location.
GET/v1alpha1/{parent}/migratingVmsLists MigratingVms in a given Source.
POST/v1alpha1/{parent}/migratingVmsCreates a new MigratingVm in a given Source.
GET/v1alpha1/{parent}/replicationCyclesLists ReplicationCycles in a given MigratingVM.
GET/v1alpha1/{parent}/sourcesLists Sources in a given project and location.
POST/v1alpha1/{parent}/sourcesCreates a new Source in a given project and location.
GET/v1alpha1/{parent}/targetProjectsLists TargetProjects in a given project. NOTE: TargetProject is a global resource; hence the only supported value for location is `global`.
POST/v1alpha1/{parent}/targetProjectsCreates a new TargetProject in a given project. NOTE: TargetProject is a global resource; hence the only supported value for location is `global`.
GET/v1alpha1/{parent}/utilizationReportsLists Utilization Reports of the given Source.
POST/v1alpha1/{parent}/utilizationReportsCreates a new UtilizationReport.
GET/v1alpha1/{source}:fetchInventoryList 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 lis

Questions

Does the VM Migration API API need an API key?

Yes. The VM Migration API API uses OAuth authentication; the documentation explains how to get credentials.

Does the VM Migration API API support HTTPS?

Yes, the VM Migration API API is served over HTTPS.

How many endpoints does the VM Migration API API have?

Its OpenAPI description lists 31 endpoints in version v1alpha1. All of them are shown on this page.

What are alternatives to the VM Migration API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).