Patch v0 city by city name rig by name

patch/v0/city/{cityName}/rig/{name}

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.

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.

Request body

default_branchstring

Mainline branch (e.g. main, master).

pathstring

Filesystem path.

prefixstring

Session name prefix.

suspendedboolean

Whether rig is suspended.

Response

OK

statusstring required

Operation result.

Example response

{
  "status": "ok"
}

Changes

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