Skip to main content
GET
/
v1
/
regions
/
{region}
/
compute
/
vms
List VMs
const options = {method: 'GET'};

fetch('https://api.example.com/v1/regions/{region}/compute/vms', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "creating",
      "machineType": "<string>",
      "image": "<string>",
      "networkId": "<string>",
      "ipAddress": "<string>",
      "sshKeyId": "<string>",
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Path Parameters

region
string
required

Region identifier

Query Parameters

status
enum<string>

Filter by status

Available options:
creating,
running,
stopped,
rebooting,
deleting,
error
limit
number
default:50

Maximum results

offset
number
default:0

Results to skip

Response

200 - application/json

List of VMs

success
enum<boolean>
Available options:
true
data
object[]
meta
object