> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blindsight.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Toggle Rule

> Switch a rule on or off for this device.

Switching off a workspace rule, or one of the detectors the agent ships, is
a separate grant from managing your own: one is housekeeping on rules you
wrote, the other lowers the floor your organisation set.

Putting the company's rule BACK is the one direction that needs no extra
grant. It deletes this device's override and returns the machine to the
workspace, which can only ever make it detect more.



## OpenAPI

````yaml /api-reference/openapi.json post /api/runtime-security/agent/rules/{name}/toggle
openapi: 3.1.0
info:
  title: Blindsight API
  version: 0.1.0
  description: >-
    The full Blindsight REST surface, generated from the running application.
    Replace the server host with your own deployment.


    For the Runtime Security integration surface (scan, proxy, tool calls) see
    the Runtime Security spec, which is hand written and carries worked
    examples.
servers:
  - url: https://api.your-blindsight.com
    description: Your Blindsight deployment
security: []
paths:
  /api/runtime-security/agent/rules/{name}/toggle:
    post:
      tags:
        - runtime-security-agent
      summary: Toggle Rule
      description: >-
        Switch a rule on or off for this device.


        Switching off a workspace rule, or one of the detectors the agent ships,
        is

        a separate grant from managing your own: one is housekeeping on rules
        you

        wrote, the other lowers the floor your organisation set.


        Putting the company's rule BACK is the one direction that needs no extra

        grant. It deletes this device's override and returns the machine to the

        workspace, which can only ever make it detect more.
      operationId: toggle_rule_api_runtime_security_agent_rules__name__toggle_post
      parameters:
        - name: name
          in: path
          required: true
          schema:
            type: string
            title: Name
        - name: X-Blindsight-Device-Token
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Blindsight-Device-Token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceRuleToggle'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    DeviceRuleToggle:
      properties:
        enabled:
          type: boolean
          title: Enabled
      type: object
      required:
        - enabled
      title: DeviceRuleToggle
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````