API Reference — ImageService

naftiko: 1.0.0-alpha2
info:
  label: API Reference — ImageService
  description: 'API Reference — ImageService. 6 operations. Lead operation: ListImages returns all the images.. Self-contained
    Naftiko capability covering one Stackrox business surface.'
  tags:
  - Stackrox
  - ImageService
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STACKROX_API_KEY: STACKROX_API_KEY
capability:
  consumes:
  - type: http
    namespace: stackrox-imageservice
    baseUri: https://{central-host}
    description: API Reference — ImageService business capability. Self-contained, no shared references.
    resources:
    - name: v1-images
      path: /v1/images
      operations:
      - name: listimages
        method: GET
        description: ListImages returns all the images.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
        - name: pagination.limit
          in: query
          type: integer
        - name: pagination.offset
          in: query
          type: integer
        - name: pagination.sort_option.field
          in: query
          type: string
        - name: pagination.sort_option.reversed
          in: query
          type: boolean
      - name: deleteimages
        method: DELETE
        description: DeleteImage removes the images based on a query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query.query
          in: query
          type: string
        - name: query.pagination.limit
          in: query
          type: integer
        - name: query.pagination.offset
          in: query
          type: integer
        - name: query.pagination.sort_option.field
          in: query
          type: string
        - name: query.pagination.sort_option.reversed
          in: query
          type: boolean
        - name: confirm
          in: query
          type: boolean
    - name: v1-images-cache-invalidate
      path: /v1/images/cache/invalidate
      operations:
      - name: invalidatescanandregistrycaches
        method: GET
        description: InvalidateScanAndRegistryCaches removes the image metadata cache.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-images-scan
      path: /v1/images/scan
      operations:
      - name: scanimage
        method: POST
        description: ScanImage scans a single image and returns the result
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-images-id
      path: /v1/images/{id}
      operations:
      - name: getimage
        method: GET
        description: GetImage returns the image given its ID.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    - name: v1-imagescount
      path: /v1/imagescount
      operations:
      - name: countimages
        method: GET
        description: ListImages returns all the images.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
        - name: pagination.limit
          in: query
          type: integer
        - name: pagination.offset
          in: query
          type: integer
        - name: pagination.sort_option.field
          in: query
          type: string
        - name: pagination.sort_option.reversed
          in: query
          type: boolean
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.STACKROX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: stackrox-imageservice-rest
    port: 8080
    description: REST adapter for API Reference — ImageService. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/images
      name: v1-images
      description: REST surface for v1-images.
      operations:
      - method: GET
        name: listimages
        description: ListImages returns all the images.
        call: stackrox-imageservice.listimages
        with:
          query: rest.query
          pagination.limit: rest.pagination.limit
          pagination.offset: rest.pagination.offset
          pagination.sort_option.field: rest.pagination.sort_option.field
          pagination.sort_option.reversed: rest.pagination.sort_option.reversed
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteimages
        description: DeleteImage removes the images based on a query
        call: stackrox-imageservice.deleteimages
        with:
          query.query: rest.query.query
          query.pagination.limit: rest.query.pagination.limit
          query.pagination.offset: rest.query.pagination.offset
          query.pagination.sort_option.field: rest.query.pagination.sort_option.field
          query.pagination.sort_option.reversed: rest.query.pagination.sort_option.reversed
          confirm: rest.confirm
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/images/cache/invalidate
      name: v1-images-cache-invalidate
      description: REST surface for v1-images-cache-invalidate.
      operations:
      - method: GET
        name: invalidatescanandregistrycaches
        description: InvalidateScanAndRegistryCaches removes the image metadata cache.
        call: stackrox-imageservice.invalidatescanandregistrycaches
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/images/scan
      name: v1-images-scan
      description: REST surface for v1-images-scan.
      operations:
      - method: POST
        name: scanimage
        description: ScanImage scans a single image and returns the result
        call: stackrox-imageservice.scanimage
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/images/{id}
      name: v1-images-id
      description: REST surface for v1-images-id.
      operations:
      - method: GET
        name: getimage
        description: GetImage returns the image given its ID.
        call: stackrox-imageservice.getimage
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/imagescount
      name: v1-imagescount
      description: REST surface for v1-imagescount.
      operations:
      - method: GET
        name: countimages
        description: ListImages returns all the images.
        call: stackrox-imageservice.countimages
        with:
          query: rest.query
          pagination.limit: rest.pagination.limit
          pagination.offset: rest.pagination.offset
          pagination.sort_option.field: rest.pagination.sort_option.field
          pagination.sort_option.reversed: rest.pagination.sort_option.reversed
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: stackrox-imageservice-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — ImageService. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: listimages-returns-all-images
      description: ListImages returns all the images.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-imageservice.listimages
      with:
        query: tools.query
        pagination.limit: tools.pagination.limit
        pagination.offset: tools.pagination.offset
        pagination.sort_option.field: tools.pagination.sort_option.field
        pagination.sort_option.reversed: tools.pagination.sort_option.reversed
      outputParameters:
      - type: object
        mapping: $.
    - name: deleteimage-removes-images-based-query
      description: DeleteImage removes the images based on a query
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: stackrox-imageservice.deleteimages
      with:
        query.query: tools.query.query
        query.pagination.limit: tools.query.pagination.limit
        query.pagination.offset: tools.query.pagination.offset
        query.pagination.sort_option.field: tools.query.pagination.sort_option.field
        query.pagination.sort_option.reversed: tools.query.pagination.sort_option.reversed
        confirm: tools.confirm
      outputParameters:
      - type: object
        mapping: $.
    - name: invalidatescanandregistrycaches-removes-image-metadata-cache
      description: InvalidateScanAndRegistryCaches removes the image metadata cache.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-imageservice.invalidatescanandregistrycaches
      outputParameters:
      - type: object
        mapping: $.
    - name: scanimage-scans-single-image-and
      description: ScanImage scans a single image and returns the result
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: stackrox-imageservice.scanimage
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: getimage-returns-image-given-its
      description: GetImage returns the image given its ID.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-imageservice.getimage
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: listimages-returns-all-images-2
      description: ListImages returns all the images.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-imageservice.countimages
      with:
        query: tools.query
        pagination.limit: tools.pagination.limit
        pagination.offset: tools.pagination.offset
        pagination.sort_option.field: tools.pagination.sort_option.field
        pagination.sort_option.reversed: tools.pagination.sort_option.reversed
      outputParameters:
      - type: object
        mapping: $.