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.
Resize a volume
Changes the provisioned capacity of the block volume volumeId — triggered by the "Resize"
action in the volume detail header. Block volumes grow online without detaching; the new
size takes effect for billing immediately on completion and the guest filesystem must be
extended separately by the operator.
Validation: volumeId must reference an existing volume in the scope (unknown → 404
NOT_FOUND); the current state must permit resize — CREATING or ERROR volumes cannot be
resized (→ 409 CONFLICT); sizeGb must be an integer in [1, 16384] and strictly greater
than the current size (shrinking is not supported → 422 VALIDATION_FAILED); the
subscription's block-storage quota must cover the delta (→ 409 QUOTA_EXCEEDED); caller needs
owner|admin|contributor (→ 403 FORBIDDEN).
Async & state: Asynchronous — returns 202 with an Operation. The volume keeps serving
I/O during the resize; sizeGb updates on completion and is emitted as a
resource.updated SSE frame (kind storage.volume, patch
{sizeGb, updatedAt}) followed by a terminal operation.completed
frame. Failure leaves the volume at its original size in a queryable state.
Errors: 401 unauthenticated; 403 caller lacks permission on the scope; 404 unknown
scopeId/volumeId; 409 CONFLICT state does not permit resize or another resize is in
flight; 409 QUOTA_EXCEEDED quota cannot cover the new size; 412 If-Match mismatch;
422 non-integer, out-of-range or non-growing sizeGb; 500 unexpected backend failure.
Idempotency/Concurrency: Idempotency-Key is optional (recommended); replaying the same
key returns
the original 202 Operation. If-Match with the volume ETag prevents racing a concurrent
mutation of the same volume.
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.
volumeId*stringIdentifier of the block volume.
Idempotency-Key?stringOptional; recommended for safe retries. When sent, the same key+body within 24h replays the original result and the same key with a different body is 409 CONFLICT; keys are unique per tenant. When an API token or service-account (bearer) caller omits it, the request is applied once with no replay protection (a retry may apply it again). A console session gets one from the edge.
uuidIf-Match?stringETag for optimistic concurrency on mutations/deletes; mismatch results in 412.
application/json- body
Payload for resizing a volume (grow-only).
sizeGb*integerNew provisioned size in GB; must be strictly greater than the current size.
1 <= value <= 16384Resize accepted; returns the tracking 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/volumes/string/actions/resize" \ -H "Content-Type: application/json" \ -d '{ "sizeGb": 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"}