Compute

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 the instance to a different flavor

POST
/scopes/{scopeId}/compute/instances/{instanceId}/actions/resize

Changes the instance's compute capacity to a different flavor (the Size tab's "Resize" button in the instance detail page, which offers a picker of family/vCPU/RAM/price options and requires the target to differ from the current flavor). The platform migrates the VM to the new size; vCPU, RAM and pricing change while disks, IPs and configuration are preserved. Once complete, reads return the updated embedded Flavor. Validation: instance must exist and be visible → 404 NOT_FOUND; flavorId must reference an existing flavor and must differ from the current one → 404 NOT_FOUND / 422 VALIDATION_FAILED; current status must permit resize (ACTIVE or STOPPED, not BUILD/DELETING/already-RESIZE) and the target flavor must have capacity in the instance's region — capacity shortfall → 409 CAPACITY_UNAVAILABLE (state conflicts surface on the same 409 status as CONFLICT). Async & state: Asynchronous (202) returning an Operation. State path: ACTIVE|STOPPED → RESIZE → VERIFY_RESIZE → terminal ACTIVE (confirmed) or ERROR (failed/reverted). The detail view polls every 2.5s while status=RESIZE, and resource.updated SSE frames with kind=instance carry the status/flavor patches. Errors: 401 UNAUTHENTICATED; 403 FORBIDDEN; 404 NOT_FOUND for unknown instance or flavor; 409 CAPACITY_UNAVAILABLE when the target flavor lacks capacity (or the state forbids resize); 422 VALIDATION_FAILED for a missing/identical flavorId; 500 INTERNAL. Idempotency/Concurrency: Idempotency-Key is optional (recommended); replay returns the original Operation rather than queueing a second migration. A resize while one is in flight returns 409. No If-Match on the action route; concurrency is guarded by the state machine.

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.

instanceId*string

Identifier of the compute instance.

Header Parameters

Idempotency-Key?string

Optional; 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.

Formatuuid

Request Body

application/json
  1. body

Target size for the resize action chosen in the Size tab picker.

flavorId*string

Id of the target flavor; must differ from the instance's current flavor.

Response Body

Resize accepted; returns the tracking Operation while the instance is in RESIZE state.

application/json
  1. response

A long-running operation record. GET /operations/{operationId} returns its current state.

id*string

Operation identifier, unique platform-wide.

action*string

Canonical action id that started this operation, e.g. compute.instance.create.

state*OperationState

State machine for long-running operations. PENDING and RUNNING are transitional; the rest are terminal.

Value in"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.

Range0 <= value <= 100
error?|null

Populated only when state is FAILED (or CANCELLED with partial rollback notes).

warning?|null

Non-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*string
updatedAt*string
curl -X POST "https://example.com/scopes/string/compute/instances/string/actions/resize" \  -H "Content-Type: application/json" \  -d '{    "flavorId": "string"  }'
{  "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"}