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

# Create a network connector

> Provisions a connector and returns a `docker run` command to start the agent inside the customer network. Requires a tier with network connectors enabled.



## OpenAPI

````yaml /openapi.json post /connectors
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:
  /connectors:
    post:
      tags:
        - Connectors
      summary: Create a network connector
      description: >-
        Provisions a connector and returns a `docker run` command to start the
        agent inside the customer network. Requires a tier with network
        connectors enabled.
      operationId: createConnector
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectorRequest'
      responses:
        '201':
          description: Connector created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateConnectorResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/TierLimitError'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - BearerAuth:
            - connectors:write
components:
  schemas:
    CreateConnectorRequest:
      type: object
      properties:
        name:
          type: string
          description: Human-readable connector name.
      required:
        - name
    CreateConnectorResponse:
      type: object
      properties:
        connector:
          $ref: '#/components/schemas/NetworkConnector'
        docker_command:
          type: string
          description: >-
            Ready-to-run `docker run` command that brings the connector online
            inside the customer network.
      required:
        - connector
        - docker_command
    NetworkConnector:
      type: object
      description: Network connector (sensitive Tailscale fields are never returned).
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        last_status:
          $ref: '#/components/schemas/ConnectorStatus'
        last_status_checked_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
      required:
        - id
        - name
        - last_status
        - created_at
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
    TierLimitErrorResponse:
      type: object
      properties:
        detail:
          type: string
        requiredTier:
          type: string
        code:
          type: string
      required:
        - detail
    ConnectorStatus:
      type: string
      enum:
        - pending
        - healthy
        - degraded
        - inactive
        - down
  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'
    TierLimitError:
      description: Plan or credit limit reached.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TierLimitErrorResponse'
    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>`.

````