AI-generated Key Takeaways
-
The Data Portability API allows applications to request user authorization to transfer a copy of their data from Google services into the application, facilitating data portability and service switching.
-
The service endpoint for the Data Portability API is
https://dataportability.googleapis.com
. -
The API includes REST resources for managing access type, archive jobs, authorization, and initiating portability archives.
-
Specific methods are available for checking access type, canceling/retrying/getting the state of archive jobs, resetting authorization, and initiating new archive jobs.
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.
- REST Resource: v1.accessType
- REST Resource: v1.archiveJobs
- REST Resource: v1.authorization
- REST Resource: v1.portabilityArchive
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
REST Resource: v1.accessType
Methods | |
---|---|
check |
POST /v1/accessType:check Gets the access type of the token. |
REST Resource: v1.archiveJobs
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. |
REST Resource: v1.portabilityArchive
Methods | |
---|---|
initiate |
POST /v1/portabilityArchive:initiate Initiates a new Archive job for the Portability API. |