Archive Workspace
api/admin/workspaces/archive
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/admin/workspaces/archive Changed · +14 / -17 lines
# Archive Workspace ## Path parameters ## Returns ## Example ### Response (200) ## Archive Workspace ### Path Parameters ### Returns ### Example #### Response
---- -title: Archive Workspace -url: https://platform.claude.com/docs/en/api/admin/workspaces/archive ---- +# Archive Workspace -## Archive Workspace +**POST** `/v1/organizations/workspaces/{workspace_id}/archive` -**post** `/v1/organizations/workspaces/{workspace_id}/archive` - Archive Workspace -### Path Parameters +## Path parameters - `workspace_id: string` -### Returns +## Returns -- `Workspace object { id, archived_at, compartment_id, 7 more }` +- `Workspace object` - `id: string`
RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + format: date-time + - `compartment_id: string` Identifier for this Workspace's encryption compartment. When you configure a
RFC 3339 datetime string indicating when the Workspace was created. - - `data_residency: object { allowed_inference_geos, default_inference_geo, workspace_geo }` + format: date-time + - `data_residency: object` + Data residency configuration. - `allowed_inference_geos: array of string or "unrestricted"`
- `"unrestricted"` - - `"unrestricted"` - - `default_inference_geo: string` Default inference geo applied when requests omit the parameter.
For Workspaces, this is always `"workspace"`. - - `"workspace"` + default: workspace -### Example +## Example -```http +```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +### Response (200) ```json {