Palo Alto Networks Containers API

openapi: 3.2.0
info:
  title: Palo Alto Networks Containers API
  version: '1.0'
  description: 'Operations tagged Containers 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: Containers
  description: Containers. 5 operations in this definition.
  x-description-source: desc/containers/containers.md
paths:
  /api/v34.03/containers:
    get:
      description: 'Get Container Scan Results. GET /api/v34.03/containers on the Containers API. Takes 17 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: 'Hosts is used to filter containers by host.

          '
        in: query
        name: hostname
        schema:
          description: 'Hosts is used to filter containers by host.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Images is used to filter containers by image name.

          '
        in: query
        name: image
        schema:
          description: 'Images is used to filter containers by image name.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'ImageIDs is used to filter containers by image ids.

          '
        in: query
        name: imageId
        schema:
          description: 'ImageIDs is used to filter containers by image ids.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'IDs is used to filter container by container ID.

          '
        in: query
        name: id
        schema:
          description: 'IDs is used to filter container by container ID.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'ProfileIDs is used to filter container by runtime profile ID.

          '
        in: query
        name: profileId
        schema:
          description: 'ProfileIDs is used to filter container by runtime profile ID.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Namespaces are the namespaces to filter.

          '
        in: query
        name: namespaces
        schema:
          description: 'Namespaces are the namespaces to filter.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Fields are used to fetch specific container field.

          '
        in: query
        name: fields
        schema:
          description: 'Fields are used to fetch specific container field.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'FirewallSupported is used to fetch containers with app firewall supported.

          '
        in: query
        name: firewallSupported
        schema:
          type: boolean
      - description: 'Clusters is used to filter containers by cluster name.

          '
        in: query
        name: clusters
        schema:
          description: 'Clusters is used to filter containers by cluster name.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'ComplianceIDs is used to filter containers by compliance IDs.

          '
        in: query
        name: complianceIDs
        schema:
          description: 'ComplianceIDs is used to filter containers by compliance IDs.

            '
          items:
            $ref: '#/components/schemas/int'
          type: array
      - description: 'ComplianceRuleName is used to filter containers by applied compliance rule name.

          '
        in: query
        name: complianceRuleName
        schema:
          type: string
      - description: 'Agentless indicates that we should return only containers that were scanned by an agentless scanner.

          '
        in: query
        name: agentless
        schema:
          type: boolean
      - description: 'CSA indicates that we should return only containers that were scanned by CSA.

          '
        in: query
        name: csa
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_shared.ContainerScanResult'
          description: ''
        default:
          description: ''
      tags:
      - Containers
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: get-containers
      summary: Get Container Scan Results
      x-description-source: desc/containers/get.md
  /api/v34.03/containers/count:
    get:
      description: 'Get Containers Count. GET /api/v34.03/containers/count on the Containers API. Takes 17 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: 'Hosts is used to filter containers by host.

          '
        in: query
        name: hostname
        schema:
          description: 'Hosts is used to filter containers by host.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Images is used to filter containers by image name.

          '
        in: query
        name: image
        schema:
          description: 'Images is used to filter containers by image name.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'ImageIDs is used to filter containers by image ids.

          '
        in: query
        name: imageId
        schema:
          description: 'ImageIDs is used to filter containers by image ids.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'IDs is used to filter container by container ID.

          '
        in: query
        name: id
        schema:
          description: 'IDs is used to filter container by container ID.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'ProfileIDs is used to filter container by runtime profile ID.

          '
        in: query
        name: profileId
        schema:
          description: 'ProfileIDs is used to filter container by runtime profile ID.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Namespaces are the namespaces to filter.

          '
        in: query
        name: namespaces
        schema:
          description: 'Namespaces are the namespaces to filter.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Fields are used to fetch specific container field.

          '
        in: query
        name: fields
        schema:
          description: 'Fields are used to fetch specific container field.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'FirewallSupported is used to fetch containers with app firewall supported.

          '
        in: query
        name: firewallSupported
        schema:
          type: boolean
      - description: 'Clusters is used to filter containers by cluster name.

          '
        in: query
        name: clusters
        schema:
          description: 'Clusters is used to filter containers by cluster name.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'ComplianceIDs is used to filter containers by compliance IDs.

          '
        in: query
        name: complianceIDs
        schema:
          description: 'ComplianceIDs is used to filter containers by compliance IDs.

            '
          items:
            $ref: '#/components/schemas/int'
          type: array
      - description: 'ComplianceRuleName is used to filter containers by applied compliance rule name.

          '
        in: query
        name: complianceRuleName
        schema:
          type: string
      - description: 'Agentless indicates that we should return only containers that were scanned by an agentless scanner.

          '
        in: query
        name: agentless
        schema:
          type: boolean
      - description: 'CSA indicates that we should return only containers that were scanned by CSA.

          '
        in: query
        name: csa
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/int'
          description: ''
        default:
          description: ''
      tags:
      - Containers
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: get-containers-count
      summary: Get Containers Count
      x-description-source: desc/containers/count_get.md
  /api/v34.03/containers/download:
    get:
      description: 'Download Container Scan Results. GET /api/v34.03/containers/download on the Containers API. Takes 18 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: 'Hosts is used to filter containers by host.

          '
        in: query
        name: hostname
        schema:
          description: 'Hosts is used to filter containers by host.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Images is used to filter containers by image name.

          '
        in: query
        name: image
        schema:
          description: 'Images is used to filter containers by image name.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'ImageIDs is used to filter containers by image ids.

          '
        in: query
        name: imageId
        schema:
          description: 'ImageIDs is used to filter containers by image ids.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'IDs is used to filter container by container ID.

          '
        in: query
        name: id
        schema:
          description: 'IDs is used to filter container by container ID.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'ProfileIDs is used to filter container by runtime profile ID.

          '
        in: query
        name: profileId
        schema:
          description: 'ProfileIDs is used to filter container by runtime profile ID.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Namespaces are the namespaces to filter.

          '
        in: query
        name: namespaces
        schema:
          description: 'Namespaces are the namespaces to filter.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Fields are used to fetch specific container field.

          '
        in: query
        name: fields
        schema:
          description: 'Fields are used to fetch specific container field.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'FirewallSupported is used to fetch containers with app firewall supported.

          '
        in: query
        name: firewallSupported
        schema:
          type: boolean
      - description: 'Clusters is used to filter containers by cluster name.

          '
        in: query
        name: clusters
        schema:
          description: 'Clusters is used to filter containers by cluster name.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'ComplianceIDs is used to filter containers by compliance IDs.

          '
        in: query
        name: complianceIDs
        schema:
          description: 'ComplianceIDs is used to filter containers by compliance IDs.

            '
          items:
            $ref: '#/components/schemas/int'
          type: array
      - description: 'ComplianceRuleName is used to filter containers by applied compliance rule name.

          '
        in: query
        name: complianceRuleName
        schema:
          type: string
      - description: 'Agentless indicates that we should return only containers that were scanned by an agentless scanner.

          '
        in: query
        name: agentless
        schema:
          type: boolean
      - description: 'CSA indicates that we should return only containers that were scanned by CSA.

          '
        in: query
        name: csa
        schema:
          type: boolean
      - description: 'When set to true, an additional field "Labels" is included for each container in the output CSV/JSON file.

          This field will provide a concatenated list of all the labels for the respective container in the format:

          key1:value1,key2:value2,...,keyN:valueN. The default value for this parameter is "false".

          '
        in: query
        name: includeLabels
        schema:
          type: boolean
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Containers
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: get-containers-download
      summary: Download Container Scan Results
      x-description-source: desc/containers/download_get.md
  /api/v34.03/containers/names:
    get:
      description: 'Get Container Names. GET /api/v34.03/containers/names on the Containers API. Takes 17 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: 'Hosts is used to filter containers by host.

          '
        in: query
        name: hostname
        schema:
          description: 'Hosts is used to filter containers by host.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Images is used to filter containers by image name.

          '
        in: query
        name: image
        schema:
          description: 'Images is used to filter containers by image name.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'ImageIDs is used to filter containers by image ids.

          '
        in: query
        name: imageId
        schema:
          description: 'ImageIDs is used to filter containers by image ids.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'IDs is used to filter container by container ID.

          '
        in: query
        name: id
        schema:
          description: 'IDs is used to filter container by container ID.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'ProfileIDs is used to filter container by runtime profile ID.

          '
        in: query
        name: profileId
        schema:
          description: 'ProfileIDs is used to filter container by runtime profile ID.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Namespaces are the namespaces to filter.

          '
        in: query
        name: namespaces
        schema:
          description: 'Namespaces are the namespaces to filter.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Fields are used to fetch specific container field.

          '
        in: query
        name: fields
        schema:
          description: 'Fields are used to fetch specific container field.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'FirewallSupported is used to fetch containers with app firewall supported.

          '
        in: query
        name: firewallSupported
        schema:
          type: boolean
      - description: 'Clusters is used to filter containers by cluster name.

          '
        in: query
        name: clusters
        schema:
          description: 'Clusters is used to filter containers by cluster name.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'ComplianceIDs is used to filter containers by compliance IDs.

          '
        in: query
        name: complianceIDs
        schema:
          description: 'ComplianceIDs is used to filter containers by compliance IDs.

            '
          items:
            $ref: '#/components/schemas/int'
          type: array
      - description: 'ComplianceRuleName is used to filter containers by applied compliance rule name.

          '
        in: query
        name: complianceRuleName
        schema:
          type: string
      - description: 'Agentless indicates that we should return only containers that were scanned by an agentless scanner.

          '
        in: query
        name: agentless
        schema:
          type: boolean
      - description: 'CSA indicates that we should return only containers that were scanned by CSA.

          '
        in: query
        name: csa
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_string'
          description: ''
        default:
          description: ''
      tags:
      - Containers
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: get-containers-names
      summary: Get Container Names
      x-description-source: desc/containers/names_get.md
  /api/v34.03/containers/scan:
    post:
      description: 'Start a Container Scan. POST /api/v34.03/containers/scan on the Containers API. Documented responses: 200.'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Containers
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: post-containers-scan
      summary: Start a Container Scan
      x-description-source: desc/containers/scan_post.md
  /api/v34.04/containers:
    get:
      description: 'Get Container Scan Results. GET /api/v34.04/containers on the Containers API. Takes 17 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: 'Hosts is used to filter containers by host.

          '
        in: query
        name: hostname
        schema:
          description: 'Hosts is used to filter containers by host.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Images is used to filter containers by image name.

          '
        in: query
        name: image
        schema:
          description: 'Images is used to filter containers by image name.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'ImageIDs is used to filter containers by image ids.

          '
        in: query
        name: imageId
        schema:
          description: 'ImageIDs is used to filter containers by image ids.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'IDs is used to filter container by container ID.

          '
        in: query
        name: id
        schema:
          description: 'IDs is used to filter container by container ID.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'ProfileIDs is used to filter container by runtime profile ID.

          '
        in: query
        name: profileId
        schema:
          description: 'ProfileIDs is used to filter container by runtime profile ID.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Namespaces are the namespaces to filter.

          '
        in: query
        name: namespaces
        schema:
          description: 'Namespaces are the namespaces to filter.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Fields are used to fetch specific container field.

          '
        in: query
        name: fields
        schema:
          description: 'Fields are used to fetch specific container field.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'FirewallSupported is used to fetch containers with app firewall supported.

          '
        in: query
        name: firewallSupported
        schema:
          type: boolean
      - description: 'Clusters is used to filter containers by cluster name.

          '
        in: query
        name: clusters
        schema:
          description: 'Clusters is used to filter containers by cluster name.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'ComplianceIDs is used to filter containers by compliance IDs.

          '
        in: query
        name: complianceIDs
        schema:
          description: 'ComplianceIDs is used to filter containers by compliance IDs.

            '
          items:
            $ref: '#/components/schemas/int'
          type: array
      - description: 'ComplianceRuleName is used to filter containers by applied compliance rule name.

          '
        in: query
        name: complianceRuleName
        schema:
          type: string
      - description: 'Agentless indicates that we should return only containers that were scanned by an agentless scanner.

          '
        in: query
        name: agentless
        schema:
          type: boolean
      - description: 'CSA indicates that we should return only containers that were scanned by CSA.

          '
        in: query
        name: csa
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_shared.ContainerScanResult'
          description: ''
        default:
          description: ''
      tags:
      - Containers
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: get-containers
      summary: Get Container Scan Results
      x-description-source: desc/containers/get.md
  /api/v34.04/containers/count:
    get:
      description: 'Get Containers Count. GET /api/v34.04/containers/count on the Containers API. Takes 17 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: 'Hosts is used to filter containers by host.

          '
        in: query
        name: hostname
        schema:
          description: 'Hosts is used to filter containers by host.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Images is used to filter containers by image name.

          '
        in: query
        name: image
        schema:
          description: 'Images is used to filter containers by image name.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'ImageIDs is used to filter containers by image ids.

          '
        in: query
        name: imageId
        schema:
          description: 'ImageIDs is used to filter containers by image ids.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'IDs is used to filter container by container ID.

          '
        in: query
        name: id
        schema:
          description: 'IDs is used to filter container by container ID.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'ProfileIDs is used to filter container by runtime profile ID.

          '
        in: query
        name: profileId
        schema:
          description: 'ProfileIDs is used to filter container by runtime profile ID.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Namespaces are the namespaces to filter.

          '
        in: query
        name: namespaces
        schema:
          description: 'Namespaces are the namespaces to filter.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Fields are used to fetch specific container field.

          '
        in: query
        name: fields
        schema:
          description: 'Fields are used to fetch specific container field.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'FirewallSupported is used to fetch containers with app firewall supported.

          '
        in: query
        name: firewallSupported
        schema:
          type: boolean
      - description: 'Clusters is used to filter containers by cluster name.

          '
        in: query
        name: clusters
        schema:
          description: 'Clusters is used to filter containers by cluster name.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'ComplianceIDs is used to filter containers by compliance IDs.

          '
        in: query
        name: complianceIDs
        schema:
          description: 'ComplianceIDs is used to filter containers by compliance IDs.

            '
          items:
            $ref: '#/components/schemas/int'
          type: array
      - description: 'ComplianceRuleName is used to filter containers by applied compliance rule name.

          '
        in: query
        name: complianceRuleName
        schema:
          type: string
      - description: 'Agentless indicates that we should return only containers that were scanned by an agentless scanner.

          '
        in: query
        name: agentless
        schema:
          type: boolean
      - description: 'CSA indicates that we should return only containers that were scanned by CSA.

          '
        in: query
        name: csa
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/int'
          description: ''
        default:
          description: ''
      tags:
      - Containers
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: get-containers-count
      summary: Get Containers Count
      x-description-source: desc/containers/count_get.md
  /api/v34.04/containers/download:
    get:
      description: 'Download Container Scan Results. GET /api/v34.04/containers/download on the Containers API. Takes 18 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: 'Hosts is used to filter containers by host.

          '
        in: query
        name: hostname
        schema:
          description: 'Hosts is used to filter containers by host.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Images is used to filter containers by image name.

          '
        in: query
        name: image
        schema:
          description: 'Images is used to filter

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