Skip to content
SYLVE

Queue a Virtual Machine lifecycle action

POST
/vm/{rid}/actions/{action}
curl --request POST \
  --url https://sylve.lan:8181/api/vm/1/actions/start \
  --header 'Authorization: <Authorization>'

Queue a start, stop, shutdown, or reboot action for a virtual machine by its RID

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
rid
required
integer
>= 1

Virtual Machine RID

action
required
string
Allowed values: start stop shutdown reboot

Lifecycle action

Responses

Section titled “Responses”

202

Section titled “202”

Accepted

Media typeapplication/json
object
data
object
action
string
outcome
string
rid
integer
taskId
integer
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "action": "example",
    "outcome": "example",
    "rid": 1,
    "taskId": 1
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Section titled “409”

Conflict

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}