> ## 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 a container image

> Image metadata with its registry, latest scan, layers, and image configuration from the latest completed scan.



## OpenAPI

````yaml /openapi.json get /containers/images/{imageId}
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.
  - 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:
  /containers/images/{imageId}:
    get:
      tags:
        - Containers
      summary: Get a container image
      description: >-
        Image metadata with its registry, latest scan, layers, and image
        configuration from the latest completed scan.
      operationId: getContainerImage
      parameters:
        - name: imageId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            UUID of the container image. Use the `id` field of an image from
            `listContainerImages`.
      responses:
        '200':
          description: Image detail.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContainerImageDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - BearerAuth:
            - containers:read
components:
  schemas:
    ContainerImageDetail:
      type: object
      properties:
        image:
          $ref: '#/components/schemas/ContainerImage'
        registry:
          $ref: '#/components/schemas/ContainerRegistry'
        latest_scan:
          oneOf:
            - $ref: '#/components/schemas/ContainerImageSnapshot'
            - type: 'null'
        layers:
          type: array
          items:
            $ref: '#/components/schemas/ContainerImageLayer'
        image_config:
          oneOf:
            - $ref: '#/components/schemas/ContainerImageConfig'
            - type: 'null'
        finding_count:
          type: integer
          description: >-
            Number of open findings on the image. Fixed and ignored findings are
            not counted.
        component_count:
          type: integer
      required:
        - image
        - registry
        - latest_scan
        - layers
        - image_config
        - finding_count
        - component_count
    ContainerImage:
      type: object
      properties:
        id:
          type: string
          format: uuid
        registry_id:
          type: string
          format: uuid
        name:
          type: string
          description: Image name without the registry host, for example `acme/api`.
        latest_tag:
          type:
            - string
            - 'null'
          description: >-
            Tag that the latest scan resolved. Tags are labels. Digests are
            identity.
        latest_digest:
          type:
            - string
            - 'null'
          description: Manifest digest that the latest scan resolved.
        platform:
          type: string
          description: >-
            Platform selected when the image was added, for example
            `linux/amd64`. A scan request without a platform uses this platform.
        linked_repository_id:
          type:
            - string
            - 'null'
          format: uuid
        linked_repository_name:
          type:
            - string
            - 'null'
        last_scan_at:
          type:
            - string
            - 'null'
          format: date-time
        last_scan_status:
          oneOf:
            - $ref: '#/components/schemas/ContainerScanStatus'
            - type: 'null'
        findings:
          $ref: '#/components/schemas/ContainerSeverityCounts'
        reachable_count:
          type: integer
          description: >-
            Open vulnerabilities that the exploitability pass marked as
            reachable.
        secret_count:
          type: integer
        misconfiguration_count:
          type: integer
        deployed:
          type: boolean
          description: True when a deployment integration reports this image as running.
        watch_tags:
          type:
            - string
            - 'null'
          description: >-
            Glob pattern of tags that Strix rescans when they change. Null when
            no pattern is set.
      required:
        - id
        - registry_id
        - name
        - latest_tag
        - latest_digest
        - platform
        - linked_repository_id
        - linked_repository_name
        - last_scan_at
        - last_scan_status
        - findings
        - reachable_count
        - secret_count
        - misconfiguration_count
        - deployed
        - watch_tags
      description: A tracked container image with counts from its latest completed scan.
    ContainerRegistry:
      type: object
      properties:
        id:
          type: string
          format: uuid
        provider:
          $ref: '#/components/schemas/ContainerRegistryProvider'
        label:
          type: string
          description: Display label, for example `ghcr.io/acme`.
        registry_url:
          type: string
          description: Registry host, for example `ghcr.io`.
        auth_kind:
          $ref: '#/components/schemas/ContainerRegistryAuthKind'
        status:
          $ref: '#/components/schemas/ContainerRegistryStatus'
        image_count:
          type: integer
          description: Number of images that Strix tracks in this registry.
        last_verified_at:
          type:
            - string
            - 'null'
          format: date-time
        verification_error:
          type:
            - string
            - 'null'
          description: >-
            Reason the last verification failed. Null when the registry is
            connected.
      required:
        - id
        - provider
        - label
        - registry_url
        - auth_kind
        - status
        - image_count
        - last_verified_at
        - verification_error
      description: >-
        A connected container registry. The response never contains the stored
        credential.
    ContainerImageSnapshot:
      type: object
      description: >-
        One scan of a container image and the inventory that the scan recorded:
        resolved digest, platform, layers, image configuration, base image, and
        finding counts.
      properties:
        id:
          type: string
          format: uuid
        image_id:
          type: string
          format: uuid
        requested_reference:
          type: string
          description: >-
            Reference that the caller asked Strix to scan, for example
            `acme/api:1.4.2`.
        resolved_digest:
          type: string
        platform:
          type: string
          description: OCI platform, for example `linux/amd64`.
        status:
          $ref: '#/components/schemas/ContainerScanStatus'
        trigger:
          $ref: '#/components/schemas/ContainerScanTrigger'
        started_at:
          type: string
          format: date-time
        finished_at:
          type:
            - string
            - 'null'
          format: date-time
        inventory_complete:
          type: boolean
          description: True when the scan produced a complete package inventory.
        stop_reason:
          type:
            - string
            - 'null'
          enum:
            - budget_exceeded
            - rate_limited
            - null
          description: >-
            Set when the run ended before the agent finished its analysis.
            Findings filed before the stop are kept, and the scan does not mark
            any finding as fixed.
        warnings:
          type: array
          items:
            type: string
        error:
          type:
            - string
            - 'null'
          description: Failure reason. Null unless `status` is `failed`.
        size_bytes:
          type: integer
        layer_count:
          type: integer
        component_count:
          type: integer
        findings:
          $ref: '#/components/schemas/ContainerSeverityCounts'
        engine:
          type: object
          properties:
            name:
              type: string
            version:
              type: string
            db_updated_at:
              type: string
          required:
            - name
            - version
            - db_updated_at
        base_image:
          type:
            - object
            - 'null'
          properties:
            reference:
              type: string
            outdated:
              type: boolean
            latest_tag:
              type:
                - string
                - 'null'
          required:
            - reference
            - outdated
            - latest_tag
        agent_scan_id:
          type:
            - string
            - 'null'
          description: >-
            UUID of the Strix scan that ran the exploitability pass. Use it with
            the Scans endpoints.
      required:
        - id
        - image_id
        - requested_reference
        - resolved_digest
        - platform
        - status
        - trigger
        - started_at
        - finished_at
        - inventory_complete
        - stop_reason
        - warnings
        - error
        - size_bytes
        - layer_count
        - component_count
        - findings
        - engine
        - base_image
        - agent_scan_id
    ContainerImageLayer:
      type: object
      properties:
        digest:
          type: string
        size_bytes:
          type: integer
        created_by:
          type: string
          description: Dockerfile instruction that created the layer.
        from_base_image:
          type: boolean
          description: True for layers inherited from the `FROM` image.
        is_empty:
          type: boolean
        finding_count:
          type: integer
      required:
        - digest
        - size_bytes
        - created_by
        - from_base_image
        - is_empty
        - finding_count
    ContainerImageConfig:
      type: object
      properties:
        user:
          type:
            - string
            - 'null'
        entrypoint:
          type: array
          items:
            type: string
        cmd:
          type: array
          items:
            type: string
        exposed_ports:
          type: array
          items:
            type: string
        env_keys:
          type: array
          items:
            type: string
          description: Environment variable names only. Strix does not store the values.
        labels:
          type: object
          additionalProperties:
            type: string
        working_dir:
          type:
            - string
            - 'null'
      required:
        - user
        - entrypoint
        - cmd
        - exposed_ports
        - env_keys
        - labels
        - working_dir
    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
    ContainerScanStatus:
      type: string
      enum:
        - queued
        - running
        - completed
        - failed
    ContainerSeverityCounts:
      type: object
      properties:
        critical:
          type: integer
        high:
          type: integer
        medium:
          type: integer
        low:
          type: integer
        total:
          type: integer
      required:
        - critical
        - high
        - medium
        - low
        - total
    ContainerRegistryProvider:
      type: string
      enum:
        - ghcr
        - dockerhub
        - ecr
        - generic
    ContainerRegistryAuthKind:
      type: string
      enum:
        - basic_token
        - aws_assume_role
        - none
    ContainerRegistryStatus:
      type: string
      enum:
        - connected
        - disconnected
        - verifying
    ContainerScanTrigger:
      type: string
      enum:
        - manual
        - schedule
        - api
        - registry_watch
        - ci
    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:
    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.

````