> ## 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.

# Whether the firewall is on and ready to scan

> Requires the `runtime:events:read` permission. The response carries
further fields for operators; only `enabled` and `status` are part of
the supported contract.




## OpenAPI

````yaml /api-reference/openapi-runtime-security.yaml get /api/runtime-security/health
openapi: 3.1.0
info:
  title: Blindsight Runtime Security API
  version: 1.0.0
  summary: 'LLM firewall: prompt-injection, PII, and agent tool-call protection.'
  description: >
    Drop-in firewall for LLM traffic. Three integration modes:

      * **Scan API**, explicit `/scan/input` and `/scan/output` calls.
      * **Reverse proxy**, wire-compatible with the OpenAI, Anthropic, Gemini,
        Vertex and Bedrock APIs; swap the SDK's `base_url` to enable scanning
        at the network boundary.
      * **Tool-call scan**, a check of agent tool arguments before execution.

    **Authentication.** Send a Blindsight API key in the `X-API-Key` header.

    Each key carries permissions, and an endpoint needs one of them:


    | Permission | Value | Endpoints |

    | --- | --- | --- |

    | Scan prompts and responses | `runtime:scan` | `/scan/*` and `/proxy/*` |

    | Read threat events | `runtime:events:read` | `/events`,
    `/events/{uuid}/explain`, `/analytics`, `/drift`, `/health`,
    `/service-status` and the other read endpoints |

    | Read firewall configuration | `runtime:config:read` | `GET /config` |

    | Write firewall configuration | `runtime:config:write` | `PUT /config` |


    `runtime:*` (Full Runtime Access) and full platform access cover all of

    them. A key acts as the person who created it and can never do more than

    that person can.


    All timestamps are UTC, ISO 8601, ending in `Z`, unless an endpoint says

    otherwise.


    See the Runtime Security guides for prose docs, SDK examples, and a

    walk-through of verdicts and configuration.
  contact:
    name: Blindsight Support
    url: https://blindsight.example.com/support
  license:
    name: Proprietary
servers:
  - url: https://platform.blindsight.io
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Scan
    description: Single-call scan endpoints for input, output, batch, and tool calls.
  - name: Proxy
    description: >-
      Wire-compatible reverse-proxy endpoints for OpenAI, Anthropic, Gemini,
      Vertex and Bedrock.
  - name: Configuration
    description: Workspace-scoped firewall settings.
  - name: Analytics
    description: Read-only analytics, event log, and drift endpoints.
  - name: Health
    description: Firewall readiness and service status.
paths:
  /api/runtime-security/health:
    get:
      tags:
        - Health
      summary: Whether the firewall is on and ready to scan
      description: |
        Requires the `runtime:events:read` permission. The response carries
        further fields for operators; only `enabled` and `status` are part of
        the supported contract.
      operationId: getHealth
      responses:
        '200':
          description: Health status
          content:
            application/json:
              schema:
                type: object
                properties:
                  enabled:
                    type: boolean
                  status:
                    type: string
                    enum:
                      - ready
                      - degraded
                      - disabled
              example:
                enabled: true
                status: ready
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotEnabled'
components:
  responses:
    Unauthorized:
      description: The API key is missing, invalid, expired or disabled
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: string
    Forbidden:
      description: >-
        The key does not have the permission this endpoint needs, or its owner
        no longer holds it
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: string
    NotEnabled:
      description: >-
        Runtime Security (or the module this endpoint belongs to) is not enabled
        for the workspace
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: |
        Blindsight API key (`ak_...`). The permissions it needs are listed in
        the API description and on each operation: `runtime:scan` for scan and
        proxy routes, `runtime:events:read` for events, analytics, drift,
        health and service status, `runtime:config:read` to read the
        configuration and `runtime:config:write` to change it.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.