Skip to main content
PATCH
Update instance

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Path Parameters

project_id
integer
required

Project ID.

Example:

1

instance_id
string<uuid4>
required

Instance ID.

Example:

"6c6aa80f-4234-4678-9abc-def012345678"

Query Parameters

dry_run
boolean
default:false

Run every check of the real request and change nothing. The response has the status code and the schema of the real call, and an empty list of tasks. With false, the default, the request does the operation.

Body

application/json

Changes to the instance, as JSON Merge Patch (RFC 7396). Omit a field to keep its value.

data_volume_ids
string<uuid4>[]

Full list of the data volumes of the instance. Volumes that are not in the list are detached. New volumes are attached.

flavor_name
string

Name of the new flavor. The instance is resized to this flavor.

interfaces
VirtualInstanceInterfaceCreateSerializer · object[]

Full list of the ports of the instance. Ports that are not in the list are detached. New ports are attached. Keep the current ports in their current order.

name
string

Instance name.

Pattern: ^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$
placement_group_id
string<uuid4> | null

ID of the placement group. Send null to remove the instance from its placement group.

tags
UpdateTagsSerializer · object | null

Tags as JSON Merge Patch. A key with the value null removes that tag. The value null removes all tags.

Response

Task IDs

tasks
string[]
required

List of task IDs representing asynchronous operations. Use these IDs to monitor operation progress:

  • GET /v1/tasks/{task_id} - Check individual task status and details Poll task status until completion (FINISHED/ERROR) before proceeding with dependent operations.
Example: