Snapshots
Get Snapshot Job
Reads one snapshot or restore job of an application or database. Poll it until it ends. Requires the snapshots:read scope.
GET
Get Snapshot Job
Use this route to follow a restore (
This route allows 120 requests per minute.
response.job_id) or a manual snapshot
that answered 202 (response.job_id). Poll it every few seconds until status is ready, skipped or failed.
The shape of the job is the one described in List Snapshot Jobs.
The ID of the application or database the job belongs to. For a restore it is the resource being restored.
Response
The job:
id, kind, resource_id, origin (snapshot jobs only), status, reason (when failed or skipped), details (the details of that error, when it has any), snapshot_id (the snapshot a snapshot job produced, always set when it is ready; on a restore job, the snapshot being restored), created_at, started_at, finished_at and, while it is running, progress.Only while the job is
running, and it can be missing (for example right after it starts, or when the progress is not known). It is not sent in any other status.Error Responses
The error code indicating the reason for failure. Possible values:
AUTH_TOKEN_MISSING,API_KEY_INVALID,SESSION_REVOKED: TheAuthorizationheader is missing, the API key is invalid, or the dashboard session was revoked (401).API_KEY_IP_DENIED,API_KEY_SCOPE_DENIED: The API key is used from an IP outside its allowlist, or it lacks thesnapshots:readscope (403).ACCESS_DENIED: You are a workspace member without the permission for this action, or you did not send theworkspace_id(403).SNAPSHOT_NOT_FOUND: The job was not found (404).INTERNAL_SERVER_ERROR: An unexpected server error occurred.
Last modified on November 20, 2026