Skip to main content
PATCH
Update basic VM

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

basic_vm_id
string<uuid4>
required

Basic VM 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 basic VM, as JSON Merge Patch (RFC 7396). Omit a field to keep its value.

interfaces
BasicVmInterfaceInSerializer · object[]

Full list of the ports of the basic VM. The API detaches the ports that are not in the list, and attaches the new ports. Send an empty list to detach all ports.

name
string

Basic VM name. 2-62 characters: letters, digits, spaces, dots, underscores, hyphens.

Pattern: ^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$
Example:

"web-server-01"

tags
UpdateTagsSerializer · object | null

Update key-value tags using JSON Merge Patch semantics (RFC 7396). Provide key-value pairs to add or update tags. Set tag values to null to remove tags. Unspecified tags remain unchanged. Read-only tags are always preserved and cannot be modified.

Examples:

  • Add/update tags: {'tags': {'environment': 'production', 'team': 'backend'}} adds new tags or updates existing ones.
  • Delete tags: {'tags': {'old_tag': null}} removes specific tags.
  • Remove all tags: {'tags': null} removes all user-managed tags (read-only tags are preserved).
  • Partial update: {'tags': {'environment': 'staging'}} only updates specified tags.
  • Mixed operations: {'tags': {'environment': 'production', 'cost_center': 'engineering', 'deprecated_tag': null}} adds/updates 'environment' and 'cost_center' while removing 'deprecated_tag', preserving other existing tags.
  • Replace all: first delete existing tags with null values, then add new ones in the same request.
Example:

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: