API Reference — ImageIntegrationService

naftiko: 1.0.0-alpha2
info:
  label: API Reference — ImageIntegrationService
  description: 'API Reference — ImageIntegrationService. 6 operations. Lead operation: GetImageIntegrations returns all image
    integrations.. Self-contained Naftiko capability covering one Stackrox business surface.'
  tags:
  - Stackrox
  - ImageIntegrationService
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STACKROX_API_KEY: STACKROX_API_KEY
capability:
  consumes:
  - type: http
    namespace: stackrox-imageintegrationservice
    baseUri: https://{central-host}
    description: API Reference — ImageIntegrationService business capability. Self-contained, no shared references.
    resources:
    - name: v1-imageintegrations
      path: /v1/imageintegrations
      operations:
      - name: getimageintegrations
        method: GET
        description: GetImageIntegrations returns all image integrations.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: query
          type: string
        - name: cluster
          in: query
          type: string
      - name: postimageintegration
        method: POST
        description: PostImageIntegration creates a image integraton.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-imageintegrations-test
      path: /v1/imageintegrations/test
      operations:
      - name: testimageintegration
        method: POST
        description: TestImageIntegration checks if the given image integration is correctly configured.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-imageintegrations-id
      path: /v1/imageintegrations/{id}
      operations:
      - name: getimageintegration
        method: GET
        description: GetImageIntegration returns the image integration given its ID.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: deleteimageintegration
        method: DELETE
        description: DeleteImageIntegration removes a image integration given its ID.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: putimageintegration
        method: PUT
        description: PutImageIntegration modifies a given image integration.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.STACKROX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: stackrox-imageintegrationservice-rest
    port: 8080
    description: REST adapter for API Reference — ImageIntegrationService. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/imageintegrations
      name: v1-imageintegrations
      description: REST surface for v1-imageintegrations.
      operations:
      - method: GET
        name: getimageintegrations
        description: GetImageIntegrations returns all image integrations.
        call: stackrox-imageintegrationservice.getimageintegrations
        with:
          name: rest.name
          cluster: rest.cluster
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postimageintegration
        description: PostImageIntegration creates a image integraton.
        call: stackrox-imageintegrationservice.postimageintegration
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/imageintegrations/test
      name: v1-imageintegrations-test
      description: REST surface for v1-imageintegrations-test.
      operations:
      - method: POST
        name: testimageintegration
        description: TestImageIntegration checks if the given image integration is correctly configured.
        call: stackrox-imageintegrationservice.testimageintegration
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/imageintegrations/{id}
      name: v1-imageintegrations-id
      description: REST surface for v1-imageintegrations-id.
      operations:
      - method: GET
        name: getimageintegration
        description: GetImageIntegration returns the image integration given its ID.
        call: stackrox-imageintegrationservice.getimageintegration
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteimageintegration
        description: DeleteImageIntegration removes a image integration given its ID.
        call: stackrox-imageintegrationservice.deleteimageintegration
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putimageintegration
        description: PutImageIntegration modifies a given image integration.
        call: stackrox-imageintegrationservice.putimageintegration
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: stackrox-imageintegrationservice-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — ImageIntegrationService. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: getimageintegrations-returns-all-image-integrations
      description: GetImageIntegrations returns all image integrations.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-imageintegrationservice.getimageintegrations
      with:
        name: tools.name
        cluster: tools.cluster
      outputParameters:
      - type: object
        mapping: $.
    - name: postimageintegration-creates-image-integraton
      description: PostImageIntegration creates a image integraton.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: stackrox-imageintegrationservice.postimageintegration
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: testimageintegration-checks-if-given-image
      description: TestImageIntegration checks if the given image integration is correctly configured.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: stackrox-imageintegrationservice.testimageintegration
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: getimageintegration-returns-image-integration-given
      description: GetImageIntegration returns the image integration given its ID.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-imageintegrationservice.getimageintegration
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: deleteimageintegration-removes-image-integration-given
      description: DeleteImageIntegration removes a image integration given its ID.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: stackrox-imageintegrationservice.deleteimageintegration
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: putimageintegration-modifies-given-image-integration
      description: PutImageIntegration modifies a given image integration.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: stackrox-imageintegrationservice.putimageintegration
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.