Harthelm Docs
REST APIWorkspaces

List workspaces of a team

The workspaces of one team the caller may see, newest first; with `deleted` the soft-deleted ones that can still be restored. Needs `team.view`.

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

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

team*integer

Team to list workspaces for.

Formatint64
Range1 <= value
deleted?boolean

List the soft-deleted workspaces that can still be restored instead of the live ones.

Defaultfalse
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 workspaces, newest first.

application/json
  1. response
next_cursor?string

Absent on the last page.

items*array<>
curl -X GET 'https://console.example.com/api/v1/workspaces?team=1'
{  "next_cursor": "string",  "items": [    {      "id": 1,      "team_id": 1,      "name": "string",      "plan": "string",      "base_image": "string",      "git": {        "provider": "string",        "repo": "string",        "ref": "string"      },      "storage_gib": 1,      "availability": "always",      "restricted": true,      "state": "creating",      "status_detail": "string",      "urls": {        "ide": "string",        "dev": "string"      },      "dev_service": {        "name": "string",        "state": "running",        "wake_seconds": 0,        "needs": [          "string"        ],        "failing_needs": [          "string"        ]      },      "vault_id": 1,      "single_node": true,      "idle_timeout_minutes": 1,      "last_archived_at": "2019-08-24T14:15:22Z",      "restored_from": 1,      "upgrade_pending": true,      "created_by": 1,      "owner_id": 1,      "needs_owner": true,      "permissions": [        "string"      ],      "created_at": "2019-08-24T14:15:22Z",      "deleted_at": "2019-08-24T14:15:22Z",      "purge_after": "2019-08-24T14:15:22Z"    }  ]}

Get a workspace

Soft-deleted workspaces stay readable until they are purged.

Purge a soft-deleted workspace now

Team admins and cluster admins (`team.manage` on the workspace's team). A soft-deleted workspace keeps its volume, and so counts against the team's storage quota, until `purge_after`; this purges it at once instead: its volume, objects and rows go and it can no longer be restored. Audited as `workspace.purge`; the event `workspace.purged` follows when it is gone (`GET /teams/{team}/quota` then no longer counts it). A live workspace answers 409 `workspace-not-deleted`; purging one whose purge is under way answers 204 again. The console asks to type the workspace's name first.