Workspace: pause

Pause the workspace: restriction of processing, which you set and you lift

POST /v1/workspace/pause · operation pauseWorkspace

Requires the batondeck:workspace:admin permission (action workspace:pause).

Requires a step-up: MFA enrolled and re-authenticated within 15 minutes. Not reachable with an API key — a key has no session and so can never step up.

Refused while the workspace is suspended or on deletion hold.

Request body (application/json)

Field	Type	Required	Notes
reason	string		≤ 500 chars

Request schema

{
  "type": "object",
  "properties": {
    "reason": {
      "type": "string",
      "maxLength": 500
    }
  },
  "additionalProperties": false
}

Responses

Status	Meaning
201	Pause the workspace: restriction of processing, which you set and you lift
400	The arguments did not validate.
401	No portal session, and no live API key.
403	The policy refused, or the request was cross-site.
404	No such resource, or none this session may see.

201 response schema

{
  "type": "object",
  "properties": {
    "paused_at": {
      "type": "number"
    }
  },
  "required": [
    "paused_at"
  ],
  "additionalProperties": false
}

curl -X POST 'https://api.batondeck.com/v1/workspace/pause' \
  -H "Authorization: Bearer $BATONDECK_API_KEY" \
  -H 'content-type: application/json' \
  -d @body.json

Lift your own pause

DELETE /v1/workspace/pause · operation resumeWorkspace

Requires the batondeck:workspace:admin permission (action workspace:resume).

Refused while the workspace is suspended or on deletion hold.

Responses

Status	Meaning
200	Lift your own pause
401	No portal session, and no live API key.
403	The policy refused, or the request was cross-site.
404	No such resource, or none this session may see.

200 response schema

{
  "type": "object",
  "properties": {
    "paused": {
      "type": "boolean"
    },
    "suspended": {
      "type": "boolean"
    }
  },
  "required": [
    "paused",
    "suspended"
  ],
  "additionalProperties": false
}

curl -X DELETE 'https://api.batondeck.com/v1/workspace/pause' \
  -H "Authorization: Bearer $BATONDECK_API_KEY"