Palo Alto Networks Cloud API
{'$ref': 'desc/cloud/cloud.md'}
{'$ref': 'desc/cloud/cloud.md'}
openapi: 3.2.0
info:
title: Palo Alto Networks Cloud API
version: '1.0'
description: 'Operations tagged Cloud 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: Cloud
description: Cloud. 6 operations in this definition.
x-description-source: desc/cloud/cloud.md
paths:
/api/v34.03/cloud/discovery:
get:
description: 'Get Cloud Discovery Scan Results. GET /api/v34.03/cloud/discovery on the Cloud API. Takes 11 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: 'Provider is the provider filter.
'
in: query
name: provider
schema:
description: 'Provider is the provider filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'CredentialID is the account filter.
'
in: query
name: credentialID
schema:
description: 'CredentialID is the account filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'ServiceType is the service type filter.
'
in: query
name: serviceType
schema:
description: 'ServiceType is the service type filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Registry is the registry filter.
'
in: query
name: registry
schema:
description: 'Registry is the registry filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'AccountName is the account name filter.
'
in: query
name: accountName
schema:
description: 'AccountName is the account name filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Agentless is the agentless filter.
'
in: query
name: agentless
schema:
type: boolean
- description: 'Zone is the zone filter.
'
in: query
name: zone
schema:
description: 'Zone is the zone filter.
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_shared.CloudDiscoveryResult'
description: ''
default:
description: ''
tags:
- Cloud
x-prisma-cloud-target-env:
permission: monitorCloud
operationId: get-cloud-discovery
summary: Get Cloud Discovery Scan Results
x-description-source: desc/cloud/discovery_get.md
/api/v34.03/cloud/discovery/download:
get:
description: 'Download Cloud Discovery Scan Results. GET /api/v34.03/cloud/discovery/download on the Cloud API. Takes 11 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: 'Provider is the provider filter.
'
in: query
name: provider
schema:
description: 'Provider is the provider filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'CredentialID is the account filter.
'
in: query
name: credentialID
schema:
description: 'CredentialID is the account filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'ServiceType is the service type filter.
'
in: query
name: serviceType
schema:
description: 'ServiceType is the service type filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Registry is the registry filter.
'
in: query
name: registry
schema:
description: 'Registry is the registry filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'AccountName is the account name filter.
'
in: query
name: accountName
schema:
description: 'AccountName is the account name filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Agentless is the agentless filter.
'
in: query
name: agentless
schema:
type: boolean
- description: 'Zone is the zone filter.
'
in: query
name: zone
schema:
description: 'Zone is the zone filter.
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
description: OK
default:
description: ''
tags:
- Cloud
x-prisma-cloud-target-env:
permission: monitorCloud
operationId: get-cloud-discovery-download
summary: Download Cloud Discovery Scan Results
x-description-source: desc/cloud/discovery_download_get.md
/api/v34.03/cloud/discovery/entities:
get:
description: 'Get Discovered Cloud Entities. GET /api/v34.03/cloud/discovery/entities on the Cloud API. Takes 11 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: 'CredentialID is the account filter.
'
in: query
name: credentialID
schema:
description: 'CredentialID is the account filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'ServiceType is the service type filter.
'
in: query
name: serviceType
schema:
description: 'ServiceType is the service type filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Registry is the registry filter.
'
in: query
name: registry
schema:
description: 'Registry is the registry filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Zone is the zone filter.
'
in: query
name: zone
schema:
description: 'Zone is the zone filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Defended is the defended filter.
'
in: query
name: defended
schema:
type: boolean
- description: 'Images is used for filtering discovered entities by the container image names of a CaaS specification (e.g., AWS ECS Task Definition, GCP Cloud Run, ACI).
'
in: query
name: images
schema:
description: 'Images is used for filtering discovered entities by the container image names of a CaaS specification (e.g., AWS ECS Task Definition, GCP Cloud Run, ACI).
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'ImageDigests is used for filtering discovered entities by the container image digests of a CaaS specification (e.g., AWS ECS Task Definition, GCP Cloud Run, ACI).
'
in: query
name: imageDigests
schema:
description: 'ImageDigests is used for filtering discovered entities by the container image digests of a CaaS specification (e.g., AWS ECS Task Definition, GCP Cloud Run, ACI).
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_shared.CloudDiscoveryEntity'
description: ''
default:
description: ''
tags:
- Cloud
x-prisma-cloud-target-env:
permission: monitorCloud
operationId: get-cloud-discovery-entities
summary: Get Discovered Cloud Entities
x-description-source: desc/cloud/discovery_entities_get.md
/api/v34.03/cloud/discovery/scan:
post:
description: 'Start a Cloud Discovery Scan. POST /api/v34.03/cloud/discovery/scan on the Cloud API. Documented responses: 200.'
responses:
'200':
description: OK
default:
description: ''
tags:
- Cloud
x-prisma-cloud-target-env:
permission: monitorCloud
operationId: post-cloud-discovery-scan
summary: Start a Cloud Discovery Scan
x-description-source: desc/cloud/discovery_scan_post.md
/api/v34.03/cloud/discovery/stop:
post:
description: 'Stop a Cloud Discovery Scan. POST /api/v34.03/cloud/discovery/stop on the Cloud API. Documented responses: 200.'
responses:
'200':
description: OK
default:
description: ''
tags:
- Cloud
x-prisma-cloud-target-env:
permission: monitorCloud
operationId: post-cloud-discovery-stop
summary: Stop a Cloud Discovery Scan
x-description-source: desc/cloud/discovery_stop_post.md
/api/v34.03/cloud/discovery/vms:
get:
description: 'Get Discovered VMs. GET /api/v34.03/cloud/discovery/vms on the Cloud API. Takes 7 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: 'Provider is the provider filter.
'
in: query
name: provider
schema:
description: 'Provider is the provider filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Region is the region filter.
'
in: query
name: region
schema:
description: 'Region is the region filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'HasDefender indicates only VMs with or without a defender should return.
'
in: query
name: hasDefender
schema:
type: boolean
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_types.DiscoveredVM'
description: ''
default:
description: ''
tags:
- Cloud
x-prisma-cloud-target-env:
permission: monitorCloud
operationId: get-cloud-discovery-vms
summary: Get Discovered VMs
x-description-source: desc/cloud/discovery_vms_get.md
/api/v34.04/cloud/discovery:
get:
description: 'Get Cloud Discovery Scan Results. GET /api/v34.04/cloud/discovery on the Cloud API. Takes 11 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: 'Provider is the provider filter.
'
in: query
name: provider
schema:
description: 'Provider is the provider filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'CredentialID is the account filter.
'
in: query
name: credentialID
schema:
description: 'CredentialID is the account filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'ServiceType is the service type filter.
'
in: query
name: serviceType
schema:
description: 'ServiceType is the service type filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Registry is the registry filter.
'
in: query
name: registry
schema:
description: 'Registry is the registry filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'AccountName is the account name filter.
'
in: query
name: accountName
schema:
description: 'AccountName is the account name filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Agentless is the agentless filter.
'
in: query
name: agentless
schema:
type: boolean
- description: 'Zone is the zone filter.
'
in: query
name: zone
schema:
description: 'Zone is the zone filter.
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_shared.CloudDiscoveryResult'
description: ''
default:
description: ''
tags:
- Cloud
x-prisma-cloud-target-env:
permission: monitorCloud
operationId: get-cloud-discovery
summary: Get Cloud Discovery Scan Results
x-description-source: desc/cloud/discovery_get.md
/api/v34.04/cloud/discovery/download:
get:
description: 'Download Cloud Discovery Scan Results. GET /api/v34.04/cloud/discovery/download on the Cloud API. Takes 11 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: 'Provider is the provider filter.
'
in: query
name: provider
schema:
description: 'Provider is the provider filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'CredentialID is the account filter.
'
in: query
name: credentialID
schema:
description: 'CredentialID is the account filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'ServiceType is the service type filter.
'
in: query
name: serviceType
schema:
description: 'ServiceType is the service type filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Registry is the registry filter.
'
in: query
name: registry
schema:
description: 'Registry is the registry filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'AccountName is the account name filter.
'
in: query
name: accountName
schema:
description: 'AccountName is the account name filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Agentless is the agentless filter.
'
in: query
name: agentless
schema:
type: boolean
- description: 'Zone is the zone filter.
'
in: query
name: zone
schema:
description: 'Zone is the zone filter.
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
description: OK
default:
description: ''
tags:
- Cloud
x-prisma-cloud-target-env:
permission: monitorCloud
operationId: get-cloud-discovery-download
summary: Download Cloud Discovery Scan Results
x-description-source: desc/cloud/discovery_download_get.md
/api/v34.04/cloud/discovery/entities:
get:
description: 'Get Discovered Cloud Entities. GET /api/v34.04/cloud/discovery/entities on the Cloud API. Takes 11 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: 'CredentialID is the account filter.
'
in: query
name: credentialID
schema:
description: 'CredentialID is the account filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'ServiceType is the service type filter.
'
in: query
name: serviceType
schema:
description: 'ServiceType is the service type filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Registry is the registry filter.
'
in: query
name: registry
schema:
description: 'Registry is the registry filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Zone is the zone filter.
'
in: query
name: zone
schema:
description: 'Zone is the zone filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Defended is the defended filter.
'
in: query
name: defended
schema:
type: boolean
- description: 'Images is used for filtering discovered entities by the container image names of a CaaS specification (e.g., AWS ECS Task Definition, GCP Cloud Run, ACI).
'
in: query
name: images
schema:
description: 'Images is used for filtering discovered entities by the container image names of a CaaS specification (e.g., AWS ECS Task Definition, GCP Cloud Run, ACI).
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'ImageDigests is used for filtering discovered entities by the container image digests of a CaaS specification (e.g., AWS ECS Task Definition, GCP Cloud Run, ACI).
'
in: query
name: imageDigests
schema:
description: 'ImageDigests is used for filtering discovered entities by the container image digests of a CaaS specification (e.g., AWS ECS Task Definition, GCP Cloud Run, ACI).
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_shared.CloudDiscoveryEntity'
description: ''
default:
description: ''
tags:
- Cloud
x-prisma-cloud-target-env:
permission: monitorCloud
operationId: get-cloud-discovery-entities
summary: Get Discovered Cloud Entities
x-description-source: desc/cloud/discovery_entities_get.md
/api/v34.04/cloud/discovery/scan:
post:
description: 'Start a Cloud Discovery Scan. POST /api/v34.04/cloud/discovery/scan on the Cloud API. Documented responses: 200.'
responses:
'200':
description: OK
default:
description: ''
tags:
- Cloud
x-prisma-cloud-target-env:
permission: monitorCloud
operationId: post-cloud-discovery-scan
summary: Start a Cloud Discovery Scan
x-description-source: desc/cloud/discovery_scan_post.md
/api/v34.04/cloud/discovery/stop:
post:
description: 'Stop a Cloud Discovery Scan. POST /api/v34.04/cloud/discovery/stop on the Cloud API. Documented responses: 200.'
responses:
'200':
description: OK
default:
description: ''
tags:
- Cloud
x-prisma-cloud-target-env:
permission: monitorCloud
operationId: post-cloud-discovery-stop
summary: Stop a Cloud Discovery Scan
x-description-source: desc/cloud/discovery_stop_post.md
/api/v34.04/cloud/discovery/vms:
get:
description: 'Get Discovered VMs. GET /api/v34.04/cloud/discovery/vms on the Cloud API. Takes 7 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: 'Provider is the provider filter.
'
in: query
name: provider
schema:
description: 'Provider is the provider filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Region is the region filter.
'
in: query
name: region
schema:
description: 'Region is the region filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'HasDefender indicates only VMs with or without a defender should return.
'
in: query
name: hasDefender
schema:
type: boolean
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_types.DiscoveredVM'
description: ''
default:
description: ''
tags:
- Cloud
x-prisma-cloud-target-env:
permission: monitorCloud
operationId: get-cloud-discovery-vms
summary: Get Discovered VMs
x-description-source: desc/cloud/discovery_vms_get.md
components:
schemas:
common.OSDistroInfo:
description: OSDistroInfo represents information regarding the OS distribution
properties:
distro:
description: 'Distro is the OS distro name (e.g. ubuntu).
'
type: string
distroRelease:
description: 'DistroRelease is the OS distro release (e.g. willy).
'
type: string
fullName:
description: 'FullName is the full name of the distro (e.g. Ubuntu 19.10).
'
type: string
underlyingDistro:
description: 'UnderlyingDistro is used in cases OS an OS is built on top of another, and we need to know both.
'
type: string
underlyingDistroRelease:
description: 'UnderlyingDistroRelease is used in cases OS an OS is built on top of another, and we need to know both.
'
type: string
version:
description: 'Version is the OS release numeric version (e.g. 19.10).
'
type: string
type: object
prisma.ECSLaunchType:
enum:
- - EC2
- FARGATE
- EXTERNAL
type: string
-_shared.CloudDiscoveryEntity:
items:
$ref: '#/components/schemas/shared.CloudDiscoveryEntity'
type: array
common.CloudProvider:
description: CloudProvider specifies the cloud provider name
enum:
- - aws
- azure
- gcp
- alibaba
- oci
- others
type: string
common.ExternalLabel:
description: ExternalLabel holds an external label with a source and timestamp
properties:
key:
description: 'Label key.
'
type: string
sourceName:
description: 'Source name (e.g., for a namespace, the source name can be ''twistlock'').
'
type: string
sourceType:
$ref: '#/components/schemas/common.ExternalLabelSourceType'
timestamp:
description: 'Time when the label was fetched.
'
format: date-time
type: string
value:
description: 'Value of the label.
'
type: string
type: object
-_shared.CloudDiscoveryResult:
items:
$ref: '#/components/schemas/shared.CloudDiscoveryResult'
type: array
shared.CloudDiscoveryResult:
description: CloudDiscoveryResult represents a cloud scan result for a specific cloud provider, service and region
properties:
accountID:
description: 'AccountID is the cloud account ID.
'
type: string
accountName:
description: 'AccountName is the cloud account name.
'
type: string
agentless:
description: 'Agentless indicates whether the account is scan by agentless.
'
type: boolean
collections:
description: 'Collections are the matched result collections.
'
items:
$ref: '#/components/schemas/string'
type: array
credentialId:
description: 'CredentialID is the id reference of the credential used.
'
type: string
defended:
description: 'Defended is the number of defended entities (registries, functions, clusters).
'
type: integer
defenseCoverage:
description: 'DefenseCoverage is the defense coverage percentage (0-100).
'
type: integer
err:
description: 'Err holds any error found during a scan.
'
type: string
nodes:
description: 'Nodes is the number of nodes.
'
type: integer
project:
description: 'Project is the GCP project that was scanned.
'
type: string
provider:
$ref: '#/components/schemas/common.CloudProvider'
region:
description: 'Region is the region that was scanned, for example: GCP - "us-east-1", Azure - "westus".
'
type: string
registry:
description: 'Registry is the registry that was scanned, for example: testcloudscanregistry.azurecr.io.
'
type: string
registryTags:
additionalProperties:
$ref: '#/components/schemas/string'
description: 'RegistryTags are the registry tags.
'
type: object
serviceType:
$ref: '#/components/schemas/shared.ScanResultType'
total:
description: 'Total is total number of entities found in cloud scan.
'
type: integer
undefended:
description: 'Undefended is the number of undefended entities (registries, functions, clusters).
'
type: integer
zone:
description: 'Zone is the zone that was scanned, only relevant to GCP.
'
type: string
type: object
string:
type: string
common.ExternalLabelSourceType:
description: ExternalLabelSourceType indicates the source of the labels
enum:
- - namespace
- deployment
- pod
- aws
- azure
- gcp
- oci
type: string
types.DiscoveredVM:
description: DiscoveredVM represents the information about the instance, fetched from the cloud compute interface
properties:
_id:
description: 'ID is the instance id. E.g. "i-5cd23551".
'
type: string
accountID:
description: 'AccountID is the cloud provider account ID.
'
type: string
architecture:
description: 'Architecture is the architecture of the image.
'
type: string
arn:
description: 'The Amazon Resource Na
# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-cloud-api-openapi.yml