Skip to main content
POST
/
vm
/
{vm_id}
/
{action}
Perform an action on the VM
curl --request POST \
  --url https://api.cloud.onidel.com/vm/{vm_id}/{action} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "team_id": "96616865-475e-4191-aba5-f89f0a4b71fe",
  "name": "vm-snapshot-name",
  "desc": "snapshot @ 20/09/2025"
}
'

Authorizations

​
Authorization
string
header
required

Provide the value as: Token <your-api-token>

Path Parameters

​
vm_id
string<uuid>
required

VM UUID that need to be considered for filter

​
action
enum<string>
required

Action to perform on the VM

Available options:
stop,
reboot,
snapshot,
enable-bgp,
disable-bgp

Body

application/json
​
team_id
string<uuid>

Team ID that need to be considered for filter. Default team will be used if not provided.

Example:

"96616865-475e-4191-aba5-f89f0a4b71fe"

​
name
string<string>

Snapshot name (if taking snapshot)

Example:

"vm-snapshot-name"

​
desc
string<string>

Snapshot desc (if taking snapshot)

Example:

"snapshot @ 20/09/2025"

Response

Successful operation