Sign in

Get v0 city by city name agents

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

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.

poolstring

Filter by pool name.

rigstring

Filter by rig name.

running'true' | 'false'

Filter by running state. Omit to return all agents.

peekboolean

Include last output preview.

Response

OK

next_cursorstring

Cursor for the next page of results.

partialboolean

True when one or more backends failed and the list is incomplete.

partial_errorsstring[] nullable

Human-readable errors from backends that failed during aggregation.

totalinteger required

Total number of items matching the query.

Changes