Post v0 city by city name runs by run ID cancel

post/v0/city/{cityName}/runs/{run_id}/cancel

Request

  • The document declares no server URL.
  • Auth: none declared. Required headers: X-GC-Request

Path parameters

cityNamestring required

City name.

run_idstring required

Run identifier.

Headers

X-GC-Requeststring required

Anti-CSRF header required on mutation requests. Any non-empty value is accepted; the header's presence is what the server checks.

Response

Accepted

closedinteger required

Count of the run's beads closed by the cancel.

run_idstring required

The canceled run.

status'pending' | 'active' | 'waiting' | 'canceling' | 'completed' | 'failed' | 'canceled' | 'skipped' required

Closed lifecycle state of a run.

Changes

No recorded changes to this operation across all 50 revisions of this API.