Sign in

Get v0 city by city name rigs

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

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.

gitboolean

Include git status.

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

  • 04d6dfe60530Revision changes
    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status