Archive a workspace
OpenAPI contract
- Method
- POST
- Path
/api/v1/workspaces/{id}/archive- Security
- jwtBearer (bearer)
- Response status
- 200 400 401 403 404 409 429 500
Request and response schemas
JSON
{
"requestBody": {},
"responses": {
"200": {
"description": "Workspace archived",
"content": {
"application/json": {
"$ref": "#/components/schemas/WorkspaceResponse"
}
}
},
"400": {
"description": "Invalid request",
"content": {
"application/json": {
"$ref": "#/components/schemas/RequestError"
}
}
},
"401": {
"description": "Authentication required or invalid",
"content": {
"application/json": {
"$ref": "#/components/schemas/SecurityError"
}
}
},
"403": {
"description": "Authenticated but not permitted",
"content": {
"application/json": {
"$ref": "#/components/schemas/SecurityError"
}
}
},
"404": {
"description": "Requested workspace resource was not found",
"content": {
"application/json": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"409": {
"description": "Request conflicts with current workspace state",
"content": {
"application/json": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"429": {
"description": "Rate limit exceeded",
"content": {
"application/json": {
"$ref": "#/components/schemas/SecurityError"
}
}
},
"500": {
"description": "Unexpected server error",
"content": {
"application/json": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}POST /api/v1/workspaces/{id}/archive is JWT-only and requires workspace:manage. It marks the workspace archived, records the archive time, and returns the updated workspace response. The personal workspace created for an account cannot be archived and returns a conflict.
Archiving is reversible through the restore operation. It does not delete workspace history. An inaccessible workspace is not exposed, and an nfy_ automation key cannot call this operation.