Harthelm Docs
REST APIWorkspaces

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.

Generated from openapi/harthelm.yaml at v1.5.0
POST
/workspaces/{ws}/purge

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

ws*integer

Numeric resource id.

Formatint64
Range1 <= value

Response Body

The purge is due now; it runs within seconds.

curl -X POST 'https://console.example.com/api/v1/workspaces/1/purge'
Empty