Services
Service runtime data is exposed through the WebSocket protocol, not through a REST services endpoint.
Use /ws and runtime commands such as get_snapshot, start_service, stop_service, and restart_service.
Service snapshot shape
Section titled “Service snapshot shape”get_snapshot returns result.payload.data.services:
{ "services": [ { "name": "api", "status": "running" }, { "name": "worker", "status": "ready" } ]}Confirmed per-service fields in this payload:
name(string)status(string)
Not part of the current snapshot contract:
pidportmetadata
Status values
Section titled “Status values”Confirmed status values for service runtime state:
startingrunningreadystoppingfailedstoppedunknown
unknown appears in snapshot when no state is recorded for a service.
Related runtime commands
Section titled “Related runtime commands”get_snapshot
Section titled “get_snapshot”Request payload: none.
Returns the current runtime service list with name and status.
start_service
Section titled “start_service”Request payload:
{ "service": "api"}stop_service
Section titled “stop_service”Request payload:
{ "service": "api"}restart_service
Section titled “restart_service”Request payload:
{ "service": "api"}For command transport and response envelopes, see Message Envelopes and Actions.