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

# Add a domain

> Register a domain asset for the authenticated organization and return verification instructions.



## OpenAPI

````yaml /openapi.json post /domains
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: 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.
paths:
  /domains:
    post:
      tags:
        - Assets
      summary: Add a domain
      description: >-
        Register a domain asset for the authenticated organization and return
        verification instructions.
      operationId: createDomain
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDomainRequest'
      responses:
        '200':
          description: Domain already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainCreateResponse'
        '201':
          description: Domain added.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainCreateResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationError'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - BearerAuth:
            - assets:write
components:
  schemas:
    CreateDomainRequest:
      type: object
      properties:
        domain:
          type: string
        asset_type:
          $ref: '#/components/schemas/DomainAssetType'
        context:
          type:
            - string
            - 'null'
        tags:
          type: array
          items:
            type: string
          description: >-
            Enterprise asset labels for RBAC scoping. Requires the Enterprise
            plan.
        business_unit:
          type:
            - string
            - 'null'
          description: >-
            Enterprise asset label for RBAC scoping. Requires the Enterprise
            plan.
      required:
        - domain
        - asset_type
    DomainCreateResponse:
      type: object
      properties:
        domain:
          $ref: '#/components/schemas/Domain'
        status:
          type: string
          enum:
            - added
            - exists
        reachable:
          type: boolean
        verification:
          $ref: '#/components/schemas/VerificationMethods'
      required:
        - domain
        - status
        - reachable
        - verification
    DomainAssetType:
      type: string
      enum:
        - web_app
        - api
        - attack_surface
    Domain:
      type: object
      properties:
        id:
          type: string
          format: uuid
        organization_id:
          type: string
        domain:
          type: string
        verified:
          type: boolean
        tags:
          type: array
          items:
            type: string
          description: Enterprise asset labels used for RBAC scoping.
        business_unit:
          type:
            - string
            - 'null'
          description: Enterprise asset label used for RBAC scoping.
        created_at:
          type: string
          format: date-time
        last_scan_at:
          type:
            - string
            - 'null'
          format: date-time
      required:
        - id
        - organization_id
        - domain
        - verified
        - created_at
    VerificationMethods:
      type: object
      properties:
        dns:
          type: object
          properties:
            record_name:
              type: string
            record_value:
              type: string
          required:
            - record_name
            - record_value
        file:
          type: object
          properties:
            url:
              type: string
            file_content:
              type: string
          required:
            - url
            - file_content
        meta_tag:
          type: object
          properties:
            tag:
              type: string
          required:
            - tag
        hash:
          type: string
      required:
        - dns
        - file
        - meta_tag
        - hash
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
  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'
    Forbidden:
      description: Insufficient permissions or missing scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ValidationError:
      description: Request failed validation (e.g. malformed value or unsupported enum).
      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. Include as `Authorization:
        Bearer <token>`.

````