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

> Register one or more repository assets for the authenticated organization.



## OpenAPI

````yaml /openapi.json post /repositories
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:
  /repositories:
    post:
      tags:
        - Assets
      summary: Add repositories
      description: >-
        Register one or more repository assets for the authenticated
        organization.
      operationId: createRepositories
      requestBody:
        required: true
        content:
          application/json:
            schema:
              description: >-
                One repository object, or an array of repository objects to add
                in one request.
              oneOf:
                - $ref: '#/components/schemas/CreateRepositoryRequest'
                - type: array
                  items:
                    $ref: '#/components/schemas/CreateRepositoryRequest'
      responses:
        '201':
          description: Repositories added.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepositoriesCreateResponse'
        '207':
          description: >-
            Repositories added, but Azure DevOps service-hook setup is
            incomplete for one or more of them. The repository is registered;
            its automatic pull request and push events do not arrive until setup
            is retried (reconnect the Azure connection). Details are in
            `azure_hook_setup`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepositoriesCreateResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - BearerAuth:
            - assets:write
components:
  schemas:
    CreateRepositoryRequest:
      type: object
      properties:
        full_name:
          type: string
        provider:
          type: string
          default: github
        installation_id:
          type:
            - integer
            - '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:
        - full_name
    RepositoriesCreateResponse:
      type: object
      properties:
        repositories:
          type: array
          items:
            $ref: '#/components/schemas/RepositoryAsset'
        azure_hook_setup:
          type: array
          description: >-
            Azure DevOps repositories whose service-hook setup did not complete;
            present only on 207 responses.
          items:
            type: object
            properties:
              repository:
                type: string
                description: Repository full name (org/project/repo).
              status:
                type: string
                enum:
                  - pending
                  - failed
                description: >-
                  'pending' when setup is waiting on configuration (for example
                  no HTTPS webhook address); 'failed' when provisioning errored.
              detail:
                type: string
            required:
              - repository
              - status
              - detail
      required:
        - repositories
    RepositoryAsset:
      type: object
      description: >-
        Repository metadata stored by Strix. Branch selection belongs to
        individual scans, schedules, and PR reviews; this object does not
        resolve a provider URL or default branch.
      properties:
        id:
          type: string
          format: uuid
        organization_id:
          type: string
        full_name:
          type: string
        provider:
          type: string
        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.
        pr_review_enabled:
          type: boolean
          description: Whether automated PR reviews are enabled for this repository.
        pr_review_approvals_enabled:
          type:
            - boolean
            - 'null'
          description: >-
            Tri-state per-repo override of the org PR review policy. true forces
            Strix to submit a GitHub approval on clean PRs for this repo, false
            forces it off, null inherits the org default (approve_clean_prs).
        pr_review_non_blocking:
          type:
            - boolean
            - 'null'
          description: >-
            Tri-state per-repo override of the org PR review policy. true forces
            findings to never block this repo's PRs (posted as comments only),
            false forces blocking on, null inherits the org default
            (block_on_findings).
        pr_review_on_push:
          type:
            - boolean
            - 'null'
          description: >-
            Tri-state per-repo override of the org PR review policy. true forces
            Strix to re-review this repo's PRs on every pushed commit, false
            forces it off (review only when the PR is opened), null inherits the
            org default (review_on_push).
        created_at:
          type: string
          format: date-time
        last_scan_at:
          type:
            - string
            - 'null'
          format: date-time
        last_scan_status:
          type:
            - string
            - 'null'
          description: >-
            Status of the newest scan that targets this repository (pending,
            running, completed, failed, cancelled).
        supply_chain_enabled:
          type: boolean
          description: Whether supply chain monitoring is enabled for this repository.
        supply_chain_pr_checks_enabled:
          type: boolean
          description: Whether supply chain checks run on this repository's pull requests.
        supply_chain_policy_mode:
          type: string
          enum:
            - monitor
            - comment
            - block
          description: How supply chain findings are reported on pull requests.
        supply_chain_snapshot_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When the current default-branch SBOM snapshot was taken. Null when
            no inventory exists.
        open_issue_count:
          type: integer
          description: >-
            The number of active findings (open, in_progress, snoozed) that are
            attributed to this asset. Dependency findings are not counted.
        open_issues:
          allOf:
            - $ref: '#/components/schemas/ScanFindings'
          description: The same active findings as open_issue_count, grouped by severity.
      required:
        - id
        - organization_id
        - full_name
        - created_at
    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
    ScanFindings:
      type: object
      properties:
        total:
          type: integer
        critical:
          type: integer
        high:
          type: integer
        medium:
          type: integer
        low:
          type: integer
      required:
        - total
        - critical
        - high
        - medium
        - low
    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'
    Forbidden:
      description: >-
        Insufficient permissions or missing scope. A missing scope returns the
        `insufficient_scope` code, the `required_scope` field, and a `hint` with
        the command or page that grants the scope, so a client can request the
        correct scope and retry.
      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.