Harthelm Docs
REST APITeams

Delete a team

Team admins (`team.manage`). Asynchronous and resumable: the team turns `deleting` at once (it takes no writes, 409 `team-deleting`), and the operation `team.delete` removes its workspaces (purged at once, without the 7-day soft delete), managed services, registries, domains, git access defaults, shared vaults and namespace, then the team with its memberships and invitations. Every member loses access when the deletion starts. Deleting a deleting team returns its operation, or, when that operation failed because a step gave up (problem `team-delete-failed` with `failed_team`), starts a new `team.delete` operation that resumes the cascade.

Generated from openapi/harthelm.yaml at v1.5.0
DELETE
/teams/{team}

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

team*integer

Numeric resource id.

Formatint64
Range1 <= value

Response Body

Accepted; follow 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 DELETE 'https://console.example.com/api/v1/teams/1'
{  "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"}

Create a team

Organization owners and cluster admins (`org.create_team` on `org_id`). A creator who is a member of the organization becomes the team's admin. 409 `name-taken` when the organization has a team of that name.

The team's quota and usage

Every member (`team.view`): the installation default, the team's override, the effective quota (what the namespace's ResourceQuota and the pre-checks on create, Sync and wake use) and the current usage, counted like the pre-checks count it.