Skip to main content
POST
/
vm
/
{vm_id}
/
stop
Stop a VM
curl --request POST \
  --url https://api.cloud.onidel.com/vm/{vm_id}/stop \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "team_id": "96616865-475e-4191-aba5-f89f0a4b71fe",
  "force_stop": false
}
'
{
  "audit_log_id": "0f9c2d1a-3b4e-4c5d-8a6f-7b8c9d0e1f2a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
vm_id
string<uuid>
required

VM UUID

Body

application/json
​
team_id
string<uuid>

Team ID. Default team will be used if not provided.

Example:

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

​
force_stop
boolean

Skip the graceful ACPI shutdown and hard-stop the VM immediately.

Example:

false

Response

Action accepted

​
audit_log_id
string<uuid>
Example:

"0f9c2d1a-3b4e-4c5d-8a6f-7b8c9d0e1f2a"