Skip to main content
POST
Execute basic VM action

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
action
enum<string>
required

Power action to run on the basic VM. A basic VM does not support suspend or resume.

Available options:
reboot,
reboot_hard,
start,
stop
Example:

"stop"

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: