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

# Update a domain header

> Requires test_users:write and access to the domain. Asset-scoped actors can manage headers only when every domain in the existing and requested scopes is accessible. Only unrestricted actors can set an empty scope for all domains. Strix encrypts values and never returns saved values. Empty or omitted values keep the saved value on update.



## OpenAPI

````yaml /openapi.json patch /domains/{domainId}/scan-headers/{headerId}
openapi: 3.1.0
info:
  title: Strix API
  version: 1.0.0
  description: >-
    Public REST API for the Strix autonomous penetration testing platform.
    Manage scans, vulnerabilities, assets, schedules, API tokens, and webhooks.
servers:
  - url: /api/v1
    description: Strix v1 API
security:
  - BearerAuth: []
tags:
  - name: Scans
    description: Launch, monitor, and manage security scans.
  - name: Vulnerabilities
    description: View and triage discovered vulnerabilities.
  - name: Assets
    description: Domains and repositories registered for scanning.
  - name: Schedules
    description: Recurring scan schedules (Pro plan).
  - name: Search
    description: Search across issues, pentests, PR reviews, chats, assets and schedules.
  - name: Tokens
    description: Manage API tokens for authentication.
  - name: Webhooks
    description: Configure webhook subscriptions for real-time event notifications.
  - name: Organization
    description: Workspace configuration for the authenticated organization.
  - name: Members
    description: Manage organization members and roles.
  - name: Invitations
    description: List and revoke organization invitations.
  - name: PR Reviews
    description: Automated security review of pull requests.
  - name: Connectors
    description: Network connectors for scanning internal/private targets.
  - name: Knowledge
    description: >-
      Organization knowledge base: documents, policies, and repo profiles that
      steer the agent.
  - name: Uploads
    description: Upload source/code/documentation archives for whitebox scans.
  - name: Integrations
    description: Third-party integrations (GitLab, Bitbucket, ticketing).
  - name: Chat
    description: Conversational agent sessions.
  - name: Analytics
    description: Aggregate dashboard analytics.
  - name: Test Users
    description: >-
      Per-domain test accounts (with optional MFA) the agent authenticates as
      during scans.
  - name: License
    description: Self-hosted license state, entitlements, and aggregate usage.
  - name: Supply Chain
    description: >-
      SBOM inventory, supply-chain findings, scans, and policy for connected
      repositories.
  - name: CLI
    description: >-
      Device authorization endpoints that let the Strix CLI and coding agents
      sign in and receive an API token.
  - name: Billing
    description: Credit balance, agent-payable top-ups, and automatic top-up settings.
  - name: Workspaces
    description: List, create, and switch workspaces.
  - name: Asset Discovery
    description: >-
      Passive reconnaissance runs that map the organization's external attack
      surface, and the discovered-asset inventory they fill.
  - name: Containers
    description: >-
      Container registries, tracked images, image scans, findings, and SBOM
      components.
  - name: Run Logs
    description: Persisted engine logs and the diagnostics bundle of a self-hosted install.
paths:
  /domains/{domainId}/scan-headers/{headerId}:
    parameters:
      - in: path
        name: domainId
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: headerId
        required: true
        schema:
          type: string
          format: uuid
    patch:
      tags:
        - Domains
      summary: Update a domain header
      description: >-
        Requires test_users:write and access to the domain. Asset-scoped actors
        can manage headers only when every domain in the existing and requested
        scopes is accessible. Only unrestricted actors can set an empty scope
        for all domains. Strix encrypts values and never returns saved values.
        Empty or omitted values keep the saved value on update.
      operationId: updateDomainScanHeader
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainScanHeaderInput'
      responses:
        '200':
          description: Header updated. Value stays hidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainScanHeader'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Forbidden
        '404':
          description: Domain or header not found
        '422':
          description: Invalid header or scope
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - BearerAuth:
            - test_users:write
components:
  schemas:
    DomainScanHeaderInput:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 128
          pattern: ^[!#$%&'*+.^_`|~0-9A-Za-z-]+$
          description: >-
            HTTP token. Host, Content-Length, hop-by-hop headers, and proxy
            authorization are not allowed.
        value:
          type: string
          maxLength: 8192
          writeOnly: true
          description: >-
            Header value. Strix encrypts the value. Creation requires a nonempty
            value. An empty or omitted value keeps the saved value on update.
        notes:
          type:
            - string
            - 'null'
          maxLength: 1000
        scope_domain_ids:
          type: array
          items:
            type: string
            format: uuid
          maxItems: 100
          description: >-
            Domains where this header applies. An empty array means all domains
            in the organization. Creation defaults to the home domain.
    DomainScanHeader:
      type: object
      required:
        - id
        - name
        - value_set
        - created_at
        - updated_at
        - domain_id
        - scope_domain_ids
        - can_manage
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        notes:
          type:
            - string
            - 'null'
        value_set:
          type: boolean
          const: true
          description: The saved value is hidden.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        scope_domain_ids:
          type: array
          items:
            type: string
            format: uuid
          maxItems: 100
          description: >-
            Domains where this header applies. An empty array means all domains
            in the organization. Creation defaults to the home domain.
        domain_id:
          type: string
          format: uuid
          description: The home domain where the header was saved.
        can_manage:
          type: boolean
          description: Whether the caller can manage every domain in this header scope.
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable explanation of the error.
        code:
          type: string
          description: >-
            Stable machine-readable error code. `insufficient_scope` means the
            token does not hold the scope that this endpoint requires.
        required_scope:
          $ref: '#/components/schemas/ApiV1Scope'
          description: >-
            Scope that the caller must add to the token. Returned with the
            `insufficient_scope` code.
        docs:
          type: string
          format: uri
          description: Documentation page that explains how to resolve the error.
        hint:
          type: string
          description: >-
            One instruction that resolves the error. For `insufficient_scope`, a
            CLI session gets the `strix cloud session scopes set full` or `strix
            cloud login --scope-profile full` command, and an API token gets the
            settings page where the user creates a token with the scope. When
            the owner's role cannot hold the scope, the hint asks for a role
            change instead.
      required:
        - detail
    ApiV1Scope:
      type: string
      enum:
        - scans:read
        - scans:write
        - vulnerabilities:read
        - vulnerabilities:write
        - dependencies:read
        - schedules:read
        - schedules:write
        - assets:read
        - assets:write
        - organizations:read
        - organizations:write
        - members:read
        - members:write
        - invitations:read
        - invitations:write
        - webhooks:read
        - webhooks:write
        - tokens:write
        - audit:read
        - pr_reviews:read
        - pr_reviews:write
        - connectors:read
        - connectors:write
        - knowledge:read
        - knowledge:write
        - uploads:write
        - integrations:read
        - integrations:write
        - chat:read
        - chat:write
        - scans:message
        - analytics:read
        - llm:read
        - llm:write
        - test_users:read
        - test_users:write
        - discovery:read
        - discovery:write
        - license:read
        - supply_chain:read
        - supply_chain:write
        - billing:read
        - billing:write
        - containers:read
        - containers:write
        - logs:read
  responses:
    BadRequest:
      description: Bad request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing or invalid API token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        API token obtained from the Tokens endpoint or CLI device login. Include
        as `Authorization: Bearer <token>`. Requests made with a managed CLI
        session also include `X-Strix-Workspace: <organization_id>` to pin a
        process to the workspace it started in; recovery endpoints report the
        current workspace after a concurrent switch.

````

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