Sign in

Post v0 city by city name rig by name by action

post/v0/city/{cityName}/rig/{name}/{action}

Request

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

Path parameters

cityNamestring required

City name.

namestring required

Rig name.

action'suspend' | 'resume' | 'restart' required

Action to perform.

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

actionstring required

Action that was performed.

failedstring[] nullable

Agents that failed to stop (restart only).

killedstring[] nullable

Agents that were killed (restart only).

rigstring required

Rig name.

statusstring required

Operation result (ok, partial, failed).

Example response

{
  "status": "ok"
}

Changes

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