Skip to content

v2_services_instances_operations_create

POST
/api/v2/services/instances/{service_id}/operations/
curl --request POST \
--url https://example.com/api/v2/services/instances/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/operations/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "action": "example", "idempotency_key": "example", "ip_version": 1, "container_code": "example", "container_codes": [ "example" ], "container_id": "example", "container_ids": [ "example" ] }'

Run a lifecycle action on the VM (start, stop, reboot, delete, resize, snapshot, change_ip, rebuild, rescue) as a queued async operation.

service_id
required
string format: uuid
object
action
required
string
>= 1 characters
idempotency_key
required
string
>= 1 characters
ip_version
integer
container_code
string
>= 1 characters
container_codes
Array<string>
container_id
string
>= 1 characters
container_ids
Array<string>

Example generated

{
"action": "example",
"idempotency_key": "example",
"ip_version": 1,
"container_code": "example",
"container_codes": [
"example"
],
"container_id": "example",
"container_ids": [
"example"
]
}
Media typeapplication/json
object
success
boolean
idempotent
boolean
operation_id
required
string format: uuid
service_id
required
string format: uuid
status
required
string
action
required
string
task_id
string
nullable
status_reason
string
nullable
created_at
string format: date-time
nullable
started_at
string format: date-time
nullable
completed_at
string format: date-time
nullable
updated_at
string format: date-time
nullable

Example generated

{
"success": true,
"idempotent": true,
"operation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"service_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"status": "example",
"action": "example",
"task_id": "example",
"status_reason": "example",
"created_at": "2026-04-15T12:00:00Z",
"started_at": "2026-04-15T12:00:00Z",
"completed_at": "2026-04-15T12:00:00Z",
"updated_at": "2026-04-15T12:00:00Z"
}
Media typeapplication/json
object
success
boolean
error
string

Example

{
"success": false
}
Media typeapplication/json
object
success
boolean
error
string

Example

{
"success": false
}