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

# Running containers and their bills of materials

> Every container the resource cache says is running on the scoped clusters, init containers included, joined to the bill of materials of its image - or marked absent when the scanner has none for it. Absent is a state to act on (SBOM generation off, a registry the scanner cannot pull from, a tag rolled since the last scan), not an empty image. Sorted absent-first by default.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json get /org/security/sbom/containers
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
paths:
  /org/security/sbom/containers:
    get:
      tags:
        - security
      summary: Running containers and their bills of materials
      description: >-
        Every container the resource cache says is running on the scoped
        clusters, init containers included, joined to the bill of materials of
        its image - or marked absent when the scanner has none for it. Absent is
        a state to act on (SBOM generation off, a registry the scanner cannot
        pull from, a tag rolled since the last scan), not an empty image. Sorted
        absent-first by default.
      operationId: list_security_sbom_containers
      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
        - description: Match image, container, pod, workload or namespace.
          in: query
          name: search
          required: false
          schema:
            type: string
        - description: One cluster; omit for every live cluster of the organisation.
          in: query
          name: cluster_id
          required: false
          schema:
            format: uuid
            type: string
        - in: query
          name: namespace
          required: false
          schema:
            type: string
        - description: >-
            Match the resolved workload, its direct owner, or 'pod' for bare
            pods; case-insensitive.
          in: query
          name: workload_kind
          required: false
          schema:
            type: string
        - description: >-
            Match the resolved workload, its direct owner, or the pod name;
            case-insensitive.
          in: query
          name: workload_name
          required: false
          schema:
            type: string
        - description: >-
            Only containers whose image has (present) or lacks (absent) a bill
            of materials.
          in: query
          name: status
          required: false
          schema:
            default: any
            enum:
              - present
              - absent
              - any
            type: string
        - in: query
          name: sort
          required: false
          schema:
            default: status
            enum:
              - status
              - image
              - container
              - pod
              - namespace
              - workload
              - cluster_name
              - components
              - 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/SecuritySbomContainerListResponse'
          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:
    SecuritySbomContainerListResponse:
      properties:
        result:
          items:
            $ref: '#/components/schemas/SecuritySbomContainerSummary'
          type: array
        pagination:
          $ref: '#/components/schemas/SecurityPagination'
        inventory:
          $ref: '#/components/schemas/SecuritySbomContainerInventory'
        coverage:
          $ref: '#/components/schemas/SecuritySbomCoverage'
      required:
        - result
        - pagination
        - inventory
        - coverage
      title: SecuritySbomContainerListResponse
      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
    SecuritySbomContainerSummary:
      properties:
        cluster_id:
          format: uuid
          type: string
        cluster_name:
          type: string
        namespace:
          type: string
        pod_name:
          type: string
        pod_uid:
          anyOf:
            - type: string
            - type: 'null'
        owner_kind:
          anyOf:
            - type: string
            - type: 'null'
        owner_name:
          anyOf:
            - type: string
            - type: 'null'
        workload_kind:
          anyOf:
            - type: string
            - type: 'null'
        workload_name:
          anyOf:
            - type: string
            - type: 'null'
        container_name:
          type: string
        container_kind:
          enum:
            - app
            - init
          type: string
        image:
          type: string
        image_digest:
          anyOf:
            - type: string
            - type: 'null'
        sbom_status:
          enum:
            - present
            - absent
          type: string
        image_identity:
          anyOf:
            - type: string
            - type: 'null'
        component_count:
          anyOf:
            - type: integer
            - type: 'null'
        os_name:
          anyOf:
            - type: string
            - type: 'null'
        generated_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
        last_seen_at:
          format: date-time
          type: string
      required:
        - cluster_id
        - cluster_name
        - namespace
        - pod_name
        - pod_uid
        - owner_kind
        - owner_name
        - workload_kind
        - workload_name
        - container_name
        - container_kind
        - image
        - image_digest
        - sbom_status
        - image_identity
        - component_count
        - os_name
        - generated_at
        - last_seen_at
      title: SecuritySbomContainerSummary
      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
    SecuritySbomContainerInventory:
      properties:
        containers:
          type: integer
        with_sbom:
          type: integer
        without_sbom:
          type: integer
        pods:
          type: integer
      required:
        - containers
        - with_sbom
        - without_sbom
        - pods
      title: SecuritySbomContainerInventory
      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

````