Preview — pending review
This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.
Get one run of a backup plan
Returns one run with its counts and, when it is a RETRY, the run it re-attempted. Validation: unknown plan or run → 404. RBAC: any scope role may read. Errors: 401; 403; 404; 500. Idempotency/Concurrency: Safe.
bearerTokenAuthorizationBearer <token>An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.
scopeId*stringOpaque ownership+authorization scope resolving to tenant + subscription + project.
planId*stringrunId*stringThe run.
application/json- response
One fan-out of a plan over its assigned volumes.
id*stringRun identifier.
planId*stringoperationId*stringThe tracking Operation this run reports through.
trigger*BackupRunTriggerWhat started a run — the schedule, a user pressing "Run now", or a retry of an earlier run's failures.
"SCHEDULED""MANUAL""RETRY"status*BackupRunStatusOutcome of one fan-out of a plan over its assigned volumes. PARTIAL is a first-class terminal state, not an error: some volumes were protected and some were not, and collapsing that onto SUCCEEDED or FAILED discards the only fact the user needs. SKIPPED means the plan had no eligible volume to protect at all.
"QUEUED""RUNNING""SUCCEEDED""PARTIAL""FAILED""SKIPPED""CANCELLED"scheduledFor?|The scheduled occurrence this run stands for; null for MANUAL and RETRY runs.
date-timetotalCount*integerVolumes the run fanned out over.
succeededCount*integerfailedCount*integerskippedCount*integerretryOfRunId?|The run whose failures this RETRY run is re-attempting; null otherwise.
retryableFailureCount?integerHow many of this run's failures are worth retrying — what "Retry failed" would actually pick up.
startedAt?|date-timefinishedAt?|date-timecreatedAt*stringdate-timecurl -X GET "https://example.com/scopes/string/storage/backup-plans/string/runs/string"{ "id": "string", "planId": "string", "operationId": "string", "trigger": "SCHEDULED", "status": "QUEUED", "scheduledFor": "2019-08-24T14:15:22Z", "totalCount": 0, "succeededCount": 0, "failedCount": 0, "skippedCount": 0, "retryOfRunId": "string", "retryableFailureCount": 0, "startedAt": "2019-08-24T14:15:22Z", "finishedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z"}