Sign in

Delete v0 city by city name workflow by workflow ID

delete/v0/city/{cityName}/workflow/{workflow_id}

Request

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

Path parameters

cityNamestring required

City name.

workflow_idstring required

Workflow (convoy) ID.

Query parameters

scope_kindstring

Scope kind (city or rig).

scope_refstring

Scope reference.

deleteboolean

Permanently delete beads from store.

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

OK

closedinteger required

Number of beads closed.

deletedinteger required

Number of beads deleted.

partialboolean

True when one or more teardown steps failed; Closed/Deleted still reflect what succeeded.

partial_errorsstring[] nullable

Human-readable errors from failed teardown steps.

workflow_idstring required

Workflow ID.

Changes

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