Layerbeat

Get a deployment

GET
/v1/deployments/{id}

Returns one deployment: status, the address it reported, the end of its last output and the ports it opened.

Access: API key: vm:read · Session: any member.

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

The deployment

application/json
  1. response
id*string
template*
version*string
latest_version*string
customized*boolean

Deployed with an edited install script; Layerbeat does not update it.

update_available*boolean
status*string

unknown: a run's result could not be confirmed; run a health check.

Value in"deploying""ready""failed""updating""removing""removed""unknown"
server*
url*|

Where to open the app, when it has one.

note*|

Something to do, for example pointing DNS to the server.

error*string|null
output*|

End of the last run's output (at most 4 KB).

ports_opened*array<>
operation*|

The latest operation on this deployment.

created_at*string
Formatdate-time
updated_at*string
Formatdate-time
checked_at*|
Formatdate-time
curl -X GET 'https://layerbeat.com/v1/deployments/string'
{  "id": "dep_7m2k9q4w8x3z5t6v1b0n2h4ra",  "template": {    "id": "supabase",    "name": "Supabase",    "kind": "service"  },  "version": "1.0.0",  "latest_version": "1.0.0",  "update_available": false,  "customized": false,  "status": "ready",  "server": {    "id": "vm_gnkrp6zuxvsqki7sqxeluvsw2y",    "name": "agent-01"  },  "url": "https://supabase.example.com",  "note": null,  "error": null,  "output": "layerbeat-template id=supabase version=1.0.0 action=install status=ok url=https://supabase.example.com",  "ports_opened": [    {      "port": 80,      "protocol": "tcp"    },    {      "port": 443,      "protocol": "tcp"    }  ],  "operation": {    "id": "op_4yw4xmradad4bstgr4d5qtreb4",    "type": "template.deploy",    "status": "succeeded"  },  "created_at": "2026-10-10T10:00:00Z",  "updated_at": "2026-10-10T10:04:00Z",  "checked_at": "2026-10-10T10:04:00Z"}