Harthelm Docs
REST APICatalog

List plans

Plans come from the chart values and are mirrored into the database; retired plans are not listed.

Generated from openapi/harthelm.yaml at v1.5.0
GET
/plans

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.

Query Parameters

kind?string

Only plans of this kind.

Value in"workspace""service"
limit?integer

Maximum number of items per page.

Range1 <= value <= 200
Default50
cursor?string

Opaque cursor from next_cursor of the previous page.

Lengthlength <= 1024

Response Body

A page of plans, smallest first.

application/json
  1. response
next_cursor?string

Absent on the last page.

items*array<>
curl -X GET 'https://console.example.com/api/v1/plans'
{  "next_cursor": "string",  "items": [    {      "id": "string",      "kind": "workspace",      "name": "string",      "cpu_millis": 1,      "memory_mib": 1,      "storage_gib": 1,      "max_replicas": 1,      "is_default": true    }  ]}

List base images

The base images this installation offers for new workspaces, from the values (`baseImages`); the image reference itself is the platform's business and is not part of the answer.

Approve a CLI sign-in

Browser sessions only (403 with an API key): the user confirms in the console that the sign-in is theirs. The CLI then redeems it for a new API key of the approving user (`POST /cli/logins/{login}/token`). For a loopback sign-in the response names the CLI's local callback, which the console navigates to; it carries no secret.