Harthelm Docs
REST APIStages

Get a stage and its latest run

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

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

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"

Response Body

The stage.

application/json
  1. response
stage*StageName
Value in"prepare""test""run"
running*boolean
run?

The latest run; absent when the stage never ran.

curl -X GET 'https://console.example.com/api/v1/workspaces/1/stages/prepare'
{  "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"      }    ]  }}

Change a container registry

Team admins (`team.manage`). Absent fields stay; an absent `password` keeps the stored one, except that an `address` on another host needs the `password` again (422 at `/password`): the stored password only ever goes to the host it was entered for. The pull Secrets of running services follow at their workspace's next reconcile; the digests stay what their last Sync resolved.

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