Skip to content
AugentaDocsOpen console ↗
Archive a Workspace

Documentation

API reference
View Markdown

Archive a Workspace

POST/v1/workspaces/{id}/archive

An administrator can archive a shared Workspace before deleting its data. Personal Default Workspaces cannot be archived. Archived Workspaces refuse new writes.

Authentication

Use your signed-in console session or a person's WorkOS access token for this setup operation. See authentication and permissions.

Request

Parameters

idstringrequired

path parameter.

Min length: 1

If-Matchstringoptional

header parameter.

Responses

Archived. No response body.