Skip to content

Get virtual machine

GET
/api/virtual-machines/{id}
 
curl --request GET \
  --url http://localhost:3000/api/virtual-machines/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie session=<session>

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

Media type application/json
object
data
object
id
required
string format: uuid
name
required
string
clusterId
string format: uuid
nullable
status
string
nullable
vcpus
integer
nullable
memoryMb
integer
nullable
diskGb
integer
nullable
platformId
string format: uuid
nullable
description
string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example generated
{
  "data": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "clusterId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "status": "example",
    "vcpus": 1,
    "memoryMb": 1,
    "diskGb": 1,
    "platformId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "description": "example",
    "createdAt": "2026-04-15T12:00:00Z",
    "updatedAt": "2026-04-15T12:00:00Z"
  }
}

401

Section titled “401 ”

Not authenticated

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}

404

Section titled “404 ”

VirtualMachine not found

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}