Workspace: settings

The five knobs, each fixed by the platform, with the reason

GET /v1/workspace/settings · operation listSettings

Requires the batondeck:workspace:read permission (action workspace:read).

Responses

Status	Meaning
200	The five knobs, each fixed by the platform, with the reason
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": {
    "settings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          },
          "locked": {
            "type": "boolean"
          },
          "reason": {
            "type": "string"
          },
          "restart_scoped": {
            "type": "boolean"
          }
        },
        "required": [
          "key",
          "value",
          "locked",
          "reason",
          "restart_scoped"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "settings"
  ],
  "additionalProperties": false
}

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