Palo Alto Networks Stats API
{'$ref': 'desc/stats/stats.md'}
OpenAPI Specification
openapi: 3.2.0
info:
title: Palo Alto Networks Stats API
version: '1.0'
description: 'Operations tagged Stats 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: Stats
description: Stats. 13 operations in this definition.
x-description-source: desc/stats/stats.md
paths:
/api/v34.03/stats/app-firewall/count:
get:
description: 'Application Firewall Count. GET /api/v34.03/stats/app-firewall/count on the Stats API. Documented responses: 200.'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/int'
description: ''
default:
description: ''
tags:
- Stats
x-prisma-cloud-target-env:
permission: systemOperations
operationId: get-stats-app-firewall-count
summary: Application Firewall Count
x-description-source: desc/stats/app_firewall_count_get.md
/api/v34.03/stats/compliance:
get:
description: 'Get Compliance Stats. GET /api/v34.03/stats/compliance on the Stats API. Takes 6 query parameters. Documented responses: 200.'
parameters:
- description: 'Scopes query by collection.
'
in: query
name: collections
schema:
description: 'Scopes query by collection.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Scopes query by account ID.
'
in: query
name: accountIDs
schema:
description: 'Scopes query by account ID.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters results by rule name.
'
in: query
name: ruleName
schema:
type: string
- description: 'Filters results by policy type. Used to further scope queries because rule names do not need to be unique between policies.
'
in: query
name: policyType
schema:
description: PolicyType represents the type of the policy
enum:
- - containerVulnerability
- containerCompliance
- ciImagesVulnerability
- ciImagesCompliance
- hostVulnerability
- hostCompliance
- vmVulnerability
- vmCompliance
- serverlessCompliance
- ciServerlessCompliance
- serverlessVulnerability
- ciServerlessVulnerability
- containerRuntime
- appEmbeddedRuntime
- containerAppFirewall
- hostAppFirewall
- outOfBandAppFirewall
- agentlessAppFirewall
- serverObserverAppFirewall
- appEmbeddedAppFirewall
- serverlessAppFirewall
- networkFirewall
- secrets
- hostRuntime
- serverlessRuntime
- kubernetesAudit
- trust
- admission
- codeRepoCompliance
- ciCodeRepoCompliance
- ciCodeRepoVulnerability
- codeRepoVulnerability
type: string
- description: 'Filters results by category. For example, a benchmark or resource type.
'
in: query
name: category
schema:
description: ComplianceCategory represents the compliance category
enum:
- - Docker
- Docker (DISA STIG)
- Twistlock Labs
- Custom
- Istio
- Linux
- Kubernetes
- CRI
- OpenShift
- Application Control
- GKE
- Prisma Cloud Labs
- EKS
- AKS
type: string
- description: 'Filters results by compliance template.
'
in: query
name: template
schema:
description: ComplianceTemplate represents the compliance template
enum:
- - PCI
- HIPAA
- NIST SP 800-190
- GDPR
- DISA STIG
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/types.ComplianceStats'
description: ComplianceStats holds compliance data
default:
description: ''
tags:
- Stats
x-prisma-cloud-target-env:
permission: monitorCompliance
operationId: get-stats-compliance
summary: Get Compliance Stats
x-description-source: desc/stats/compliance_get.md
/api/v34.03/stats/compliance/download:
get:
description: 'Download Compliance Stats. GET /api/v34.03/stats/compliance/download on the Stats API. Takes 6 query parameters. Documented responses: 200.'
parameters:
- description: 'Scopes query by collection.
'
in: query
name: collections
schema:
description: 'Scopes query by collection.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Scopes query by account ID.
'
in: query
name: accountIDs
schema:
description: 'Scopes query by account ID.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters results by rule name.
'
in: query
name: ruleName
schema:
type: string
- description: 'Filters results by policy type. Used to further scope queries because rule names do not need to be unique between policies.
'
in: query
name: policyType
schema:
description: PolicyType represents the type of the policy
enum:
- - containerVulnerability
- containerCompliance
- ciImagesVulnerability
- ciImagesCompliance
- hostVulnerability
- hostCompliance
- vmVulnerability
- vmCompliance
- serverlessCompliance
- ciServerlessCompliance
- serverlessVulnerability
- ciServerlessVulnerability
- containerRuntime
- appEmbeddedRuntime
- containerAppFirewall
- hostAppFirewall
- outOfBandAppFirewall
- agentlessAppFirewall
- serverObserverAppFirewall
- appEmbeddedAppFirewall
- serverlessAppFirewall
- networkFirewall
- secrets
- hostRuntime
- serverlessRuntime
- kubernetesAudit
- trust
- admission
- codeRepoCompliance
- ciCodeRepoCompliance
- ciCodeRepoVulnerability
- codeRepoVulnerability
type: string
- description: 'Filters results by category. For example, a benchmark or resource type.
'
in: query
name: category
schema:
description: ComplianceCategory represents the compliance category
enum:
- - Docker
- Docker (DISA STIG)
- Twistlock Labs
- Custom
- Istio
- Linux
- Kubernetes
- CRI
- OpenShift
- Application Control
- GKE
- Prisma Cloud Labs
- EKS
- AKS
type: string
- description: 'Filters results by compliance template.
'
in: query
name: template
schema:
description: ComplianceTemplate represents the compliance template
enum:
- - PCI
- HIPAA
- NIST SP 800-190
- GDPR
- DISA STIG
type: string
responses:
'200':
description: OK
default:
description: ''
tags:
- Stats
x-prisma-cloud-target-env:
permission: monitorCompliance
operationId: get-stats-compliance-download
summary: Download Compliance Stats
x-description-source: desc/stats/compliance_download_get.md
/api/v34.03/stats/compliance/refresh:
post:
description: 'Refresh Compliance Stats. POST /api/v34.03/stats/compliance/refresh on the Stats API. Takes 6 query parameters. Documented responses: 200.'
parameters:
- description: 'Scopes query by collection.
'
in: query
name: collections
schema:
description: 'Scopes query by collection.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Scopes query by account ID.
'
in: query
name: accountIDs
schema:
description: 'Scopes query by account ID.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters results by rule name.
'
in: query
name: ruleName
schema:
type: string
- description: 'Filters results by policy type. Used to further scope queries because rule names do not need to be unique between policies.
'
in: query
name: policyType
schema:
description: PolicyType represents the type of the policy
enum:
- - containerVulnerability
- containerCompliance
- ciImagesVulnerability
- ciImagesCompliance
- hostVulnerability
- hostCompliance
- vmVulnerability
- vmCompliance
- serverlessCompliance
- ciServerlessCompliance
- serverlessVulnerability
- ciServerlessVulnerability
- containerRuntime
- appEmbeddedRuntime
- containerAppFirewall
- hostAppFirewall
- outOfBandAppFirewall
- agentlessAppFirewall
- serverObserverAppFirewall
- appEmbeddedAppFirewall
- serverlessAppFirewall
- networkFirewall
- secrets
- hostRuntime
- serverlessRuntime
- kubernetesAudit
- trust
- admission
- codeRepoCompliance
- ciCodeRepoCompliance
- ciCodeRepoVulnerability
- codeRepoVulnerability
type: string
- description: 'Filters results by category. For example, a benchmark or resource type.
'
in: query
name: category
schema:
description: ComplianceCategory represents the compliance category
enum:
- - Docker
- Docker (DISA STIG)
- Twistlock Labs
- Custom
- Istio
- Linux
- Kubernetes
- CRI
- OpenShift
- Application Control
- GKE
- Prisma Cloud Labs
- EKS
- AKS
type: string
- description: 'Filters results by compliance template.
'
in: query
name: template
schema:
description: ComplianceTemplate represents the compliance template
enum:
- - PCI
- HIPAA
- NIST SP 800-190
- GDPR
- DISA STIG
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/types.ComplianceStats'
description: ComplianceStats holds compliance data
default:
description: ''
tags:
- Stats
x-prisma-cloud-target-env:
permission: monitorCompliance
operationId: post-stats-compliance-refresh
summary: Refresh Compliance Stats
x-description-source: desc/stats/compliance_refresh.md
/api/v34.03/stats/daily:
get:
description: 'Get Daily Compliance Stats. GET /api/v34.03/stats/daily on the Stats API. Documented responses: 200.'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_types.Stats'
description: ''
default:
description: ''
tags:
- Stats
x-prisma-cloud-target-env:
permission: monitorRuntimeContainers
operationId: get-stats-daily
summary: Get Daily Compliance Stats
x-description-source: desc/stats/daily_get.md
/api/v34.03/stats/dashboard:
get:
description: 'Get Dashboard Stats. GET /api/v34.03/stats/dashboard on the Stats API. Documented responses: 200.'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/types.Trends'
description: Trends contains data on global trends in the system
default:
description: ''
tags:
- Stats
x-prisma-cloud-target-env:
permission: monitorVuln
operationId: get-stats-dashboard
summary: Get Dashboard Stats
x-description-source: desc/stats/dashboard_get.md
/api/v34.03/stats/events:
get:
description: 'Get Event Stats. GET /api/v34.03/stats/events on the Stats API. Takes 5 query parameters. Documented responses: 200.'
parameters:
- description: 'Collections are collections scoping the query.
'
in: query
name: collections
schema:
description: 'Collections are collections scoping the query.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'AccountIDs are the account IDs scoping the query.
'
in: query
name: accountIDs
schema:
description: 'AccountIDs are the account IDs scoping the query.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'From is an optional minimum time constraints for the audit.
'
in: query
name: from
schema:
format: date-time
type: string
- description: 'To is an optional maximum time constraints for the audit.
'
in: query
name: to
schema:
format: date-time
type: string
- description: 'AttackTechniques are the MITRE attack techniques.
'
in: query
name: attackTechniques
schema:
description: 'AttackTechniques are the MITRE attack techniques.
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/types.EventStats'
description: EventStats holds counters for all event types
default:
description: ''
tags:
- Stats
x-prisma-cloud-target-env:
permission: accessUI
operationId: get-stats-events
summary: Get Event Stats
x-description-source: desc/stats/events_get.md
/api/v34.03/stats/license:
get:
description: 'Get Event Stats. GET /api/v34.03/stats/license on the Stats API. Documented responses: 200.'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/types.LicenseStats'
description: LicenseStats holds the console license stats
default:
description: ''
tags:
- Stats
x-prisma-cloud-target-env:
permission: systemOperations
operationId: get-stats-license
summary: Get Event Stats
x-description-source: desc/stats/license_get.md
/api/v34.03/stats/vulnerabilities:
get:
description: 'Get Vulnerability (CVEs) Stats. GET /api/v34.03/stats/vulnerabilities on the Stats API. Takes 13 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: 'CVE is the single CVE ID to return vulnerability data for.
'
in: query
name: cve
schema:
type: string
- description: 'SeverityThreshold is the minimum severity indicating that all retrieved CVEs severities are greater than or equal to the threshold.
'
in: query
name: severityThreshold
schema:
type: string
- description: 'CVSSThreshold is the minimum CVSS score indicating that all retrieved CVEs CVSS scores are greater than or equal to the threshold.
'
in: query
name: cvssThreshold
schema:
format: float
type: number
- description: 'ResourceType is the single resource type to return vulnerability data for.
'
in: query
name: resourceType
schema:
description: ResourceType represents the resource type
enum:
- - container
- image
- host
- istio
- vm
- function
- registryImage
type: string
- description: 'Agentless indicates whether to retrieve vulnerability data for agentless hosts/images.
'
in: query
name: agentless
schema:
type: boolean
- description: 'Stopped indicates whether to retrieve vulnerability data for hosts that were not running during agentless scan.
'
in: query
name: stopped
schema:
type: boolean
- description: 'Packages filter by impacted packages.
'
in: query
name: packages
schema:
description: 'Packages filter by impacted packages.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'RiskFactors filter by CVE risk factors.
'
in: query
name: riskFactors
schema:
description: 'RiskFactors filter by CVE risk factors.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'EnvRiskFactors filter by environmental risk factors.
'
in: query
name: envRiskFactors
schema:
description: 'EnvRiskFactors filter by environmental risk factors.
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_types.VulnerabilityStats'
description: ''
default:
description: ''
tags:
- Stats
x-prisma-cloud-target-env:
permission: monitorVuln
operationId: get-stats-vulnerabilities
summary: Get Vulnerability (CVEs) Stats
x-description-source: desc/stats/vulnerabilities_get.md
/api/v34.03/stats/vulnerabilities/download:
get:
description: 'Download Vulnerability (CVEs) Stats. GET /api/v34.03/stats/vulnerabilities/download on the Stats API. Takes 13 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: 'CVE is the single CVE ID to return vulnerability data for.
'
in: query
name: cve
schema:
type: string
- description: 'SeverityThreshold is the minimum severity indicating that all retrieved CVEs severities are greater than or equal to the threshold.
'
in: query
name: severityThreshold
schema:
type: string
- description: 'CVSSThreshold is the minimum CVSS score indicating that all retrieved CVEs CVSS scores are greater than or equal to the threshold.
'
in: query
name: cvssThreshold
schema:
format: float
type: number
- description: 'ResourceType is the single resource type to return vulnerability data for.
'
in: query
name: resourceType
schema:
description: ResourceType represents the resource type
enum:
- - container
- image
- host
- istio
- vm
- function
- registryImage
type: string
- description: 'Agentless indicates whether to retrieve vulnerability data for agentless hosts/images.
'
in: query
name: agentless
schema:
type: boolean
- description: 'Stopped indicates whether to retrieve vulnerability data for hosts that were not running during agentless scan.
'
in: query
name: stopped
schema:
type: boolean
- description: 'Packages filter by impacted packages.
'
in: query
name: packages
schema:
description: 'Packages filter by impacted packages.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'RiskFactors filter by CVE risk factors.
'
in: query
name: riskFactors
schema:
description: 'RiskFactors filter by CVE risk factors.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'EnvRiskFactors filter by environmental risk factors.
'
in: query
name: envRiskFactors
schema:
description: 'EnvRiskFactors filter by environmental risk factors.
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
description: OK
default:
description: ''
tags:
- Stats
x-prisma-cloud-target-env:
permission: monitorVuln
operationId: get-stats-vulnerabilities-download
summary: Download Vulnerability (CVEs) Stats
x-description-source: desc/stats/vulnerabilities_download_get.md
/api/v34.03/stats/vulnerabilities/impacted-resources:
get:
description: 'Get Impacted Resources Vulnerability (CVE) Stats. GET /api/v34.03/stats/vulnerabilities/impacted-resources on the Stats API. Takes 13 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: 'CVE is used to as a pivot for the impacted resource search.
'
in: query
name: cve
schema:
type: string
- description: 'SeverityThreshold is the minimum severity indicating that all retrieved CVEs severities are greater than or equal to the threshold.
'
in: query
name: severityThreshold
schema:
type: string
- description: 'CVSSThreshold is the minimum CVSS score indicating that all retrieved CVEs CVSS scores are greater than or equal to the threshold.
'
in: query
name: cvssThreshold
schema:
format: float
type: number
- description: 'ResourceType is the single resource type to return vulnerability data for.
'
in: query
name: resourceType
schema:
description: ResourceType represents the resource type
enum:
- - container
- image
- host
- istio
- vm
- function
- registryImage
type: string
- description: 'Agentless indicates whether to retrieve vulnerability data for agentless hosts/images.
'
in: query
name: agentless
schema:
type: boolean
- description: 'Stopped indicates whether to retrieve vulnerability data for hosts that were not running during agentless scan.
'
in: query
name: stopped
schema:
type: boolean
- description: 'Packages filter by impacted packages.
'
in: query
name: packages
schema:
description: 'Packages filter by impacted packages.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'RiskFactors filter by CVE risk factors.
'
in: query
name: riskFactors
schema:
description: 'RiskFactors filter by CVE risk factors.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'EnvRiskFactors filter by environmental risk factors.
'
in: query
name: envRiskFactors
schema:
description: 'EnvRiskFactors filter by environmental risk factors.
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/types.VulnImpactedResources'
description: VulnImpactedResources holds details about the resources impacted by vulnerability
default:
description: ''
tags:
- Stats
x-prisma-cloud-target-env:
permission: monitorVuln
operationId: get-stats-vulnerabilities-impacted-resources
summary: Get Impacted Resources Vulnerability (CVE) Stats
x-description-source: desc/stats/vulnerabilities_impacted_resources_get.md
/api/v34.03/stats/vulnerabilities/impacted-resources/download:
get:
description: 'Download Impacted Resources Vulnerability (CVE) Stats. GET /api/v34.03/stats/vulnerabilities/impacted-resources/download on the Stats API. Takes 13 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: 'CVE is used to as a pivot for the impacted resource search.
'
in: query
name: cve
schema:
type: string
- description: 'SeverityThreshold is the minimum severity indicating that all retrieved CVEs severities are greater than or equal to the threshold.
'
in: query
name: severityThreshold
schema:
type: string
- description: 'CVSSThreshold is the minimum CVSS score indicating that all retrieved CVEs CVSS scores are greater than or equal to the threshold.
'
in: query
name: cvssThreshold
schema:
format: float
type: number
- description: 'ResourceType is the single resource type to return vulnerability data for.
'
in: query
name: resourceType
schema:
description: ResourceType represents the resource type
enum:
- - container
- image
- host
- istio
- vm
- function
- registryImage
type: string
- description: 'Agentless indicates whether to retrieve vulnerability data for agentless hosts/images.
'
in: query
name: agentless
schema:
type: boolean
- description: 'Stopped indicates whether to retrieve vulnerability data for hosts that were not running during agentless scan.
'
in: query
name: stopped
schema:
type: boolean
- description: 'Packages filter by impacted packages.
'
in: query
name: packages
schema:
description: 'Packages filter by impacted packages.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'RiskFactors filter by CVE risk factors.
'
in: query
name: riskFactors
schema:
description: 'RiskFactors filter by CVE risk factors.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'EnvRiskFactors filter by environmental risk factors.
'
in: query
name: envRiskFactors
schema:
description: 'EnvRiskFactors filter by environmental risk factors.
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
description: OK
default:
description: ''
tags:
- Stats
x-prisma-cloud-target-env:
permission: monitorVuln
operationId: get-stats-vulnerabilities-impacted-resources-download
summary: Download Impacted Resources Vulnerability (CVE) Stats
x-description-source: desc/stats/vulnerabilities_impacted_resources_download_get.md
/api/v34.03/stats/vulnerabilities/refresh:
post:
description: 'Refresh Vulnerability Stats. POST /api/v34.03/stats/vulnerabilities/refresh on the Stats API. Takes 4 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
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_type
# --- truncated at 32 KB (94 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-stats-api-openapi.yml