Layerbeat

List servers

GET
/v1/vms

Lists the VPSs in your workspace.

Access: API key: vm:read · Session: any workspace role.

Authorization

headerAuthorizationBearer <token>

Send Authorization: Bearer <token>. A token is an API key (lb_live_…, scoped, for programs) or a session (lb_sess_…, from signup or login, for people). See Authentication above.

Query Parameters

status?string

Only servers with this status (for example running). Use terminated to include deleted-server history, otherwise deleted records are excluded.

region?string

Only servers in this region (for example sgp).

limit?integer

Page size.

Range1 <= value <= 100
Default50
cursor?string

next_cursor from the previous page.

Header Parameters

X-Org-ID?string

Sessions only: act on this organization (you must be a member). Default: your first organization.

Response Body

Servers

application/json
  1. response
data*array<>
next_cursor*|

Pass as cursor to get the next page; null when there are no more results.

curl -X GET 'https://layerbeat.com/v1/vms'
{  "data": [    {      "id": "vm_gnkrp6zuxvsqki7sqxeluvsw2y",      "name": "web-1",      "status": "running",      "region": "sgp",      "plan": "small",      "image": "ubuntu-24-04",      "ipv4": "203.0.113.10",      "ipv6": null,      "vcpu": 2,      "memory_mb": 2048,      "disk_gb": 60,      "created_at": "2026-10-01T10:00:00Z",      "expires_at": "2026-11-01T10:00:41Z",      "auto_renew": true,      "ssh_key_ids": [        "key_m2q8vx4zt7kd5wn3bj6hf9cpra"      ],      "tags": {        "env": "prod"      }    }  ],  "next_cursor": null}