Skip to main content
GET
/
api
/
apps
/
{id}
/
health
Check if an app's URL is live by verifying actual content is served, and probe the underlying service and port status.
curl --request GET \
  --url https://api.rigbox.dev/api/apps/{id}/health \
  --header 'Authorization: Bearer <token>'
{
  "live": true,
  "port_open": true,
  "service_status": "<string>",
  "port_drift": true
}
Use this before surfacing an app URL in your UI to confirm the service is actually responding.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

App ID

Response

200 - application/json

App health

​
live
boolean
required

Whether the app responded to an HTTP probe.

​
port_open
boolean
required

Whether the expected port is listening inside the workspace.

​
service_status
string
required

Systemd service status (e.g. "active", "inactive", "unknown", "unmanaged").

​
port_drift
boolean

True when the service is active but the expected port is not listening.