Palo Alto Networks Registry API

openapi: 3.2.0
info:
  title: Palo Alto Networks Registry API
  version: '1.0'
  description: 'Operations tagged Registry 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: Registry
  description: Registry. 10 operations in this definition.
  x-description-source: desc/registry/registry.md
paths:
  /api/v1/registry/webhook/webhook:
    delete:
      description: 'Delete a Registry Webhook. DELETE /api/v1/registry/webhook/webhook on the Registry API. Documented responses: 200.'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Registry
      x-prisma-cloud-target-env:
        permission: none
      operationId: delete-registry-webhook-webhook
      summary: Delete a Registry Webhook
      x-description-source: desc/registry/webhook_webhook_delete.md
    post:
      description: 'Registry Webhook. POST /api/v1/registry/webhook/webhook on the Registry API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/types.RegistryWebhookRequest'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Registry
      x-prisma-cloud-target-env:
        permission: none
      operationId: post-registry-webhook-webhook
      summary: Registry Webhook
      x-description-source: desc/registry/webhook_webhook_post.md
  /api/v34.03/registry:
    get:
      description: 'Get Registry Scan Results. GET /api/v34.03/registry on the Registry 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: 'Filters results by registry image.

          '
        in: query
        name: id
        schema:
          description: 'Filters results by registry image.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result by image IDs that are available in daemonset.

          '
        in: query
        name: imageID
        schema:
          description: 'Filters the result by image IDs that are available in daemonset.

            '
          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: 'Filters the result based on full image names.

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

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

          Default is false.

          '
        in: query
        name: layers
        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: '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: '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: '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
      - description: 'HasCAASReferences filter the results by registry images that have CAAS specification references.

          '
        in: query
        name: hasCAASSpecReferences
        schema:
          type: boolean
      - description: 'CAASSpecReferencesServiceTypes filter the results by registry images that were deployed as a container through specific service types.

          '
        in: query
        name: caasSpecReferencesServiceTypes
        schema:
          description: 'CAASSpecReferencesServiceTypes filter the results by registry images that were deployed as a container through specific service types.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'CAASSpecReferencesLaunchTypes filter the results by registry images that were deployed as a container through specific launch types.

          '
        in: query
        name: caasSpecReferencesLaunchTypes
        schema:
          description: 'CAASSpecReferencesLaunchTypes filter the results by registry images that were deployed as a container through specific launch types.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_shared.ImageScanResult'
          description: ''
        default:
          description: ''
      tags:
      - Registry
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: get-registry
      summary: Get Registry Scan Results
      x-description-source: desc/registry/get.md
  /api/v34.03/registry/download:
    get:
      description: 'Download Registry Scan Results. GET /api/v34.03/registry/download on the Registry 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: 'Filters results by registry image.

          '
        in: query
        name: id
        schema:
          description: 'Filters results by registry image.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result by image IDs that are available in daemonset.

          '
        in: query
        name: imageID
        schema:
          description: 'Filters the result by image IDs that are available in daemonset.

            '
          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: 'Filters the result based on full image names.

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

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

          Default is false.

          '
        in: query
        name: layers
        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: '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: '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: '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
      - description: 'HasCAASReferences filter the results by registry images that have CAAS specification references.

          '
        in: query
        name: hasCAASSpecReferences
        schema:
          type: boolean
      - description: 'CAASSpecReferencesServiceTypes filter the results by registry images that were deployed as a container through specific service types.

          '
        in: query
        name: caasSpecReferencesServiceTypes
        schema:
          description: 'CAASSpecReferencesServiceTypes filter the results by registry images that were deployed as a container through specific service types.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'CAASSpecReferencesLaunchTypes filter the results by registry images that were deployed as a container through specific launch types.

          '
        in: query
        name: caasSpecReferencesLaunchTypes
        schema:
          description: 'CAASSpecReferencesLaunchTypes filter the results by registry images that were deployed as a container through specific launch types.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Registry
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: get-registry-download
      summary: Download Registry Scan Results
      x-description-source: desc/registry/download_get.md
  /api/v34.03/registry/names:
    get:
      description: 'Get Registry Image Names. GET /api/v34.03/registry/names on the Registry 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: 'Filters results by registry image.

          '
        in: query
        name: id
        schema:
          description: 'Filters results by registry image.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result by image IDs that are available in daemonset.

          '
        in: query
        name: imageID
        schema:
          description: 'Filters the result by image IDs that are available in daemonset.

            '
          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: 'Filters the result based on full image names.

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

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

          Default is false.

          '
        in: query
        name: layers
        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: '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: '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: '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
      - description: 'HasCAASReferences filter the results by registry images that have CAAS specification references.

          '
        in: query
        name: hasCAASSpecReferences
        schema:
          type: boolean
      - description: 'CAASSpecReferencesServiceTypes filter the results by registry images that were deployed as a container through specific service types.

          '
        in: query
        name: caasSpecReferencesServiceTypes
        schema:
          description: 'CAASSpecReferencesServiceTypes filter the results by registry images that were deployed as a container through specific service types.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'CAASSpecReferencesLaunchTypes filter the results by registry images that were deployed as a container through specific launch types.

          '
        in: query
        name: caasSpecReferencesLaunchTypes
        schema:
          description: 'CAASSpecReferencesLaunchTypes filter the results by registry images that were deployed as a container through specific launch types.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_string'
          description: ''
        default:
          description: ''
      tags:
      - Registry
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: get-registry-names
      summary: Get Registry Image Names
      x-description-source: desc/registry/names_get.md
  /api/v34.03/registry/progress:
    get:
      description: 'View Registry Scan Progress. GET /api/v34.03/registry/progress on the Registry API. Takes 5 query parameters. Documented responses: 200.'
      parameters:
      - description: 'OnDemand indicates the requested progress is for an on-demand scan.

          '
        in: query
        name: onDemand
        schema:
          type: boolean
      - description: 'Registry is the image''s registry.

          '
        in: query
        name: registry
        schema:
          type: string
      - description: 'Repository is the image''s repository.

          '
        in: query
        name: repo
        schema:
          type: string
      - description: 'Tag is the image''s tag.

          '
        in: query
        name: tag
        schema:
          type: string
      - description: 'Digest is the image''s digest.

          '
        in: query
        name: digest
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_shared.RegistryScanProgress'
          description: ''
        default:
          description: ''
      tags:
      - Registry
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: get-registry-progress
      summary: View Registry Scan Progress
      x-description-source: desc/registry/get_registry_progress.md
  /api/v34.03/registry/scan:
    post:
      description: 'Start a Registry Scan. POST /api/v34.03/registry/scan on the Registry API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/shared.RegistryScanRequest'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Registry
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: post-registry-scan
      summary: Start a Registry Scan
      x-description-source: desc/registry/scan_post.md
  /api/v34.03/registry/scan/select:
    post:
      description: 'Scan Registries. POST /api/v34.03/registry/scan/select on the Registry API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/-_shared.RegistryScanRequest'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Registry
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: post-registry-scan-select
      summary: Scan Registries
      x-description-source: desc/registry/scan_select_post.md
  /api/v34.03/registry/stop:
    post:
      description: 'Stop a Registry Scan. POST /api/v34.03/registry/stop on the Registry API. Documented responses: 200.'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Registry
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: post-registry-stop
      summary: Stop a Registry Scan
      x-description-source: desc/registry/stop_post.md
  /api/v34.03/registry/stop/{id}:
    post:
      description: 'Stop a Registry spec Scan. POST /api/v34.03/registry/stop/{id} on the Registry API. Takes 1 path parameter. Documented responses: 200.'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Registry
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: post-registry-stop-id
      summary: Stop a Registry spec Scan
      x-description-source: desc/registry/stop_id_post.md
  /api/v34.04/registry:
    get:
      description: 'Get Registry Scan Results. GET /api/v34.04/registry on the Registry 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: 'Filters results by registry image.

          '
        in: query
        name: id
        schema:
          description: 'Filters results by registry image.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result by image IDs that are available in daemonset.

          '
        in: query
        name: imageID
        schema:
          description: 'Filters the result by image IDs that are available in daemonset.

            '
          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: 'Filters the result based on full image names.

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

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

          Default is false.

          '
        in: query
        name: layers
        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: '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: '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: '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
      - description: 'HasCAASReferences filter the results by registry images that have CAAS specification references.

          '
        in: query
        name: hasCAASSpecReferences
        schema:
          type: boolean
      - description: 'CAASSpecReferencesServiceTypes filter the results by registry images that were deployed as a container through specific service types.

          '
        in: query
        name: caasSpecReferencesServiceTypes
        schema:
          description: 'CAASSpecReferencesServiceTypes filter the results by registry images that were deployed as a container through specific service types.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'CAASSpecReferencesLaunchTypes filter the results by registry images that were deployed as a container through specific launch types.

          '
        in: query
        name: caasSpecReferencesLaunchTypes
        schema:
          description: 'CAASSpecReferencesLaunchTypes filter the results by registry images that were deployed as a container through specific launch types.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_shared.ImageScanResult'
          description: ''
        default:
          description: ''
      tags:
      - Registry
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: get-registry
      summary: Get Registry Scan Results
      x-description-source: desc/registry/get.md
  /api/v34.04/registry/download:
    get:
      description: 'Download Registry Scan Results. GET /api/v34.04/registry/download on the Registry 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: 'Filters results by registry image.

          '
        in: query
        name: id
        schema:
          description: 'Filters results by registry image.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Filters the result by image IDs that are available in daemonset.

          '
        in: query
        name: imageID
        schema:
          description: 'Filters the result by image IDs that are available in daemonset.

            '
          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: 'Filters the result based on full image names.

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

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

          Default is false.

          '
        in: query
        name: layers
        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: '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: '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: '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
      - description: 'HasCAASReferences filter the results by registry images that have CAAS specification references.

          '
        in: query
        name: hasCAASSpecReferences
        schema:
          type: boolean
      - description: 'CAASSpecReferencesServiceTypes filter the results by registry images that were deployed as a container through specific service types.

          '
        in: query
        name: caasSpecReferencesServiceTypes
        schema:
          description: 'CAASSpecReferencesServiceTypes filter the results by registry images that were deployed as a container through specific service types.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'CAASSpecReferencesLaunchTypes filter the results by registry images that were deployed as a container through specific launch types.

          '

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