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.
Create a backup plan, optionally assigning volumes to it
Creates a reusable backup policy. volumeIds may assign volumes in the same call, and
that assignment is ALL-OR-NOTHING: if any listed volume already belongs to another plan
the whole create is refused with 409 VOLUME_ALREADY_ASSIGNED rather than leaving a plan
holding some of the volumes the caller asked for.
Validation: name non-empty; retentionDays 1–3650; weekday required when
scheduleKind is WEEKLY and dayOfMonth (1–28) when MONTHLY; time required unless
MANUAL and must be HH:mm UTC — any of these → 422 VALIDATION_ERROR. Every listed volume
must exist in the scope → 404 NOT_FOUND. RBAC: owner|admin|contributor.
Async & state: Returns 202 with an Operation. The plan is created ENABLED with its
first nextRunAt at the next configured occurrence; no backup is taken until that
occurrence or an explicit run.
Errors: 401; 403; 404 unknown scopeId or volume; 409 VOLUME_ALREADY_ASSIGNED with
the owning plan's id in details; 422 field validation; 429; 500.
Idempotency/Concurrency: Idempotency-Key is required; replaying a key returns the
original 202 without creating a second plan.
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.
Idempotency-Key*stringRequired: this operation creates a new resource asynchronously, so a retry without the key would create a second one. Same key+body within 24h replays the original result; the same key with a different body is 409 CONFLICT. Keys are unique per tenant (the same key in two tenants is two different requests). An API token or service-account (bearer) caller MUST send it -- a request without it is refused with 400 IDEMPOTENCY_KEY_REQUIRED (ErrIdempotencyKeyRequired); reuse the same key on every retry of one logical request. A console session gets one from the edge.
uuidapplication/json- body
Payload for creating a backup plan. Volumes may be assigned in the same call.
name*stringPlan name.
^[^\p{C}\p{Z}\x{10000}-\x{10FFFF}](?:[^\p{C}\p{Zl}\p{Zp}\x{10000}-\x{10FFFF}]*[^\p{C}\p{Z}\x{10000}-\x{10FFFF}])?$1 <= length <= 255description?stringFree-text description.
length <= 1024scheduleKind*BackupPlanScheduleKindHow often a backup plan fires. MANUAL plans never fire on their own and are run on demand.
"MANUAL""DAILY""WEEKLY""MONTHLY"weekday?VolumeBackupWeekday"mon""tue""wed""thu""fri""sat""sun"dayOfMonth?|Required when scheduleKind is MONTHLY; 1–28 so the plan runs every month.
1 <= value <= 28time?|Run time of day in UTC, HH:mm. Required unless scheduleKind is MANUAL.
retentionDays*integerRetention window in days.
1 <= value <= 3650incremental?booleanTake runs after a full base as incremental deltas.
truevolumeIds?array<string>Volumes to assign to the plan at creation. All-or-nothing — if any volume is already in another plan the whole create is refused.
Plan create accepted; track it through the returned operation.
application/json- response
A long-running operation record. GET /operations/{operationId} returns its current state.
id*stringOperation identifier, unique platform-wide.
action*stringCanonical action id that started this operation, e.g. compute.instance.create.
state*OperationStateState machine for long-running operations. PENDING and RUNNING are transitional; the rest are terminal.
"PENDING""RUNNING""SUCCEEDED""FAILED""CANCELLED"resourceKind?|Kind of the target resource (matches RealtimeEvent.kind), null for resource-less actions.
resourceId?|Identifier of the target resource; null until the resource is allocated.
resourceName?|Human-readable name of the target resource captured when the operation was opened; null when unknown or the resource has been deleted (clients fall back to resourceId).
principalId?|Subject id (user id/email or service-account id) of the actor that initiated this operation, captured at the create chokepoint; null on internal/worker paths with no request-scoped principal or for historical rows. This is the real actor the Activity feed renders.
sourceIp?|Source IP address of the request that initiated this operation; null when unavailable (internal/worker paths, historical rows).
progressPercent?|Best-effort progress; null when the action does not report progress.
0 <= value <= 100error?|nullPopulated only when state is FAILED (or CANCELLED with partial rollback notes).
warning?|nullNon-fatal degradation recorded on an operation that still SUCCEEDED - the primary action completed but something explicitly requested could not be delivered (e.g. publicIp was requested at instance create but no floating IP could be assigned). On a CANCELLED create it reports that the provider resource had already been created and was kept (live and billed until deleted; details.disposition = left_in_place). Same code+message shape as error so clients render both uniformly; null when the operation ran without degradation.
startedAt?|When the worker began executing; null while PENDING.
finishedAt?|When a terminal state was reached; null while transitional.
createdAt*stringupdatedAt*stringcurl -X POST "https://example.com/scopes/string/storage/backup-plans" \ -H "Idempotency-Key: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "scheduleKind": "MANUAL", "retentionDays": 1 }'{ "id": "string", "action": "string", "state": "PENDING", "resourceKind": "string", "resourceId": "string", "resourceName": "string", "principalId": "string", "sourceIp": "string", "progressPercent": 0, "error": { "code": "string", "message": "string", "field": "string", "details": {}, "retryable": false }, "warning": { "code": "string", "message": "string", "field": "string", "details": {}, "retryable": false }, "startedAt": "string", "finishedAt": "string", "createdAt": "string", "updatedAt": "string"}