Layerbeat

Check a deployment

POST
/v1/deployments/{id}/health

Runs the template's read-only health check on the server. A passing check marks the deployment ready; a failing one marks it failed with the reason.

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

Accepted: the check is running

application/json
  1. response
deployment*
dependencies*array<>

Templates deployed first in the same request.

operation*
curl -X POST 'https://layerbeat.com/v1/deployments/string/health'
{  "deployment": {    "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.health",      "status": "pending"    },    "created_at": "2026-10-10T10:00:00Z",    "updated_at": "2026-10-10T10:04:00Z",    "checked_at": "2026-10-10T10:04:00Z"  },  "dependencies": [],  "operation": {    "id": "op_4yw4xmradad4bstgr4d5qtreb4",    "type": "template.health",    "status": "pending",    "vm_id": "vm_gnkrp6zuxvsqki7sqxeluvsw2y",    "volume_id": null,    "deployment_id": "dep_7m2k9q4w8x3z5t6v1b0n2h4ra",    "steps": [      {        "name": "running",        "status": "running"      }    ],    "result": null,    "error": null,    "created_at": "2026-10-10T10:00:00Z",    "finished_at": null  }}