Sign in

Get v0 city by city name status

Changed on
get/v0/city/{cityName}/status

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

cityNamestring required

City name.

Query parameters

indexstring

Event sequence number; when provided, blocks until a newer event arrives.

waitstring

How long to block waiting for changes (Go duration string, e.g. 30s). Default 30s, max 2m.

liteboolean

When true, omit the expensive store-health, session-count, and work-count blocks for low-cost dashboard polls.

Response

OK

agent_countinteger required

Total agent count (deprecated, use agents.total).

beads_versionstring

Version of the bd (beads) CLI the supervisor drives. Omitted when the probe failed or the binary is unavailable.

dolt_versionstring

Version of the dolt engine binary the supervisor drives. Omitted when the probe failed or the binary is unavailable.

namestring required

City name.

partialboolean

True when one or more status backing reads returned incomplete data.

partial_errorsstring[] nullable

Human-readable errors from incomplete status backing reads.

pathstring required

City directory path.

rig_countinteger required

Total rig count (deprecated, use rigs.total).

runninginteger required

Number of running agent processes.

stores_not_readboolean

True when the city is suspended: the body was built without reading any bead store (a read would restart its retired bd proxy), so work, mail, session-count and store-health figures are absent.

suspendedboolean required

Whether the city is suspended.

uptime_secinteger required

Server uptime in seconds.

versionstring

Server version.

Changes

  • f0f812098370Revision changes
    • ○

      added the optional property to the response with the status

    • ○

      added the optional property / to the response with the status

  • 35b42ec164b5Revision changes
    • ○

      added the optional property / to the response with the status