Palo Alto Networks Images API

openapi: 3.2.0
info:
  title: Palo Alto Networks Images API
  version: '1.0'
  description: 'Operations tagged Images across 4 of this provider''s published API definitions: palo-alto-compute-34-03-openapi-34-03-138-sh-openapi.json, palo-alto-compute-openapi-34-04-145-sh-openapi.json, palo-alto-cwpp-34-03-openapi-34-03-138-saas-openapi.json, palo-alto-cwpp-openapi-34-04-145-saas-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: PATH_TO_CONSOLE
tags:
- name: Images
  description: Images. 7 operations in this definition.
  x-description-source: desc/images/images.md
paths:
  /api/v34.03/images:
    get:
      description: 'Get Image Scan Results. GET /api/v34.03/images on the Images API. Takes 23 query parameters. Documented responses: 200.'
      parameters:
      - description: 'Offsets the result to a specific report count. Offset starts from 0.

          '
        in: query
        name: offset
        schema:
          type: integer
      - description: 'Limit is the amount to fix.

          '
        in: query
        name: limit
        schema:
          type: integer
      - description: 'Sorts the result using a key.

          '
        in: query
        name: sort
        schema:
          type: string
      - description: 'Sorts the result in reverse order.

          '
        in: query
        name: reverse
        schema:
          type: boolean
      - description: 'Filters the result based on image IDs.

          '
        in: query
        name: id
        schema:
          description: 'Filters the result based on image IDs.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on hostnames.

          '
        in: query
        name: hostname
        schema:
          description: 'Filters the result based on hostnames.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on image repository names.

          '
        in: query
        name: repository
        schema:
          description: 'Filters the result based on image repository names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on image registry names.

          '
        in: query
        name: registry
        schema:
          description: 'Filters the result based on image registry names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'List of fields to retrieve.

          '
        in: query
        name: fields
        schema:
          description: 'List of fields to retrieve.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on image names.

          '
        in: query
        name: name
        schema:
          description: 'Filters the result based on image names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Indicates whether the CVEs are mapped to a specific image layer.

          Default is false.

          '
        in: query
        name: layers
        schema:
          type: boolean
      - description: 'Indicates whether to filter the base image for vulnerabilities. Requires predefined base images that have already been scanned.

          Default is false.

          '
        in: query
        name: filterBaseImage
        schema:
          type: boolean
      - description: 'Provides the minimal image data. Information about vulnerabilities, compliance, and extended image metadata are skipped.

          Default is false.

          '
        in: query
        name: compact
        schema:
          type: boolean
      - description: 'Filters the result based on whether an image is trusted or not trusted by a trusted image policy.

          Use filters: trusted or untrusted.

          '
        in: query
        name: trustStatuses
        schema:
          description: 'Filters the result based on whether an image is trusted or not trusted by a trusted image policy.

            Use filters: trusted or untrusted.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on cluster names.

          '
        in: query
        name: clusters
        schema:
          description: 'Filters the result based on cluster names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result by compliance IDs.

          '
        in: query
        name: complianceIDs
        schema:
          description: 'Filters the result by compliance IDs.

            '
          items:
            $ref: '#/components/schemas/int'
          type: array
      - description: 'Filters the result based on applied compliance rule name.

          '
        in: query
        name: complianceRuleName
        schema:
          type: string
      - description: 'Filters the result based on whether the images are scanned by App-Embedded Defenders.

          Default is false.

          '
        in: query
        name: appEmbedded
        schema:
          type: boolean
      - description: 'Retrieves the result in the normalized form of low, medium, high, and critical based on vulnerability''s severity level.

          Default is false.

          '
        in: query
        name: normalizedSeverity
        schema:
          type: boolean
      - description: 'Indicates whether to retrieve host names that are scanned by agentless scanner.

          Default is false.

          '
        in: query
        name: agentless
        schema:
          type: boolean
      - description: 'Filters only images scanned by CSA.

          '
        in: query
        name: csa
        schema:
          type: boolean
      - description: 'Filters results by uaiID.

          '
        in: query
        name: uaiID
        schema:
          type: string
      - description: 'Filters results by issue type.

          '
        in: query
        name: issueType
        schema:
          description: IssueType is used to filter scan results by issue type
          enum:
          - - vulnerabilities
            - compliance
            - ''
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_shared.ImageScanResult'
          description: ''
        default:
          description: ''
      tags:
      - Images
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: get-images
      summary: Get Image Scan Results
      x-description-source: desc/images/get.md
  /api/v34.03/images/download:
    get:
      description: 'Download Image Scan Results. GET /api/v34.03/images/download on the Images API. Takes 23 query parameters. Documented responses: 200.'
      parameters:
      - description: 'Offsets the result to a specific report count. Offset starts from 0.

          '
        in: query
        name: offset
        schema:
          type: integer
      - description: 'Limit is the amount to fix.

          '
        in: query
        name: limit
        schema:
          type: integer
      - description: 'Sorts the result using a key.

          '
        in: query
        name: sort
        schema:
          type: string
      - description: 'Sorts the result in reverse order.

          '
        in: query
        name: reverse
        schema:
          type: boolean
      - description: 'Filters the result based on image IDs.

          '
        in: query
        name: id
        schema:
          description: 'Filters the result based on image IDs.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on hostnames.

          '
        in: query
        name: hostname
        schema:
          description: 'Filters the result based on hostnames.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on image repository names.

          '
        in: query
        name: repository
        schema:
          description: 'Filters the result based on image repository names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on image registry names.

          '
        in: query
        name: registry
        schema:
          description: 'Filters the result based on image registry names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'List of fields to retrieve.

          '
        in: query
        name: fields
        schema:
          description: 'List of fields to retrieve.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on image names.

          '
        in: query
        name: name
        schema:
          description: 'Filters the result based on image names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Indicates whether the CVEs are mapped to a specific image layer.

          Default is false.

          '
        in: query
        name: layers
        schema:
          type: boolean
      - description: 'Indicates whether to filter the base image for vulnerabilities. Requires predefined base images that have already been scanned.

          Default is false.

          '
        in: query
        name: filterBaseImage
        schema:
          type: boolean
      - description: 'Provides the minimal image data. Information about vulnerabilities, compliance, and extended image metadata are skipped.

          Default is false.

          '
        in: query
        name: compact
        schema:
          type: boolean
      - description: 'Filters the result based on whether an image is trusted or not trusted by a trusted image policy.

          Use filters: trusted or untrusted.

          '
        in: query
        name: trustStatuses
        schema:
          description: 'Filters the result based on whether an image is trusted or not trusted by a trusted image policy.

            Use filters: trusted or untrusted.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on cluster names.

          '
        in: query
        name: clusters
        schema:
          description: 'Filters the result based on cluster names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result by compliance IDs.

          '
        in: query
        name: complianceIDs
        schema:
          description: 'Filters the result by compliance IDs.

            '
          items:
            $ref: '#/components/schemas/int'
          type: array
      - description: 'Filters the result based on applied compliance rule name.

          '
        in: query
        name: complianceRuleName
        schema:
          type: string
      - description: 'Filters the result based on whether the images are scanned by App-Embedded Defenders.

          Default is false.

          '
        in: query
        name: appEmbedded
        schema:
          type: boolean
      - description: 'Retrieves the result in the normalized form of low, medium, high, and critical based on vulnerability''s severity level.

          Default is false.

          '
        in: query
        name: normalizedSeverity
        schema:
          type: boolean
      - description: 'Indicates whether to retrieve host names that are scanned by agentless scanner.

          Default is false.

          '
        in: query
        name: agentless
        schema:
          type: boolean
      - description: 'Filters only images scanned by CSA.

          '
        in: query
        name: csa
        schema:
          type: boolean
      - description: 'Filters results by uaiID.

          '
        in: query
        name: uaiID
        schema:
          type: string
      - description: 'Filters results by issue type.

          '
        in: query
        name: issueType
        schema:
          description: IssueType is used to filter scan results by issue type
          enum:
          - - vulnerabilities
            - compliance
            - ''
          type: string
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Images
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: get-images-download
      summary: Download Image Scan Results
      x-description-source: desc/images/download_get.md
  /api/v34.03/images/evaluate:
    post:
      description: 'Resolve Images. POST /api/v34.03/images/evaluate on the Images API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api.ResolveImagesReq'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ResolveImagesResp'
          description: ResolveImagesResp represents the images resolution API output
        default:
          description: ''
      tags:
      - Images
      x-prisma-cloud-target-env:
        permission: monitorCI
      operationId: post-images-evaluate
      summary: Resolve Images
      x-description-source: desc/images/evaluate_get.md
  /api/v34.03/images/names:
    get:
      description: 'Get Image Names. GET /api/v34.03/images/names on the Images API. Takes 23 query parameters. Documented responses: 200.'
      parameters:
      - description: 'Offsets the result to a specific report count. Offset starts from 0.

          '
        in: query
        name: offset
        schema:
          type: integer
      - description: 'Limit is the amount to fix.

          '
        in: query
        name: limit
        schema:
          type: integer
      - description: 'Sorts the result using a key.

          '
        in: query
        name: sort
        schema:
          type: string
      - description: 'Sorts the result in reverse order.

          '
        in: query
        name: reverse
        schema:
          type: boolean
      - description: 'Filters the result based on image IDs.

          '
        in: query
        name: id
        schema:
          description: 'Filters the result based on image IDs.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on hostnames.

          '
        in: query
        name: hostname
        schema:
          description: 'Filters the result based on hostnames.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on image repository names.

          '
        in: query
        name: repository
        schema:
          description: 'Filters the result based on image repository names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on image registry names.

          '
        in: query
        name: registry
        schema:
          description: 'Filters the result based on image registry names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'List of fields to retrieve.

          '
        in: query
        name: fields
        schema:
          description: 'List of fields to retrieve.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on image names.

          '
        in: query
        name: name
        schema:
          description: 'Filters the result based on image names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Indicates whether the CVEs are mapped to a specific image layer.

          Default is false.

          '
        in: query
        name: layers
        schema:
          type: boolean
      - description: 'Indicates whether to filter the base image for vulnerabilities. Requires predefined base images that have already been scanned.

          Default is false.

          '
        in: query
        name: filterBaseImage
        schema:
          type: boolean
      - description: 'Provides the minimal image data. Information about vulnerabilities, compliance, and extended image metadata are skipped.

          Default is false.

          '
        in: query
        name: compact
        schema:
          type: boolean
      - description: 'Filters the result based on whether an image is trusted or not trusted by a trusted image policy.

          Use filters: trusted or untrusted.

          '
        in: query
        name: trustStatuses
        schema:
          description: 'Filters the result based on whether an image is trusted or not trusted by a trusted image policy.

            Use filters: trusted or untrusted.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on cluster names.

          '
        in: query
        name: clusters
        schema:
          description: 'Filters the result based on cluster names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result by compliance IDs.

          '
        in: query
        name: complianceIDs
        schema:
          description: 'Filters the result by compliance IDs.

            '
          items:
            $ref: '#/components/schemas/int'
          type: array
      - description: 'Filters the result based on applied compliance rule name.

          '
        in: query
        name: complianceRuleName
        schema:
          type: string
      - description: 'Filters the result based on whether the images are scanned by App-Embedded Defenders.

          Default is false.

          '
        in: query
        name: appEmbedded
        schema:
          type: boolean
      - description: 'Retrieves the result in the normalized form of low, medium, high, and critical based on vulnerability''s severity level.

          Default is false.

          '
        in: query
        name: normalizedSeverity
        schema:
          type: boolean
      - description: 'Indicates whether to retrieve host names that are scanned by agentless scanner.

          Default is false.

          '
        in: query
        name: agentless
        schema:
          type: boolean
      - description: 'Filters only images scanned by CSA.

          '
        in: query
        name: csa
        schema:
          type: boolean
      - description: 'Filters results by uaiID.

          '
        in: query
        name: uaiID
        schema:
          type: string
      - description: 'Filters results by issue type.

          '
        in: query
        name: issueType
        schema:
          description: IssueType is used to filter scan results by issue type
          enum:
          - - vulnerabilities
            - compliance
            - ''
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_string'
          description: ''
        default:
          description: ''
      tags:
      - Images
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: get-images-names
      summary: Get Image Names
      x-description-source: desc/images/names_get.md
  /api/v34.03/images/scan:
    post:
      description: 'Start Image Scan. POST /api/v34.03/images/scan on the Images API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/types.ImageScanOptions'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Images
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: post-images-scan
      summary: Start Image Scan
      x-description-source: desc/images/scan_post.md
  /api/v34.03/images/twistlock_defender_app_embedded.tar.gz:
    get:
      description: 'Download App Embedded Defender. GET /api/v34.03/images/twistlock_defender_app_embedded.tar.gz on the Images API. Documented responses: 200.'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Images
      x-prisma-cloud-target-env:
        permission: manageDefenders
      operationId: get-images-twistlock_defender_app_embedded.tar.gz
      summary: Download App Embedded Defender
      x-description-source: desc/images/twistlock_defender_app_embedded_tar_gz_get.md
  /api/v34.03/images/twistlock_defender_layer.zip:
    post:
      description: 'Download Serverless Layer Bundle. POST /api/v34.03/images/twistlock_defender_layer.zip on the Images API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/shared.ServerlessLayerBundleRequest'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Images
      x-prisma-cloud-target-env:
        permission: manageDefenders
      operationId: post-images-twistlock_defender_layer.zip
      summary: Download Serverless Layer Bundle
      x-description-source: desc/images/twistlock_defender_layer_zip_post.md
  /api/v34.04/images:
    get:
      description: 'Get Image Scan Results. GET /api/v34.04/images on the Images API. Takes 23 query parameters. Documented responses: 200.'
      parameters:
      - description: 'Offsets the result to a specific report count. Offset starts from 0.

          '
        in: query
        name: offset
        schema:
          type: integer
      - description: 'Limit is the amount to fix.

          '
        in: query
        name: limit
        schema:
          type: integer
      - description: 'Sorts the result using a key.

          '
        in: query
        name: sort
        schema:
          type: string
      - description: 'Sorts the result in reverse order.

          '
        in: query
        name: reverse
        schema:
          type: boolean
      - description: 'Filters the result based on image IDs.

          '
        in: query
        name: id
        schema:
          description: 'Filters the result based on image IDs.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on hostnames.

          '
        in: query
        name: hostname
        schema:
          description: 'Filters the result based on hostnames.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on image repository names.

          '
        in: query
        name: repository
        schema:
          description: 'Filters the result based on image repository names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on image registry names.

          '
        in: query
        name: registry
        schema:
          description: 'Filters the result based on image registry names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'List of fields to retrieve.

          '
        in: query
        name: fields
        schema:
          description: 'List of fields to retrieve.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on image names.

          '
        in: query
        name: name
        schema:
          description: 'Filters the result based on image names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Indicates whether the CVEs are mapped to a specific image layer.

          Default is false.

          '
        in: query
        name: layers
        schema:
          type: boolean
      - description: 'Indicates whether to filter the base image for vulnerabilities. Requires predefined base images that have already been scanned.

          Default is false.

          '
        in: query
        name: filterBaseImage
        schema:
          type: boolean
      - description: 'Provides the minimal image data. Information about vulnerabilities, compliance, and extended image metadata are skipped.

          Default is false.

          '
        in: query
        name: compact
        schema:
          type: boolean
      - description: 'Filters the result based on whether an image is trusted or not trusted by a trusted image policy.

          Use filters: trusted or untrusted.

          '
        in: query
        name: trustStatuses
        schema:
          description: 'Filters the result based on whether an image is trusted or not trusted by a trusted image policy.

            Use filters: trusted or untrusted.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on cluster names.

          '
        in: query
        name: clusters
        schema:
          description: 'Filters the result based on cluster names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result by compliance IDs.

          '
        in: query
        name: complianceIDs
        schema:
          description: 'Filters the result by compliance IDs.

            '
          items:
            $ref: '#/components/schemas/int'
          type: array
      - description: 'Filters the result based on applied compliance rule name.

          '
        in: query
        name: complianceRuleName
        schema:
          type: string
      - description: 'Filters the result based on whether the images are scanned by App-Embedded Defenders.

          Default is false.

          '
        in: query
        name: appEmbedded
        schema:
          type: boolean
      - description: 'Retrieves the result in the normalized form of low, medium, high, and critical based on vulnerability''s severity level.

          Default is false.

          '
        in: query
        name: normalizedSeverity
        schema:
          type: boolean
      - description: 'Indicates whether to retrieve host names that are scanned by agentless scanner.

          Default is false.

          '
        in: query
        name: agentless
        schema:
          type: boolean
      - description: 'Filters only images scanned by CSA.

          '
        in: query
        name: csa
        schema:
          type: boolean
      - description: 'Filters results by uaiID.

          '
        in: query
        name: uaiID
        schema:
          type: string
      - description: 'Filters results by issue type.

          '
        in: query
        name: issueType
        schema:
          description: IssueType is used to filter scan results by issue type
          enum:
          - - vulnerabilities
            - compliance
            - ''
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_shared.ImageScanResult'
          description: ''
        default:
          description: ''
      tags:
      - Images
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: get-images
      summary: Get Image Scan Results
      x-description-source: desc/images/get.md
  /api/v34.04/images/download:
    get:
      description: 'Download Image Scan Results. GET /api/v34.04/images/download on the Images API. Takes 23 query parameters. Documented responses: 200.'
      parameters:
      - description: 'Offsets the result to a specific report count. Offset starts from 0.

          '
        in: query
        name: offset
        schema:
          type: integer
      - description: 'Limit is the amount to fix.

          '
        in: query
        name: limit
        schema:
          type: integer
      - description: 'Sorts the result using a key.

          '
        in: query
        name: sort
        schema:
          type: string
      - description: 'Sorts the result in reverse order.

          '
        in: query
        name: reverse
        schema:
          type: boolean
      - description: 'Filters the result based on image IDs.

          '
        in: query
        name: id
        schema:
          description: 'Filters the result based on image IDs.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on hostnames.

          '
        in: query
        name: hostname
        schema:
          description: 'Filters the result based on hostnames.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on image repository names.

          '
        in: query
        name: repository
        schema:
          description: 'Filters the result based on image repository names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on image registry names.

          '
        in: query
        name: registry
        schema:
          description: 'Filters the result based on image registry names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'List of fields to retrieve.

          '
        in: query
        name: fields
        schema:
          description: 'List of fields to retrieve.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result based on image names.

          '
        in: query
        name: name
        schema:
          description: 'Filters the result based on image names.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Indicates whether the CVEs are mapped to a specific image layer.

          Default is false.

          '
        in: query
        name: layers
        schema:
          type: boolean
      - description: 'Indicates whether to filter the base image for vulnerabilities. Requires predefined base images that have already been scanned.

          Default is false.

          '
        in: query
        name: filterBaseImage
        schema:
          type: boolean
      - description: 'Provides the minimal image data. Information about vulnerabilities, compliance, and extended image metadata are skipped.

          Default is false.

          '
        in: query
        name: compact
        schema:
          type: boolean
      - description: 'Filters the result based on whether an image is trusted or not trusted by a trusted image policy.

          Use filters: trusted or untrusted.

          '
        in: query
      

# --- truncated at 32 KB (157 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-images-api-openapi.yml