Palo Alto Networks Hosts API
{'$ref': 'desc/hosts/hosts.md'}
{'$ref': 'desc/hosts/hosts.md'}
openapi: 3.2.0
info:
title: Palo Alto Networks Hosts API
version: '1.0'
description: 'Operations tagged Hosts 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: Hosts
description: Hosts. 5 operations in this definition.
x-description-source: desc/hosts/hosts.md
paths:
/api/v34.03/hosts:
get:
description: 'Get Host Scan Results. GET /api/v34.03/hosts on the Hosts API. Takes 16 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 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 OS distribution names.
'
in: query
name: distro
schema:
description: 'Filters the result based on OS distribution names.
'
items:
$ref: '#/components/schemas/string'
type: array
- 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 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 based on compliance IDs.
'
in: query
name: complianceIDs
schema:
description: 'Filters the result based on 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: 'Retrieves the host names that were scanned by the agentless scanner.
'
in: query
name: agentless
schema:
type: boolean
- description: 'Filters only images scanned by CSA.
'
in: query
name: csa
schema:
type: boolean
- description: 'Retrieves the host names that were skipped during an agentless scan.
Default is false.
'
in: query
name: stopped
schema:
type: boolean
- 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: '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
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_shared.ImageScanResult'
description: ''
default:
description: ''
tags:
- Hosts
x-prisma-cloud-target-env:
permission: monitorHosts
operationId: get-hosts
summary: Get Host Scan Results
x-description-source: desc/hosts/get.md
/api/v34.03/hosts/download:
get:
description: 'Download Host Scan Results. GET /api/v34.03/hosts/download on the Hosts API. Takes 16 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 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 OS distribution names.
'
in: query
name: distro
schema:
description: 'Filters the result based on OS distribution names.
'
items:
$ref: '#/components/schemas/string'
type: array
- 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 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 based on compliance IDs.
'
in: query
name: complianceIDs
schema:
description: 'Filters the result based on 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: 'Retrieves the host names that were scanned by the agentless scanner.
'
in: query
name: agentless
schema:
type: boolean
- description: 'Filters only images scanned by CSA.
'
in: query
name: csa
schema:
type: boolean
- description: 'Retrieves the host names that were skipped during an agentless scan.
Default is false.
'
in: query
name: stopped
schema:
type: boolean
- 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: '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
responses:
'200':
description: OK
default:
description: ''
tags:
- Hosts
x-prisma-cloud-target-env:
permission: monitorHosts
operationId: get-hosts-download
summary: Download Host Scan Results
x-description-source: desc/hosts/download_get.md
/api/v34.03/hosts/evaluate:
post:
description: 'Resolve Hosts. POST /api/v34.03/hosts/evaluate on the Hosts 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:
- Hosts
x-prisma-cloud-target-env:
permission: monitorCI
operationId: post-hosts-evaluate
summary: Resolve Hosts
x-description-source: desc/hosts/evaluate_get.md
/api/v34.03/hosts/info:
get:
description: 'Get Host Information. GET /api/v34.03/hosts/info on the Hosts API. Takes 16 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 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 OS distribution names.
'
in: query
name: distro
schema:
description: 'Filters the result based on OS distribution names.
'
items:
$ref: '#/components/schemas/string'
type: array
- 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 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 based on compliance IDs.
'
in: query
name: complianceIDs
schema:
description: 'Filters the result based on 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: 'Retrieves the host names that were scanned by the agentless scanner.
'
in: query
name: agentless
schema:
type: boolean
- description: 'Filters only images scanned by CSA.
'
in: query
name: csa
schema:
type: boolean
- description: 'Retrieves the host names that were skipped during an agentless scan.
Default is false.
'
in: query
name: stopped
schema:
type: boolean
- 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: '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
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_shared.HostInfo'
description: ''
default:
description: ''
tags:
- Hosts
x-prisma-cloud-target-env:
permission: monitorRuntimeHosts
operationId: get-hosts-info
summary: Get Host Information
x-description-source: desc/hosts/info_get.md
/api/v34.03/hosts/scan:
post:
description: 'Start a Host Scan. POST /api/v34.03/hosts/scan on the Hosts API. Documented responses: 200.'
responses:
'200':
description: OK
default:
description: ''
tags:
- Hosts
x-prisma-cloud-target-env:
permission: monitorHosts
operationId: post-hosts-scan
summary: Start a Host Scan
x-description-source: desc/hosts/scan_post.md
/api/v34.04/hosts:
get:
description: 'Get Host Scan Results. GET /api/v34.04/hosts on the Hosts API. Takes 16 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 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 OS distribution names.
'
in: query
name: distro
schema:
description: 'Filters the result based on OS distribution names.
'
items:
$ref: '#/components/schemas/string'
type: array
- 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 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 based on compliance IDs.
'
in: query
name: complianceIDs
schema:
description: 'Filters the result based on 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: 'Retrieves the host names that were scanned by the agentless scanner.
'
in: query
name: agentless
schema:
type: boolean
- description: 'Filters only images scanned by CSA.
'
in: query
name: csa
schema:
type: boolean
- description: 'Retrieves the host names that were skipped during an agentless scan.
Default is false.
'
in: query
name: stopped
schema:
type: boolean
- 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: '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
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_shared.ImageScanResult'
description: ''
default:
description: ''
tags:
- Hosts
x-prisma-cloud-target-env:
permission: monitorHosts
operationId: get-hosts
summary: Get Host Scan Results
x-description-source: desc/hosts/get.md
/api/v34.04/hosts/download:
get:
description: 'Download Host Scan Results. GET /api/v34.04/hosts/download on the Hosts API. Takes 16 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 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 OS distribution names.
'
in: query
name: distro
schema:
description: 'Filters the result based on OS distribution names.
'
items:
$ref: '#/components/schemas/string'
type: array
- 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 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 based on compliance IDs.
'
in: query
name: complianceIDs
schema:
description: 'Filters the result based on 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: 'Retrieves the host names that were scanned by the agentless scanner.
'
in: query
name: agentless
schema:
type: boolean
- description: 'Filters only images scanned by CSA.
'
in: query
name: csa
schema:
type: boolean
- description: 'Retrieves the host names that were skipped during an agentless scan.
Default is false.
'
in: query
name: stopped
schema:
type: boolean
- 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: '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
responses:
'200':
description: OK
default:
description: ''
tags:
- Hosts
x-prisma-cloud-target-env:
permission: monitorHosts
operationId: get-hosts-download
summary: Download Host Scan Results
x-description-source: desc/hosts/download_get.md
/api/v34.04/hosts/evaluate:
post:
description: 'Resolve Hosts. POST /api/v34.04/hosts/evaluate on the Hosts 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:
- Hosts
x-prisma-cloud-target-env:
permission: monitorCI
operationId: post-hosts-evaluate
summary: Resolve Hosts
x-description-source: desc/hosts/evaluate_get.md
/api/v34.04/hosts/info:
get:
description: 'Get Host Information. GET /api/v34.04/hosts/info on the Hosts API. Takes 16 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 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 OS distribution names.
'
in: query
name: distro
schema:
description: 'Filters the result based on OS distribution names.
'
items:
$ref: '#/components/schemas/string'
type: array
- 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 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 based on compliance IDs.
'
in: query
name: complianceIDs
schema:
description: 'Filters the result based on 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: 'Retrieves the host names that were scanned by the agentless scanner.
'
in: query
name: agentless
schema:
type: boolean
- description: 'Filters only images scanned by CSA.
'
in: query
name: csa
schema:
type: boolean
- description: 'Retrieves the host names that were skipped during an agentless scan.
Default is false.
'
in: query
name: stopped
schema:
type: boolean
- 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: '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
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_shared.HostInfo'
description: ''
default:
description: ''
tags:
- Hosts
x-prisma-cloud-target-env:
permission: monitorRuntimeHosts
operationId: get-hosts-info
summary: Get Host Information
x-description-source: desc/hosts/info_get.md
/api/v34.04/hosts/scan:
post:
description: 'Start a Host Scan. POST /api/v34.04/hosts/scan on the Hosts API. Documented responses: 200.'
responses:
'200':
description: OK
default:
description: ''
tags:
- Hosts
x-prisma-cloud-target-env:
permission: monitorHosts
operationId: post-hosts-scan
summary: Start a Host Scan
x-description-source: desc/hosts/scan_post.md
components:
schemas:
vuln.Application:
description: Application represents a detected application
properties:
installedFromPackage:
description: 'Indicates that the app was installed as an OS package.
'
type: boolean
knownVulnerabilities:
description: 'Total number of vulnerabilities for this application.
'
type: integer
layerTime:
description: 'Image layer to which the application belongs - layer creation time.
'
format: int64
type: integer
md5:
description: 'MD5 is the md5sum of the app.
'
type: string
name:
description: 'Name of the application.
'
type: string
originPackageName:
description: 'OriginPackageName is the name of the app origin package.
'
type: string
path:
description: 'Path of the detected application.
'
type: string
rpmModule:
description: 'RPMModule represents the RPM module in which this application is included.
'
type: string
service:
description: 'Service indicates whether the application is installed as a service.
'
type: boolean
version:
description: 'Version of the application.
'
type: string
type: object
vulnerability.ExploitType:
description: ExploitType represents the source of an exploit
enum:
- - ''
- exploit-db
- exploit-windows
- cisa-kev
type: string
wildfire.Usage:
description: Usage holds wildfire usage stats, period for the usage varies with context
properties:
bytes:
description: 'Bytes is the total number of bytes uploaded to the WildFire API.
'
format: int64
type: integer
queries:
description: 'Queries is the number of queries to the WildFire API.
'
format: int64
type: integer
uploads:
description: 'Uploads is the number of uploads to the WildFire API.
'
format: int64
type: integer
type: object
shared.ImageTag:
description: ImageTag represents an image repository and its associated tag or registry digest
properties:
digest:
description: 'Image digest (requires V2 or later registry).
'
type: string
id:
description: 'ID of the image.
'
type: string
registry:
description: 'Registry name to which the image belongs.
'
type: string
repo:
description: 'Repository name to which the image belongs.
'
type: string
tag:
description: 'Image tag.
'
type: string
type: object
common.NetworkDeviceIP:
description: NetworkDeviceIP represents a network device name and address pair
properties:
ip:
description: 'Network device IPv4 address.
'
type: string
name:
description: 'Network device name.
'
type: string
type: object
common.CloudMetadata:
description: CloudMetadata is the metadata for a cloud provider managed asset (e.g., as part of AWS/GCP/Azure/OCI)
properties:
accountID:
description: 'Cloud account ID.
'
type: string
awsExecutionEnv:
description: 'AWS execution environment (e.g. EC2/Fargate).
'
type: string
azure:
$ref: '#/components/schemas/common.AzureMetadata'
gcp:
$ref: '#/components/schemas/common.GCPCloudMetadata'
image:
description: 'The name of the image the cloud managed host or container is based on.
'
type: string
labels:
description: 'Cloud provider metadata labels.
'
items:
$ref: '#/components/schemas/common.ExternalLabel'
type: array
name:
description: 'Resource name.
'
type: string
ociTenantID:
description: 'OCI Tenant ID.
'
type: string
provider:
$ref: '#/components/schemas/common.CloudP
# --- truncated at 32 KB (181 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-hosts-api-openapi.yml