Harthelm Docs
REST APIOperations

Get a long-running operation

The state of an action that outlives its request (a `202` answer names it in `Location`). It ends in `succeeded` or `failed` and stays readable for 7 days. Its creator and everyone with `team.view` on its team can read it; for anyone else it does not exist (404).

Generated from openapi/harthelm.yaml at v1.5.0
GET
/operations/{id}

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

id*string

The operation's id, from the 202 answer or an operation.updated event.

Formatuuid

Response Body

The operation.

application/json
  1. response

A long-running action. It ends in succeeded or failed and stays readable for 7 days.

id*string
Formatuuid
kind*string

What runs, for example workspace.create, workspace.delete, workspace.restore, workspace.volume_owner, landscape.sync, landscape.teardown, workspace.archive, workspace.restore_archive, managed_service.dump.

state*OperationState
Value in"pending""running""succeeded""failed"
target?string

API path of the resource the operation acts on, e.g. /workspaces/123.

detail?string

Human-readable progress, e.g. "Cloning repository".

error?

RFC 9457 problem details.

created_at*string
Formatdate-time
updated_at*string
Formatdate-time
finished_at?string
Formatdate-time
curl -X GET 'https://console.example.com/api/v1/operations/497f6eca-6276-4993-bfeb-53cbbbba6f08'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "kind": "string",  "state": "pending",  "target": "string",  "detail": "string",  "error": {    "type": "about:blank",    "title": "string",    "status": 100,    "detail": "string",    "instance": "string",    "errors": [      {        "pointer": "string",        "line": 1,        "column": 1,        "message": "string",        "code": "string",        "subject": "string"      }    ],    "held_by_deleted": {      "workspaces": 0,      "storage_gib": 0    },    "failed_team": {      "id": 1,      "name": "string",      "reason": "string"    }  },  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z"}

Change a member's team role

Team admins (`team.members`). 409 `last-admin` when it would leave the team without an admin.

Create an organization

Cluster admins only (`platform.admin`). The caller becomes the organization's owner, or the existing user named as `owner` does; more owners and members join by invitation or `POST /orgs/{org}/members`. 409 `name-taken` when an organization of that name exists (names compare case-insensitively).