setControlsKillSwitch

Requires permission settings:controls:manage.

Turns the controls kill switch on (every enforced control only observes until released) or off. A reason is required either way; the change is kept in the settings history and the activity log. 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

mutation SetControlsKillSwitch($input: SetControlsKillSwitchInput!) {
  setControlsKillSwitch(input: $input) {
    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": "mutation SetControlsKillSwitch($input: SetControlsKillSwitchInput!) {\n  setControlsKillSwitch(input: $input) {\n    active\n    reason\n    setAt\n    setBy\n  }\n}",
  "variables": {
    "input": {
      "active": true,
      "reason": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "active": true,
    "reason": "string"
  }
}

Response:

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

setControlsKillSwitch(
  input: SetControlsKillSwitchInput!
): ControlsKillSwitchType!

Arguments

setControlsKillSwitch.input ● SetControlsKillSwitchInput! non-null input

On or off, and why.

Type

ControlsKillSwitchType object

The switch that makes every control observe.