foliot docs

API reference / Workspaces / Purge a closed workspace now

Purge a closed workspace now

POST/workspaces/{workspaceId}/purge

Authenticate with a signed-in Foliot Console session.

An owner of the workspace, signed in. Never an app key. Ends a closed workspace’s restore window now instead of at purgeAfter, and answers 202: the purge itself runs in the background within a few minutes, and removes the workspace and everything it holds (its apps with their workflows, runs and history, its members, invitations and history). It cannot be undone, and from this answer on the workspace can no longer be restored. Its slug is free once the purge has run. confirmName must be the workspace’s name. 409 for a workspace that is not closed: close it first.

Path parameters

workspaceId
string (uuid)
REQUIRED

The workspace.

Request body

confirmName
string
REQUIRED

The workspace's name, typed out, so the wrong workspace is not purged by mistake. Surrounding spaces are ignored; case is not.

min length 1 · max length 100

Responses

202 object Accepted
400 Error Invalid request.
401 Error Missing, malformed or unknown bearer token.
403 Error The token is valid but not permitted on this route.
404 Error No such resource.
409 Error Conflicts with existing state.
503 Error A dependency this route needs is unreachable.