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

# Connect or update a compliance platform

> Creates or updates the connection. For Vanta, create a private *Build Integrations* app in the Vanta Developer Console, add the four Strix resources, and send the app's client ID, client secret and resource IDs. Credentials are verified with a token request before they are stored. Administrators only.



## OpenAPI

````yaml /openapi.json put /integrations/grc/{provider}
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:
  /integrations/grc/{provider}:
    put:
      tags:
        - Integrations
      summary: Connect or update a compliance platform
      description: >-
        Creates or updates the connection. For Vanta, create a private *Build
        Integrations* app in the Vanta Developer Console, add the four Strix
        resources, and send the app's client ID, client secret and resource IDs.
        Credentials are verified with a token request before they are stored.
        Administrators only.
      operationId: saveGrcConnection
      parameters:
        - name: provider
          in: path
          required: true
          description: Compliance (GRC) platform. `vanta` is the only provider today.
          schema:
            type: string
            enum:
              - vanta
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GrcConnectionInput'
      responses:
        '200':
          description: Updated connection status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrcConnectionStatus'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          description: The provider rejected the credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - BearerAuth:
            - integrations:write
components:
  schemas:
    GrcConnectionInput:
      type: object
      description: >-
        Fields to create or update. Omit `client_secret` to keep the stored
        secret. Credentials are checked against the provider before they are
        saved.
      properties:
        region:
          description: Vanta API region of the tenant.
          type: string
          enum:
            - us
            - eu
            - aus
            - gov
        client_id:
          description: OAuth client ID of the private Vanta app.
          type: string
        client_secret:
          type: string
          description: Write-only. Stored encrypted.
        resource_ids:
          type: object
          additionalProperties:
            type:
              - string
              - 'null'
          description: >-
            Keys: component, endpoint_vulnerability, code_vulnerability,
            package_vulnerability. Null removes an ID.
        evidence_document_id:
          description: >-
            Vanta document that receives the compliance report PDF. Null
            disables evidence upload.
          type:
            - string
            - 'null'
        sync_enabled:
          description: Whether Strix pushes findings automatically.
          type: boolean
        dependency_reachable_only:
          description: >-
            Export only dependency CVEs whose vulnerable code Strix found
            reachable. Default true.
          type: boolean
        finding_types:
          description: Finding types to include in the sync.
          type: array
          items:
            type: string
            enum:
              - live_pentest
              - code
              - dependency
    GrcConnectionStatus:
      type: object
      required:
        - provider
        - display_name
        - connected
        - connection
      properties:
        provider:
          type: string
          enum:
            - vanta
        display_name:
          type: string
        connected:
          type: boolean
        oauth_available:
          type: boolean
          description: >-
            Whether the organization can connect through the Strix marketplace
            app (OAuth) instead of a private app. Marketplace connections are
            made from the dashboard.
        connection:
          oneOf:
            - $ref: '#/components/schemas/GrcConnection'
            - type: 'null'
    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
    GrcConnection:
      type: object
      description: A connection to a compliance platform. Secrets are never returned.
      required:
        - provider
        - auth_mode
        - region
        - client_id
        - resource_ids
        - evidence_document_id
        - sync_enabled
        - finding_types
        - connected_at
        - last_sync_at
        - last_sync_status
        - last_sync_error
        - sync_in_progress
        - sync_requested
        - missing_resource_ids
      properties:
        provider:
          type: string
          enum:
            - vanta
        auth_mode:
          type: string
          enum:
            - client_credentials
            - oauth
        region:
          type: string
          enum:
            - us
            - eu
            - aus
            - gov
          description: Vanta API region.
        client_id:
          type:
            - string
            - 'null'
          description: OAuth client ID of the private Vanta app.
        resource_ids:
          type: object
          description: Vanta resource IDs by kind, from the app's Resources tab.
          properties:
            component:
              type: string
            endpoint_vulnerability:
              type: string
            code_vulnerability:
              type: string
            package_vulnerability:
              type: string
        evidence_document_id:
          type:
            - string
            - 'null'
          description: >-
            Vanta document that receives the compliance report PDF after each
            sync. Null disables evidence upload.
        sync_enabled:
          type: boolean
        dependency_reachable_only:
          description: >-
            Export only dependency CVEs whose vulnerable code Strix found
            reachable. Default true.
          type: boolean
        finding_types:
          type: array
          items:
            type: string
            enum:
              - live_pentest
              - code
              - dependency
          description: Finding types included in the sync.
        connected_at:
          type: string
          format: date-time
        last_sync_at:
          type:
            - string
            - 'null'
          format: date-time
        last_sync_status:
          type:
            - string
            - 'null'
          enum:
            - succeeded
            - failed
            - running
            - null
        last_sync_error:
          type:
            - string
            - 'null'
        sync_in_progress:
          type: boolean
        sync_requested:
          type: boolean
          description: A sync is queued for the next scheduler tick.
        missing_resource_ids:
          type: array
          items:
            type: string
          description: Resource kinds that still need an ID before a sync can run.
    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.