Virtual machines

Virtual servers: their state, and starting, stopping and rebooting them.

GET/services/{service_id}/vmA virtual machine
GET/vps-plansVirtual server plans
POST/services/{service_id}/vm/startStart
POST/services/{service_id}/vm/shutdownShut down
POST/services/{service_id}/vm/rebootReboot
POST/services/{service_id}/vm/stopStop

A virtual machine

GET/services/{service_id}/vm

Needs the permission vm:read

Its state, resources and addresses.

Path

service_idrequired string (uuid)

Response 200

`id`required	string
`name`required	string
`status`required	string
`node`required	string \| null
`cpus`required	integer \| null
`memory_mb`required	integer \| null
`disk_gb`required	integer \| null
`uptime_seconds`required	integer \| null
`plan`	object \| null
`name`required	string
`cpus`required	integer
`memory_gb`required	integer
`disk_gb`required	integer
`extras`required	string[]
`extras_en`	string[]	default []
`prices`	object[]	default []
`months`required	integer
`amount`required	number
`currency`required	string

curl "https://portal.nimag.net/api/v1/services/{service_id}/vm" \
  -H "Authorization: Bearer nck_…"

{
  "id": "string",
  "name": "string",
  "status": "string",
  "node": "string",
  "cpus": 0,
  "memory_mb": 0,
  "disk_gb": 0,
  "uptime_seconds": 0,
  "plan": {
    "name": "string",
    "cpus": 0,
    "memory_gb": 0,
    "disk_gb": 0,
    "extras": [
      "string"
    ],
    "extras_en": [],
    "prices": []
  }
}

Virtual server plans

GET/vps-plans

Any key

The plans a new virtual server can be ordered on.

Response 200

`name`required	string
`cpus`required	integer
`memory_gb`required	integer
`disk_gb`required	integer
`extras`required	string[]
`extras_en`	string[]	default []
`prices`	object[]	default []
`months`required	integer
`amount`required	number
`currency`required	string

curl "https://portal.nimag.net/api/v1/vps-plans" \
  -H "Authorization: Bearer nck_…"

[
  {
    "name": "string",
    "cpus": 0,
    "memory_gb": 0,
    "disk_gb": 0,
    "extras": [
      "string"
    ],
    "extras_en": [],
    "prices": []
  }
]

Start

POST/services/{service_id}/vm/start

Needs the permission vm:manage

Path

service_idrequired string (uuid)

Response 202: Successful Response.

curl -X POST "https://portal.nimag.net/api/v1/services/{service_id}/vm/start" \
  -H "Authorization: Bearer nck_…"

"string"

Shut down

POST/services/{service_id}/vm/shutdown

Needs the permission vm:manage

Asks the operating system to shut down, as the power button would.

Path

service_idrequired string (uuid)

Response 202: Successful Response.

curl -X POST "https://portal.nimag.net/api/v1/services/{service_id}/vm/shutdown" \
  -H "Authorization: Bearer nck_…"

"string"

Reboot

POST/services/{service_id}/vm/reboot

Needs the permission vm:manage

Asks the operating system to restart.

Path

service_idrequired string (uuid)

Response 202: Successful Response.

curl -X POST "https://portal.nimag.net/api/v1/services/{service_id}/vm/reboot" \
  -H "Authorization: Bearer nck_…"

"string"

Stop

POST/services/{service_id}/vm/stop

Needs the permission vm:manage

Cuts the power at once, without asking the operating system: unsaved work is lost.

Path

service_idrequired string (uuid)

Response 202: Successful Response.

curl -X POST "https://portal.nimag.net/api/v1/services/{service_id}/vm/stop" \
  -H "Authorization: Bearer nck_…"

"string"