Layerbeat

Open a browser console

POST
/v1/vms/{id}/console

Returns a temporary link to the VPS console when you need access without SSH. Keep this link private.

Access: API key: vm:write · Session: developer, admin or owner.

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

Console link

application/json
  1. response
url*string

Short-lived console websocket URL. A secret.

viewer_url*string

A hosted page that opens the console for you. A secret.

note*string
curl -X POST 'https://layerbeat.com/v1/vms/string/console'
{  "url": "wss://console.example.net:443/vnc?s=…",  "viewer_url": "https://console.example.net/viewer?InstanceVncUrl=…",  "note": "Short-lived and single-purpose. Do not share."}