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

# Get integration settings

> Returns the settings for the Linear, Jira or Slack integration. For Linear and Jira, administrators and service tokens also receive the connected repositories and the repository routes. For Slack, returns the notification settings (default channel, severities, toggles and per-group channel routing).



## OpenAPI

````yaml /openapi.json get /integrations/{provider}/settings
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/{provider}/settings:
    get:
      tags:
        - Integrations
      summary: Get integration settings
      description: >-
        Returns the settings for the Linear, Jira or Slack integration. For
        Linear and Jira, administrators and service tokens also receive the
        connected repositories and the repository routes. For Slack, returns the
        notification settings (default channel, severities, toggles and
        per-group channel routing).
      operationId: getIntegrationSettings
      parameters:
        - name: provider
          in: path
          required: true
          description: Integration provider.
          schema:
            type: string
            enum:
              - linear
              - jira
              - slack
      responses:
        '200':
          description: Integration settings.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/TicketingIntegrationSettings'
                  - $ref: '#/components/schemas/SlackIntegrationSettings'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - BearerAuth:
            - integrations:read
components:
  schemas:
    TicketingIntegrationSettings:
      type: object
      description: Ticketing settings for a Linear or Jira integration.
      properties:
        id:
          type: string
        provider:
          type: string
          enum:
            - linear
            - jira
        status:
          type: string
        status_detail:
          type:
            - string
            - 'null'
        auto_sync_enabled:
          type: boolean
        issue_label_enabled:
          type: boolean
        issue_label_name:
          type: string
        auto_sync_min_severity:
          type: string
          enum:
            - critical
            - high
            - medium
            - low
        auto_sync_sources:
          type: array
          minItems: 1
          uniqueItems: true
          items:
            type: string
            enum:
              - scan
              - supply_chain
          description: >-
            Finding sources that auto-sync creates tickets for: `scan` (pentest
            findings) and `supply_chain` (dependency CVEs). PR-review findings
            never auto-sync. Manual, bulk, and API pushes ignore this.
        auto_sync_reachability:
          type: string
          enum:
            - all
            - reachable_only
          description: >-
            Which dependency findings auto-create tickets. `all` (the default)
            tickets every dependency finding; `reachable_only` tickets only the
            findings whose vulnerable code the scan proved runs. Pentest
            findings ignore this.
        default_collection_id:
          type:
            - string
            - 'null'
        default_collection_name:
          type:
            - string
            - 'null'
        default_ticket_type:
          type:
            - string
            - 'null'
        jira_field_values:
          type: object
          additionalProperties: true
        source_routes:
          $ref: '#/components/schemas/TicketingSourceRoutes'
        default_assignee_id:
          type:
            - string
            - 'null'
          description: >-
            Provider user ID that new tickets are assigned to. Linear: user ID.
            Jira Cloud: `accountId`. Jira Server: username. `null` leaves
            tickets unassigned.
        default_assignee_name:
          type:
            - string
            - 'null'
          description: Display name of the default assignee.
        title_template:
          type:
            - string
            - 'null'
          description: >-
            Template for the ticket title. Placeholders use `{{name}}`: `title`,
            `severity`, `cve`, `cvss`, `target`, `endpoint`, `repository`,
            `pentest`, `source`, `strix_url`, `details`. `null` means
            `{{title}}`.
        description_template:
          type:
            - string
            - 'null'
          description: >-
            Template for the ticket description. Same placeholders as
            `title_template`. `null` means `{{details}}`.
        group_by_pentest:
          type: boolean
          description: >-
            When true, Strix creates one grouping object per pentest and files
            its tickets under it: a Linear project in the destination team, or a
            Jira Epic in the destination project.
        jira_priority_map:
          type:
            - object
            - 'null'
          description: >-
            Jira only: maps each severity (`critical`, `high`, `medium`, `low`)
            to a Jira priority `{ id, name }` or `null` (Jira's default). `null`
            disables the mapping; Linear priority always follows severity.
        due_date_days:
          type:
            - object
            - 'null'
          description: >-
            Maps each severity to a whole number of days (1-365) after ticket
            creation for the due date, or `null` (no due date). `null` disables.
            Applies to Linear and Jira; a snooze date always wins.
        repositories:
          type: array
          description: >-
            Connected repositories that a repository route can target. Present
            for administrators and service tokens.
          items:
            type: object
            properties:
              id:
                type: string
                description: Repository identifier.
              full_name:
                type: string
                description: Repository full name, for example `acme/api`.
              provider:
                type: string
                description: Source control provider.
            required:
              - id
              - full_name
              - provider
        repository_routes:
          type: array
          description: >-
            Ticket destination for each routed repository. Present for
            administrators and service tokens.
          items:
            $ref: '#/components/schemas/TicketingRepositoryRoute'
        created_at:
          type:
            - string
            - 'null'
          format: date-time
      required:
        - id
        - provider
        - status
        - status_detail
        - auto_sync_enabled
        - issue_label_enabled
        - issue_label_name
        - auto_sync_min_severity
        - auto_sync_sources
        - auto_sync_reachability
        - default_collection_id
        - default_collection_name
        - default_ticket_type
        - jira_field_values
        - created_at
    SlackIntegrationSettings:
      type: object
      description: Slack notification settings for the organization.
      properties:
        slack_default_channel_id:
          type:
            - string
            - 'null'
          description: Channel that receives every notification without a group override.
        slack_channel_groups:
          type: object
          description: >-
            Slack channel id per notification group. Missing groups post to
            `slack_default_channel_id`.
          properties:
            pentests:
              type: string
              description: Pentest started, pentest completed and new pentest findings.
            supply_chain:
              type: string
              description: Dependency findings and malicious package alerts.
            containers:
              type: string
              description: Container scan completed and container findings.
            deadlines:
              type: string
              description: Remediation deadline digest.
            pr_reviews:
              type:
                - string
                - 'null'
              description: PR reviews that finish with findings or fail.
          additionalProperties: false
        slack_notify_severities:
          type: array
          items:
            type: string
            enum:
              - critical
              - high
              - medium
              - low
          description: Severities that post new findings.
        slack_notify_scan_started:
          type: boolean
          description: Post when a pentest or container scan starts.
        slack_notify_scan_complete:
          type: boolean
          description: Post when a pentest or container scan finishes.
        slack_notify_status_change:
          type: boolean
          description: Post in the finding thread when an issue changes status.
        slack_notify_dependency_findings:
          type: boolean
          description: Also post new dependency findings at the selected severities.
        slack_notify_supply_chain_malicious:
          type: boolean
          description: >-
            Post malicious package alerts. Only returned for organizations with
            supply chain access.
        slack_notify_pr_review_findings:
          type: boolean
          description: Notify Slack when a PR review finishes with findings.
        slack_notify_pr_review_failures:
          type: boolean
          description: Notify Slack when a PR review fails.
      required:
        - slack_default_channel_id
        - slack_channel_groups
        - slack_notify_severities
        - slack_notify_scan_started
        - slack_notify_scan_complete
        - slack_notify_status_change
        - slack_notify_dependency_findings
    TicketingSourceRoutes:
      type: object
      description: >-
        The destination for each finding source, keyed by `scan` (pentests),
        `pr_review`, and `supply_chain`. Applies to Linear and Jira. If a key is
        missing, Strix uses the default destination for that source. A
        repository route has priority over a source route.
      properties:
        scan:
          $ref: '#/components/schemas/TicketingSourceRoute'
        pr_review:
          $ref: '#/components/schemas/TicketingSourceRoute'
        supply_chain:
          $ref: '#/components/schemas/TicketingSourceRoute'
      additionalProperties: false
    TicketingRepositoryRoute:
      type: object
      description: >-
        Destination for findings from one repository. A repository route has
        priority over a source route.
      allOf:
        - $ref: '#/components/schemas/TicketingSourceRoute'
        - type: object
          properties:
            repository_id:
              type: string
              description: Repository identifier.
            project_id:
              type: string
              description: Same value as `collection_id`. Deprecated, read `collection_id`.
              deprecated: true
            project_name:
              type:
                - string
                - 'null'
              description: >-
                Same value as `collection_name`. Deprecated, read
                `collection_name`.
              deprecated: true
          required:
            - repository_id
    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
    TicketingSourceRoute:
      type: object
      description: >-
        Destination that receives tickets for one routing rule. For Linear, the
        destination is a team or a project. For Jira, the destination is a
        project with an optional issue type and required field values.
      properties:
        collection_id:
          type: string
          description: Linear team or project identifier, or Jira project identifier.
        collection_name:
          type:
            - string
            - 'null'
          description: Destination name.
        ticket_type:
          type:
            - string
            - 'null'
          description: >-
            Jira issue type for this rule. If null, Strix uses the project
            default. Always null for Linear.
        jira_field_values:
          type: object
          additionalProperties: true
          description: >-
            Jira required field values for this rule, keyed by field. Each value
            is `{ value, label }`. Always empty for Linear.
      required:
        - collection_id
    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'
    NotFound:
      description: Resource not found.
      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.