Harthelm Docs
REST APIStages

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`.

Generated from openapi/harthelm.yaml at v1.5.0
POST
/workspaces/{ws}/stages/{stage}/start

Authorization

cookie__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.

Path Parameters

ws*integer

Numeric resource id.

Formatint64
Range1 <= value
stage*string
Value in"prepare""test""run"

Request Body

application/json
  1. body
profile?ProfileName

For prepare and test; the run stage always uses the synced profile.

Match^([a-z0-9]([-a-z0-9]{0,30}[a-z0-9])?)?$

Response Body

Started; follow stage.updated events or GET /workspaces/{ws}/stages/{stage}.

application/json
  1. response
id*ID

Numeric resource id.

Formatint64
Range1 <= value
stage*StageName
Value in"prepare""test""run"
profile?ProfileName

A profile (harthelm.<profile>.yml); absent or empty for harthelm.yml.

Match^([a-z0-9]([-a-z0-9]{0,30}[a-z0-9])?)?$
source_hash?string

prepare and test, the hash of the file they ran; run, the landscape's spec_hash.

run_generation?integer
Formatint64
state*PipelineRunState
Value in"waiting""running""success""failure""aborted"
started_by?ID

Numeric resource id.

Formatint64
Range1 <= value
created_at*string
Formatdate-time
started_at?string
Formatdate-time
finished_at?string
Formatdate-time
entries*array<>
curl -X POST 'https://console.example.com/api/v1/workspaces/1/stages/prepare/start' \  -H 'Content-Type: application/json' \  -d '{}'
{  "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"    }  ]}

Get a stage and its latest run

The stage's latest run with the state of every step on every replica. Needs `workspace.view`.

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`.