controlsKillSwitch

Requires permission settings:controls:manage.

Returns the organization's controls kill switch: whether every control only observes, and who set it and why. Requires settings:controls:manage.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query ControlsKillSwitch {
  controlsKillSwitch {
    active
    reason
    setAt
    setBy
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ControlsKillSwitch {\n  controlsKillSwitch {\n    active\n    reason\n    setAt\n    setBy\n  }\n}"
}
EOF

Response:

{
  "data": {
    "controlsKillSwitch": {
      "active": true,
      "reason": "string",
      "setAt": "2025-01-15T00:00:00Z",
      "setBy": "string"
    }
  }
}

controlsKillSwitch: ControlsKillSwitchType!

Type

ControlsKillSwitchType object

The switch that makes every control observe.