Stop a stage
Aborts the active run (`prepare`, `test`), or sets every service to stopped (`run`; the pods stay). Stopping a stage that does not run is not an error. Needs `landscape.manage`.
openapi/harthelm.yaml at v1.5.0__Host-harthelm_session<token>Browser session of the UI (12 h idle, 7 days absolute). State-changing requests also need the header
Harthelm-CSRF: 1 and a matching Origin.
ws*integerNumeric resource id.
int641 <= valuestage*string"prepare""test""run"The stage after the stop.
application/json- response
stage*StageName"prepare""test""run"running*booleanrun?The latest run; absent when the stage never ran.
curl -X POST 'https://console.example.com/api/v1/workspaces/1/stages/prepare/stop'{ "stage": "prepare", "running": true, "run": { "id": 1, "stage": "prepare", "profile": "string", "source_hash": "string", "run_generation": 0, "state": "waiting", "started_by": 1, "created_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z", "entries": [ { "service": "string", "replica": "string", "step": 0, "name": "string", "state": "waiting", "exit_code": 0, "restarts": 0, "started_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z", "message": "string" } ] }}Start a stage
`prepare` and `test` read the profile's file now and run its steps in the IDE agent with the workspace env vars and without vault values. `run` bumps the run generation, sets every service to started and tells every ready replica; restarted or woken pods start on their own while the landscape is started . Answers 409 `stage-running` while a run of the stage is active, 409 `landscape-not-synced` for `run` before a Sync, and 409 (`disk-quota-exceeded`) for `prepare` when the workspace is over its disk quota. Needs `landscape.manage`.
Return the team to the default quota
Cluster admins only (`platform.admin`). Removes the override.