Workspace
Cette page n'est pas disponible en français. La version anglaise est affichée.
Set the workspace status
Sets whether a workspace may be used, and for what. `active` — everything. `restricted` — reads and exports still work, every write is refused. `blocked` — the admin panel is closed. Two surfaces are NEVER affected by any status: the public keys API (blocking it would take down the customer's own site) and login plus `GET /api/v2/me` (the owner has to be able to get in and be told why). Super roles only. A Workspace Administrator cannot reach this route — otherwise they could lift the block on their own workspace.
Authorization
BearerAuthObject AuthorizationBearer <token>
In: header
Path Parameters
id*string
Workspace UUID
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/api/v2/workspaces/019fc817-0b94-7112-a578-66500eeec781/status" \ -H "Content-Type: application/json" \ -d '{ "status": "restricted" }'{ "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c", "status": "restricted"}{ "errors": { "id": "Invalid UUID format" }}{ "message": { "error": "Your request was made with invalid credentials." }}{ "message": { "error": "You are not allowed to perform this action." }}{ "message": { "error": "Page not found" }}{ "message": { "error": "Oops! Something went wrong! Write to administrator. Your Request Id {f1177aee-9a99-42f0-a23f-4dd29fc39b65-672e0df972ccb}" }}