Data Portability API
Stay organized with collections
Save and categorize content based on your preferences.
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.
Service: dataportability.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.
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:
https://dataportability.googleapis.com
| Methods |
check |
POST /v1/accessType:check
Gets the access type of the token. |
| Methods |
cancel |
POST /v1/{name=archiveJobs/*}:cancel
Cancels a Portability Archive job. |
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. |
| Methods |
reset |
POST /v1/authorization:reset
Revokes OAuth tokens and resets exhausted scopes for a user/project pair. |
| Methods |
initiate |
POST /v1/portabilityArchive:initiate
Initiates a new Archive job for the Portability API. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-05 UTC.
[null,null,["Last updated 2025-03-05 UTC."],[[["\u003cp\u003eThe Data Portability API enables building applications that can request user authorization to move data from Google services.\u003c/p\u003e\n"],["\u003cp\u003eThis API facilitates data portability and allows users to switch between services more easily.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can utilize REST resources such as \u003ccode\u003earchiveJobs\u003c/code\u003e, \u003ccode\u003eauthorization\u003c/code\u003e, and \u003ccode\u003eportabilityArchive\u003c/code\u003e to manage data transfer processes.\u003c/p\u003e\n"],["\u003cp\u003eClient libraries and a discovery document are available to simplify interactions with the API.\u003c/p\u003e\n"],["\u003cp\u003eThe service endpoint for the Data Portability API is \u003ccode\u003ehttps://dataportability.googleapis.com\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Data Portability API\n\nThe 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.\n\n- [REST Resource: v1.accessType](#v1.accessType)\n- [REST Resource: v1.archiveJobs](#v1.archiveJobs)\n- [REST Resource: v1.authorization](#v1.authorization)\n- [REST Resource: v1.portabilityArchive](#v1.portabilityArchive)\n\nService: dataportability.googleapis.com\n---------------------------------------\n\nTo call this service, we recommend that you use the Google-provided [client libraries](https://cloud.google.com/apis/docs/client-libraries-explained). If your application needs to use your own libraries to call this service, use the following information when you make the API requests.\n\n### Discovery document\n\nA [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) 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:\n\n- \u003chttps://dataportability.googleapis.com/$discovery/rest?version=v1\u003e\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_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:\n\n- `https://dataportability.googleapis.com`\n\nREST Resource: [v1.accessType](/data-portability/reference/rest/v1/accessType)\n------------------------------------------------------------------------------\n\n| Methods ||\n|---------------------------------------------------------------|----------------------------------------------------------------|\n| [check](/data-portability/reference/rest/v1/accessType/check) | `POST /v1/accessType:check` Gets the access type of the token. |\n\nREST Resource: [v1.archiveJobs](/data-portability/reference/rest/v1/archiveJobs)\n--------------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|\n| [cancel](/data-portability/reference/rest/v1/archiveJobs/cancel) | `POST /v1/{name=archiveJobs/*}:cancel` Cancels a Portability Archive job. |\n| [getPortabilityArchiveState](/data-portability/reference/rest/v1/archiveJobs/getPortabilityArchiveState) | `GET /v1/{name=archiveJobs/*/portabilityArchiveState}` Retrieves the state of an Archive job for the Portability API. |\n| [retry](/data-portability/reference/rest/v1/archiveJobs/retry) | `POST /v1/{name=archiveJobs/*}:retry` Retries a failed Portability Archive job. |\n\nREST Resource: [v1.authorization](/data-portability/reference/rest/v1/authorization)\n------------------------------------------------------------------------------------\n\n| Methods ||\n|------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|\n| [reset](/data-portability/reference/rest/v1/authorization/reset) | `POST /v1/authorization:reset` Revokes OAuth tokens and resets exhausted scopes for a user/project pair. |\n\nREST Resource: [v1.portabilityArchive](/data-portability/reference/rest/v1/portabilityArchive)\n----------------------------------------------------------------------------------------------\n\n| Methods ||\n|-----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|\n| [initiate](/data-portability/reference/rest/v1/portabilityArchive/initiate) | `POST /v1/portabilityArchive:initiate` Initiates a new Archive job for the Portability API. |"]]