Archive a workspace

POST

/workspaces/{id}/archive

curl --request POST \
  --url https://your-org.evershell.ai/v1/workspaces/example/archive \
  --header 'Authorization: Bearer <token>'

• Hosted tenant

Permissions: workspace:write or workspace:write:own (creator-match on :own).

Hides the workspace from default listings (include_archived=true to surface). State is preserved — unarchive to bring it back. The workspace must be in an archivable state (typically stopped or failed); non-archivable states return 409 invalid_state.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Responses

200

Archived

Media type application/json

object

status

string

Example

{
  "status": "archived"
}

404

Resource not found in the caller’s org

Media type application/json

object

error

required

object

code

required

Closed-enum slug (e.g. permission_denied, validation_error, workspace_not_found)

string

message

required

Human-readable summary

string

request_id

required

Server-generated request id for correlating logs

string

details

Optional structured context. Validation errors land at details.fields as a per-field map.

object

key

additional properties

any

Example

{
  "error": {
    "code": "permission_denied",
    "message": "caller lacks required scope",
    "request_id": "7f3a9c2e"
  }
}

409

Workspace isn’t in an archivable state (invalid_state).

Media type application/json

object

error

required

object

code

required

Closed-enum slug (e.g. permission_denied, validation_error, workspace_not_found)

string

message

required

Human-readable summary

string

request_id

required

Server-generated request id for correlating logs

string

details

Optional structured context. Validation errors land at details.fields as a per-field map.

object

key

additional properties

any

Example

{
  "error": {
    "code": "permission_denied",
    "message": "caller lacks required scope",
    "request_id": "7f3a9c2e"
  }
}