2024-03-09
▼ ▲ dataportability.portabilityArchive.initiate
HTTP Method: POST
Scopes:
Description: Initiates a new Archive job for the Portability API.
Path: v1/portabilityArchive:initiate
Flat Path: v1/portabilityArchive:initiate
▼ ▲ dataportability.authorization.reset
Scopes:
Description: Revokes OAuth tokens and resets exhausted scopes for a user/project pair. This method allows you to initiate a request after a new consent is granted. This method also indicates that previous archives can be garbage collected. You should call this method when all jobs are complete and all archives are downloaded. Do not call it only when you start a new job.
Path: v1/authorization:reset
Flat Path: v1/authorization:reset
HTTP Method: POST
▼ ▲ dataportability.archiveJobs.getPortabilityArchiveState
Path: v1/{+name}
Flat Path: v1/archiveJobs/{archiveJobsId}/portabilityArchiveState
Scopes:
Parameter Order: name
HTTP Method: GET
Parameters:
name
Required: Yes
Location: path
Description: Required. The archive job ID that is returned when you request the state of the job. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID returned by the InitiatePortabilityArchiveResponse.
Pattern: ^archiveJobs/[^/]+/portabilityArchiveState$
Type: string
Description: Retrieves the state of an Archive job for the Portability API.
▼ ▲ dataportability.archiveJobs.retry
Parameters:
name
Description: Required. The Archive job ID you're retrying. This is returned by the InitiatePortabilityArchiveResponse. Retrying is only executed if the initial job failed.
Required: Yes
Location: path
Type: string
Pattern: ^archiveJobs/[^/]+$
Path: v1/{+name}:retry
Flat Path: v1/archiveJobs/{archiveJobsId}:retry
HTTP Method: POST
Parameter Order: name
Scopes:
Description: Retries a failed Portability Archive job.