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 the volumes assigned to a backup plan
Returns each assigned volume with its current status, how well it is ACTUALLY protected
(protectionHealth), when it was last successfully backed up, and how many live
recovery points the plan holds for it. The distinction matters: a volume can be assigned
to a healthy plan and still be unprotected because every run has skipped it.
Validation: unknown plan → 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*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 plan's current volume assignments.
application/json- response
data*array<>curl -X GET "https://example.com/scopes/string/storage/backup-plans/string/assignments"{ "data": [ { "volumeId": "string", "volumeName": "string", "volumeStatus": "string", "assignedAt": "2019-08-24T14:15:22Z", "protectionHealth": "PROTECTED", "lastSuccessfulBackupAt": "2019-08-24T14:15:22Z", "restorePointCount": 0 } ]}