Storage

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 volume's recovery points under a backup plan

GET
/scopes/{scopeId}/storage/backup-plans/{planId}/volumes/{volumeId}/restore-points

Returns the live recovery points this plan holds for one volume, newest first. Points survive the volume being unassigned and the plan being deleted, so this stays the way to find them until they age out. Validation: unknown plan → 404. A volume with no points returns an empty list, not a 404. RBAC: any scope role may read. Errors: 401; 403; 404; 500. Idempotency/Concurrency: Safe.

Authorization

bearerToken
headerAuthorizationBearer <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.

Path Parameters

scopeId*string

Opaque ownership+authorization scope resolving to tenant + subscription + project.

planId*string
volumeId*string

Query Parameters

page?integer

1-based page number.

Range1 <= value
Default1
pageSize?integer

Items 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.

Range1 <= value <= 200
Default200

Response Body

The volume's recovery points under this plan, newest first.

application/json
  1. response
data*array<>
curl -X GET "https://example.com/scopes/string/storage/backup-plans/string/volumes/string/restore-points"
{  "data": [    {      "id": "string",      "volumeId": "string",      "volumeName": "string",      "kind": "Full",      "status": "AVAILABLE",      "sizeGb": 0,      "crashConsistent": true,      "parentRestorePointId": "string",      "protectedAt": "2019-08-24T14:15:22Z",      "expiresAt": "2019-08-24T14:15:22Z"    }  ]}