Layerbeat

Get a server

GET
/v1/vms/{id}

Returns a VPS's current status, public IP addresses and configuration.

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.

Path Parameters

id*string

The resource id.

Header Parameters

X-Org-ID?string

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

Response Body

Server

application/json
  1. response
billing?
id*string
name*string
status*string

Layerbeat service status. Terminated means deleted from Layerbeat; expiry closure does not confirm physical infrastructure deletion.

Value in"awaiting_payment""provisioning""running""stopping""stopped""suspended""starting""rebooting""terminating""terminated""canceled""failed"
terminated_at?|

When the Layerbeat service was closed. This is not evidence of physical data erasure.

Formatdate-time
termination_reason?|

Requested for a completed explicit deletion, expired for local closure after the eight-day renewal grace period, supplier_terminated when the server was ended outside Layerbeat before its paid period ended. Null while the service is active. Terminated servers stay in the server list for seven days and remain readable by ID.

Value in"requested""expired""supplier_terminated"
region*string
plan*string
image*string
ipv4*|

Public IPv4 address once the server is running.

ipv6*|

Public IPv6 address, if any.

vcpu*integer
memory_mb*integer
disk_gb*integer
created_at*string
Formatdate-time
expires_at*|

When the prepaid term ends.

Formatdate-time
auto_renew*boolean
auth?string
Value in"ssh_key""custom_password""random_password"
login_username?string
Value in"ubuntu""root"
password_available?boolean

True only for the purchasing identity while an initial generated password can be retrieved. Does not expose the password.

ssh_key_ids*array<string>
tags*
curl -X GET 'https://layerbeat.com/v1/vms/string'
{  "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"  }}