# 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 a person's Bearer access token or console session. See [Authentication](https://augenta.pages.dev/docs/authentication.md).

## Request example

```bash
curl --fail-with-body -X POST "https://api.augenta.ai/v1/workspaces/$AUGENTA_WORKSPACE_ID/archive" \
  -H "Authorization: Bearer $AUGENTA_ACCESS_TOKEN"
```

## Parameters

<a id="request-parameters-id"></a>

### `request.parameters.id`

`string` · required

path parameter.

Min length: `1`.

<a id="request-parameters-if-match"></a>

### `request.parameters.If-Match`

`string` · optional

header parameter.

## Response 204

Archived. No response body.

## Response 400

Invalid parameters, unavailable resource, changed revision or insufficient human permissions. API keys cannot administer organizations or Workspaces.

Content-Type: `application/json`

<a id="response-400-error"></a>

### `response.400.error`

`object` · always present

<a id="response-400-error-code"></a>

### `response.400.error.code`

`string` · always present

Stable. The Errors page lists every code.

<a id="response-400-error-message"></a>

### `response.400.error.message`

`string` · always present

Human-readable. May change; don't parse it.

<a id="response-400-error-retryable"></a>

### `response.400.error.retryable`

`boolean` · always present

<a id="response-400-error-retryafterseconds"></a>

### `response.400.error.retryAfterSeconds`

`integer` · conditional

Capacity retry interval, also present as Retry-After before stream headers commit. SSE error events retain this field after HTTP 200 is committed.

Minimum: `1`.

<a id="response-400-error-billingurl"></a>

### `response.400.error.billingUrl`

`string` · conditional

Top-up action when error.code is insufficient_balance (HTTP 402).

<a id="response-400-requestid"></a>

### `response.400.requestId`

`string` · always present

The request's id, as in the `X-Request-Id` response header.

## Response 401

Invalid parameters, unavailable resource, changed revision or insufficient human permissions. API keys cannot administer organizations or Workspaces.

Content-Type: `application/json`

Response fields use the same schema as Response 400.

## Response 403

Invalid parameters, unavailable resource, changed revision or insufficient human permissions. API keys cannot administer organizations or Workspaces.

Content-Type: `application/json`

Response fields use the same schema as Response 400.

## Response 404

Invalid parameters, unavailable resource, changed revision or insufficient human permissions. API keys cannot administer organizations or Workspaces.

Content-Type: `application/json`

Response fields use the same schema as Response 400.

## Response 409

Invalid parameters, unavailable resource, changed revision or insufficient human permissions. API keys cannot administer organizations or Workspaces.

Content-Type: `application/json`

Response fields use the same schema as Response 400.

## Response 429

Invalid parameters, unavailable resource, changed revision or insufficient human permissions. API keys cannot administer organizations or Workspaces.

Content-Type: `application/json`

Response fields use the same schema as Response 400.

## Response 500

Invalid parameters, unavailable resource, changed revision or insufficient human permissions. API keys cannot administer organizations or Workspaces.

Content-Type: `application/json`

Response fields use the same schema as Response 400.

## Response 503

Invalid parameters, unavailable resource, changed revision or insufficient human permissions. API keys cannot administer organizations or Workspaces.

Content-Type: `application/json`

Response fields use the same schema as Response 400.
