Data Portability API

The Data Portability API lets you build applications that request authorization from a user to move a copy of data from Google services into your application. This enables data portability and facilitates switching services.


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.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

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:


REST Resource: v1.archiveJobs

getPortabilityArchiveState GET /v1/{name=archiveJobs/*/portabilityArchiveState}
Retrieves the state of an Archive job for the Portability API.
retry POST /v1/{name=archiveJobs/*}:retry
Retries a failed Portability Archive job.

REST Resource: v1.authorization

reset POST /v1/authorization:reset
Revokes OAuth tokens and resets exhausted scopes for a user/project pair.

REST Resource: v1.portabilityArchive

initiate POST /v1/portabilityArchive:initiate
Initiates a new Archive job for the Portability API.