> ## 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 license status

> License state for self-hosted installs: whether licensing is enforced, the current state (unlicensed/valid/expired/grace_exceeded/invalid), signed entitlements (seat, domain, repo, developer, pentest, and concurrency limits plus feature flags), expiry, and install-wide aggregate usage counts. Licenses are verified offline from a signed token, so there is no sync (last_synced_at is always null). On SaaS this always reports enforced=false. Requires the license:read scope. Personal tokens must belong to an org admin (service tokens are admin-issued and exempt).



## OpenAPI

````yaml /openapi.json get /license
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.
  - 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.
paths:
  /license:
    get:
      tags:
        - License
      summary: Get license status
      description: >-
        License state for self-hosted installs: whether licensing is enforced,
        the current state (unlicensed/valid/expired/grace_exceeded/invalid),
        signed entitlements (seat, domain, repo, developer, pentest, and
        concurrency limits plus feature flags), expiry, and install-wide
        aggregate usage counts. Licenses are verified offline from a signed
        token, so there is no sync (last_synced_at is always null). On SaaS this
        always reports enforced=false. Requires the license:read scope. Personal
        tokens must belong to an org admin (service tokens are admin-issued and
        exempt).
      operationId: getLicenseStatus
      responses:
        '200':
          description: License status
          content:
            application/json:
              schema:
                type: object
                properties:
                  enforced:
                    type: boolean
                  state:
                    type: string
                    enum:
                      - unlicensed
                      - valid
                      - expired
                      - grace_exceeded
                      - invalid
                  customer_name:
                    type:
                      - string
                      - 'null'
                  license_type:
                    type:
                      - string
                      - 'null'
                  expires_at:
                    type:
                      - string
                      - 'null'
                    description: ISO date. A null value means the license never expires
                  last_synced_at:
                    type:
                      - string
                      - 'null'
                    description: 'Always null: licenses are verified offline, nothing syncs'
                  entitlements:
                    type:
                      - object
                      - 'null'
                    properties:
                      max_dashboard_users:
                        type: integer
                        description: 0 = unlimited
                      max_domains:
                        type: integer
                      max_repos:
                        type: integer
                      max_developers:
                        type: integer
                      max_pentests_per_month:
                        type: integer
                      max_concurrent_scans:
                        type: integer
                      pr_reviews_enabled:
                        type: boolean
                      on_demand_pentests_enabled:
                        type: boolean
                      chat_enabled:
                        type: boolean
                  usage:
                    type:
                      - object
                      - 'null'
                    properties:
                      domains:
                        type: integer
                      repositories:
                        type: integer
                      pentests_this_month:
                        type: integer
                      running_scans:
                        type: integer
                      active_developers_this_month:
                        type: integer
                      pr_reviews_this_month:
                        type: integer
                      chats_this_month:
                        type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      security:
        - BearerAuth:
            - license:read
components:
  responses:
    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 and the `required_scope` field, so a client
        can request the correct scope and retry.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    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.
      required:
        - detail
    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
        - license:read
        - supply_chain:read
        - supply_chain:write
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        API token obtained from the Tokens endpoint. Include as `Authorization:
        Bearer <token>`.

````