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.
List one run's per-volume results
Returns one row per volume the run fanned out over, with that volume's own outcome and, when it failed, the canonical error code and message. This is what makes a partial run legible: 5 rows, 3 SUCCEEDED, 1 FAILED with its reason, 1 SKIPPED with its reason. 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*stringpage?integer1-based page number.
1 <= value1pageSize?integerItems per page (max 200). Lists that used to return every row default to the maximum, so a client that does not page keeps seeing up to 200 rows; a larger value is refused with 422.
1 <= value <= 200200The run's per-volume results.
application/json- response
data*array<>curl -X GET "https://example.com/scopes/string/storage/backup-plans/string/runs/string/volume-results"{ "data": [ { "id": "string", "runId": "string", "volumeId": "string", "volumeName": "string", "status": "QUEUED", "attemptCount": 0, "backupKind": "Full", "sizeGb": 0, "restorePointId": "string", "errorCode": "string", "errorMessage": "string", "retryable": true, "finishedAt": "2019-08-24T14:15:22Z" } ]}