Skip to content
LogoLogo

Archive a Workspace

Archive a Workspace

DELETE/api/v1/workspaces/{workspace_id}

Archives the Workspace. Requires an owner and authentication within the last 15 minutes, so a borrowed session cannot pull a Workspace out from under its members.

No data is deleted. Every session scoped to the Workspace is revoked in the same transaction, the Workspace disappears from the default Workspace list, and every Workspace-scoped route answers not-found — except an owner's read and the restoring PATCH. Archival is therefore a real access boundary, not a display flag, and it is reversible.

A caller's last active Workspace cannot be archived. Account-only sessions are reserved for first-Workspace onboarding, so an existing scoped account cannot return to that state by archiving its Workspace. That case answers 409 last_workspace.

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

If-MatchRequired
string

Entity tag containing the resource version last observed by the client.

Idempotency-KeyRequired
string·min 16·max 200

Opaque client-generated key for safely retrying this operation.

Responses

204The Workspace is archived.

Authentication · Conventions and errors · API guides · Resource reference