Get all platforms

GET 
/api/v1/platforms

Get all platforms

Request

Query Parameters

query string

Query to search platforms

Responses

200

application/json

Schema

Schema

• Array [

name stringrequired

Name of the platform

description string

Description of the platform

os string

Possible values: [android, windows, linux, macos]

Operating system of the platform

cpuArchitecture string

Possible values: [X86_64, ARM64]

cpuCount number

Number of vCPUs

memoryMb number

Memory size in MB

diskGb number

Disk size in GB

diskType string

Possible values: [HDD, SSD, NVME]

networkType string

Possible values: [NAT, BRIDGED, HOST_ONLY, CUSTOM]

imageId string

Optional image ID

metadata object

Optional tags or metadata

id numberrequired

ID of the platform

createdAt date-timerequired

Timestamp when the platform was created

updatedAt date-timerequired

Timestamp when the platform was last updated

• ]

Example (from schema)

[
  {
    "name": "string",
    "description": "This is a sample platform.",
    "os": "windows",
    "cpuArchitecture": "X86_64",
    "cpuCount": 0,
    "memoryMb": 0,
    "diskGb": 0,
    "diskType": "HDD",
    "networkType": "NAT",
    "imageId": "string",
    "metadata": {},
    "id": 0,
    "createdAt": "2026-01-01T11:09:06.669Z",
    "updatedAt": "2026-01-01T11:09:06.669Z"
  }
]

Loading...