> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ankra.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# The fleet's software bill of materials

> Every package the scanner found in the fleet's container images, grouped by name, version and ecosystem, with how many images, workloads and clusters carry it and the findings that name that exact package and version on those images. The coverage block says how many scanned clusters publish a bill of materials; the rest have SBOM generation switched off.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json get /api/v1/org/security/sbom
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
paths:
  /api/v1/org/security/sbom:
    get:
      tags:
        - security
      summary: The fleet's software bill of materials
      description: >-
        Every package the scanner found in the fleet's container images, grouped
        by name, version and ecosystem, with how many images, workloads and
        clusters carry it and the findings that name that exact package and
        version on those images. The coverage block says how many scanned
        clusters publish a bill of materials; the rest have SBOM generation
        switched off.
      operationId: list_security_sbom_components_api_v1
      parameters:
        - in: query
          name: page
          required: false
          schema:
            default: 1
            maximum: 10000
            minimum: 1
            type: integer
        - description: Values above 100 are clamped to 100.
          in: query
          name: page_size
          required: false
          schema:
            default: 50
            minimum: 1
            type: integer
        - in: query
          name: search
          required: false
          schema:
            type: string
        - description: >-
            Ecosystem filter, repeatable (deb, apk, rpm, npm, pypi, golang,
            maven, ...).
          in: query
          name: package_type
          required: false
          schema:
            items:
              type: string
            type: array
        - in: query
          name: cluster_id
          required: false
          schema:
            format: uuid
            type: string
        - in: query
          name: namespace
          required: false
          schema:
            type: string
        - description: >-
            Only components inside one image (digest or repository:tag
            identity).
          in: query
          name: image
          required: false
          schema:
            type: string
        - description: true keeps components a finding names, false the ones nothing names.
          in: query
          name: vulnerable
          required: false
          schema:
            type: boolean
        - in: query
          name: sort
          required: false
          schema:
            default: images
            enum:
              - name
              - version
              - package_type
              - images
              - workloads
              - clusters
              - vulnerable
              - actionable
            type: string
        - in: query
          name: order
          required: false
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecuritySbomComponentListResponse'
          description: Successful response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityDetailError'
          description: Business validation error
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityPermissionDenied'
          description: Permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityDetailError'
          description: Organization-scoped resource not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    SecuritySbomComponentListResponse:
      properties:
        result:
          items:
            $ref: '#/components/schemas/SecuritySbomComponentSummary'
          type: array
        pagination:
          $ref: '#/components/schemas/SecurityPagination'
        facets:
          $ref: '#/components/schemas/SecuritySbomComponentFacets'
        coverage:
          $ref: '#/components/schemas/SecuritySbomCoverage'
      required:
        - result
        - pagination
        - facets
        - coverage
      title: SecuritySbomComponentListResponse
      type: object
    SecurityDetailError:
      properties:
        detail:
          type: string
      required:
        - detail
      type: object
    SecurityPermissionDenied:
      properties:
        detail:
          enum:
            - permission_denied
          type: string
        permission:
          type: string
        scope_type:
          type: string
      required:
        - detail
        - permission
        - scope_type
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    SecuritySbomComponentSummary:
      properties:
        name:
          type: string
        version:
          type: string
        package_type:
          type: string
        component_type:
          type: string
        purl:
          anyOf:
            - type: string
            - type: 'null'
        licenses:
          items:
            type: string
          type: array
        images:
          type: integer
        workloads:
          type: integer
        clusters:
          type: integer
        vulnerable_findings:
          type: integer
        actionable_findings:
          type: integer
        known_exploited:
          type: integer
      required:
        - name
        - version
        - package_type
        - component_type
        - purl
        - licenses
        - images
        - workloads
        - clusters
        - vulnerable_findings
        - actionable_findings
        - known_exploited
      title: SecuritySbomComponentSummary
      type: object
    SecurityPagination:
      properties:
        page:
          type: integer
        page_size:
          type: integer
        total_count:
          type: integer
        total_pages:
          type: integer
      required:
        - page
        - page_size
        - total_pages
        - total_count
      type: object
    SecuritySbomComponentFacets:
      properties:
        package_type:
          items:
            $ref: '#/components/schemas/SecurityFacetCount'
          type: array
      required:
        - package_type
      title: SecuritySbomComponentFacets
      type: object
    SecuritySbomCoverage:
      properties:
        scanned_clusters:
          type: integer
        clusters_with_sbom:
          description: >-
            Below scanned_clusters means the remaining clusters have SBOM
            generation switched off, not that they run nothing.
          type: integer
        images:
          type: integer
        components:
          type: integer
        workloads:
          type: integer
        latest_generated_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
      required:
        - scanned_clusters
        - clusters_with_sbom
        - images
        - components
        - workloads
        - latest_generated_at
      title: SecuritySbomCoverage
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    SecurityFacetCount:
      properties:
        count:
          type: integer
        value:
          type: string
      required:
        - value
        - count
      type: object

````