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

# Images with a bill of materials

> Every image with a stored bill of materials: OS, component count, the workloads, clusters and namespaces running it, and the actionable findings the scanner attributes to it.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json get /org/security/sbom/images
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
paths:
  /org/security/sbom/images:
    get:
      tags:
        - security
      summary: Images with a bill of materials
      description: >-
        Every image with a stored bill of materials: OS, component count, the
        workloads, clusters and namespaces running it, and the actionable
        findings the scanner attributes to it.
      operationId: list_security_sbom_images
      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
        - in: query
          name: cluster_id
          required: false
          schema:
            format: uuid
            type: string
        - in: query
          name: namespace
          required: false
          schema:
            type: string
        - in: query
          name: sort
          required: false
          schema:
            default: actionable
            enum:
              - image_ref
              - components
              - workloads
              - clusters
              - actionable
              - known_exploited
              - generated_at
              - last_seen_at
            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/SecuritySbomImageListResponse'
          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:
    SecuritySbomImageListResponse:
      properties:
        result:
          items:
            $ref: '#/components/schemas/SecuritySbomImageSummary'
          type: array
        pagination:
          $ref: '#/components/schemas/SecurityPagination'
        coverage:
          $ref: '#/components/schemas/SecuritySbomCoverage'
      required:
        - result
        - pagination
        - coverage
      title: SecuritySbomImageListResponse
      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
    SecuritySbomImageSummary:
      properties:
        image_identity:
          type: string
        image_ref:
          type: string
        image_repository:
          anyOf:
            - type: string
            - type: 'null'
        image_tag:
          anyOf:
            - type: string
            - type: 'null'
        image_digest:
          anyOf:
            - type: string
            - type: 'null'
        registry:
          anyOf:
            - type: string
            - type: 'null'
        os_family:
          anyOf:
            - type: string
            - type: 'null'
        os_name:
          anyOf:
            - type: string
            - type: 'null'
        bom_format:
          anyOf:
            - type: string
            - type: 'null'
        spec_version:
          anyOf:
            - type: string
            - type: 'null'
        component_count:
          type: integer
        dependency_count:
          type: integer
        workloads:
          type: integer
        clusters:
          type: integer
        namespaces:
          items:
            type: string
          type: array
        observed:
          type: integer
        actionable:
          $ref: '#/components/schemas/SecuritySeverityCounts'
        known_exploited:
          type: integer
        generated_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
        first_seen_at:
          format: date-time
          type: string
        last_seen_at:
          format: date-time
          type: string
      required:
        - image_identity
        - image_ref
        - image_repository
        - image_tag
        - image_digest
        - registry
        - os_family
        - os_name
        - bom_format
        - spec_version
        - component_count
        - dependency_count
        - workloads
        - clusters
        - namespaces
        - observed
        - actionable
        - known_exploited
        - generated_at
        - first_seen_at
        - last_seen_at
      title: SecuritySbomImageSummary
      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
    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
    SecuritySeverityCounts:
      properties:
        critical:
          type: integer
        high:
          type: integer
        low:
          type: integer
        medium:
          type: integer
        unknown:
          type: integer
      required:
        - critical
        - high
        - medium
        - low
        - unknown
      type: object

````