Harthelm Docs
REST APIOrgs

Rename an organization

Organization owners (`org.manage`). 409 `name-taken`; 409 `org-deleting` while it is being deleted.

Generated from openapi/harthelm.yaml at v1.5.0
PATCH
/orgs/{org}

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

org*string
Formatuuid

Request Body

application/json
  1. body
Properties1 <= properties
name?TenantName

1 to 64 characters without leading or trailing spaces; unique case-insensitively.

Match^\S(.*\S)?$
Length1 <= length <= 64

Response Body

The organization.

application/json
  1. response
id*string
Formatuuid
name*string
role?OrgRole

The caller's role; absent when a cluster admin sees an organization they are not a member of.

Value in"owner""member"
created_at*string
Formatdate-time
deleting?boolean

The organization is being deleted; it takes no writes. Absent for an older core.

delete_operation_id?string

The org.delete operation of a deleting organization.

Formatuuid
permissions?array<>

The caller's permissions on the resource; the UI shows only what they allow. Absent for an older core.

curl -X PATCH 'https://console.example.com/api/v1/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "role": "owner",  "created_at": "2019-08-24T14:15:22Z",  "deleting": true,  "delete_operation_id": "2a58cc5e-4ba9-418a-8f8b-9007f099696a",  "permissions": [    "string"  ]}

List organizations

The caller's organizations; cluster admins see every organization.

Get the power state of a workspace

The IDE and every service of the synced landscape: awake or asleep and why, the last wake and how it ended, and what keeps a target awake. The UI polls it while something wakes and refetches it on `workspace.updated` and `landscape.updated`.