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

# Read the workspace settings

> Requires the `runtime:config:read` permission. The response carries
further fields used by the console and the desktop app; only the
fields in the schema are part of the supported contract.




## OpenAPI

````yaml /api-reference/openapi-runtime-security.yaml get /api/runtime-security/config
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/config:
    get:
      tags:
        - Configuration
      summary: Read the workspace settings
      description: |
        Requires the `runtime:config:read` permission. The response carries
        further fields used by the console and the desktop app; only the
        fields in the schema are part of the supported contract.
      operationId: getConfig
      responses:
        '200':
          description: Current settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeSecurityConfig'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotEnabled'
components:
  schemas:
    RuntimeSecurityConfig:
      type: object
      properties:
        enabled:
          type: boolean
          default: true
        max_text_length:
          type: integer
          minimum: 256
          maximum: 200000
          default: 32000
          description: Characters. A scan field longer than this is refused with `413`.
        log_events:
          type: boolean
          default: true
        pre_prompt:
          type: string
          maxLength: 20000
          nullable: true
        pre_prompt_placement:
          type: string
          enum:
            - prepend
            - append
            - sandwich
          default: prepend
        agentic:
          $ref: '#/components/schemas/AgenticPolicyConfig'
        file_scanning_enabled:
          type: boolean
          default: true
          description: Scan file uploads as well as prompt text.
        file_unredactable_action:
          type: string
          enum:
            - block
            - allow
          default: block
          description: >
            What happens when a file contains personal data and its format has
            no in-file redactor.
        pseudonymize_enabled:
          type: boolean
          default: false
          description: >
            Replace detected values with reversible surrogates instead of a
            placeholder, so the reply can be restored on the way back.
        pseudonymize_labels:
          type: object
          description: Per-label overrides for which categories are pseudonymized.
        pseudonymize_retention_days:
          type: integer
          minimum: 1
          maximum: 365
          default: 30
          description: How long a surrogate stays resolvable back to its value.
        dlp_fail_mode:
          type: string
          enum:
            - open
            - closed
          default: open
          description: >
            What the endpoint agent does when it cannot inspect an AI
            destination. `closed` refuses the connection.
        dlp_fail_mode_locked:
          type: boolean
          default: false
          description: Prevents a device changing its own fail mode.
        dlp_protect_unsanctioned:
          type: boolean
          default: false
          description: |
            The posture towards AI services nobody has approved.
        dlp_host_rule_overrides:
          type: array
          description: >
            Per-host rules that override the built-in AI host list, each naming
            a host pattern, how to match it, and what to do.
          items:
            type: object
        identity_mode:
          type: string
          enum:
            - named
            - pseudonymised
            - aggregated
          default: named
          description: >-
            Whether people and devices are named, shown as codes, or shown as
            totals only.
    AgenticPolicyConfig:
      type: object
      properties:
        tool_allowlist:
          type: array
          items:
            type: string
        tool_denylist:
          type: array
          items:
            type: string
        max_arg_bytes:
          type: integer
          minimum: 256
          maximum: 1000000
          default: 32000
        allow_private_network:
          type: boolean
          default: false
  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.