Skip to main content
PATCH
/
projects
/
{projectId}
/
vms
/
{id}
Update VM
curl --request PATCH \
  --url https://api.mkinf.io/v0.1/projects/{projectId}/vms/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "STOP"
}
'
{
  "operation": {
    "completed_at": "2021-12-03T19:59:34Z",
    "metadata": {},
    "operation_id": "F6EF489C-086E-458D-B812-7962964A28C9",
    "result": {},
    "started_at": "2021-12-03T19:58:34Z",
    "state": "IN_PROGRESS"
  }
}
Update a VM’s state. Supported actions:
  • START: Start the VM
  • STOP: Stop the VM
  • RESET: Restart the VM
  • UPDATE: Update VM configuration

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
projectId
string<uuid>
required

Project id

​
id
string<uuid>
required

VM id

Body

application/json
​
action
enum<string>
required
Available options:
START,
STOP,
RESET,
UPDATE

Response

200 - application/json
​
operation
object
required