Palo Alto Networks Application API API
Application API
OpenAPI Specification
openapi: 3.2.0
info:
contact:
email: support@paloaltonetworks.com
description: 'The Open API specification file represents the APIs available for Prisma Access Insights 3.0.
The Prisma Access Insights 3.0 APIs allow you to query your Prisma Access tenant for the health of
your Prisma Access network deployment. The 3.0 APIs are intended for cloud-managed Prisma Access
customers, where the tenants have been onboarded by Palo Alto Networks using a Tenant Service Group
(TSG) identifier.
These APIs use the common SASE authentication mechanism and base URL. See the
[Prisma SASE API Get Started](https://pan.dev/sase/docs/getstarted) guide for more information.
This Open API spec file was created on May 30, 2025. To check for a more recent version of this file, see
[Prisma Insights APIs on pan.dev](https://pan.dev//access/api/insights/).
© 2025 Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark of Palo
Alto Networks. A list of our trademarks can be found at
[https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html)
All other marks mentioned herein may be trademarks of their respective companies.
'
license:
name: MIT
url: https://opensource.org/license/mit
termsOfService: https://www.paloaltonetworks.com/content/dam/pan/en_US/assets/pdf/legal/palo-alto-networks-end-user-license-agreement-eula.pdf
title: Palo Alto Networks 3.0 Application API API
version: '3.0'
servers:
- url: https://api.sase.paloaltonetworks.com
tags:
- description: 'Application API
'
name: Application API
paths:
/insights/v3.0/resource/query/accelerated_applications/accelerated_application_list:
post:
description: 'Retrieve a list of accelerated applications with summary information.
'
operationId: post-insights-v3.0-resource-query-accelerated_applications-accelerated_application_list
parameters:
- description: 'Map the region for the tenant.
'
in: header
name: X-PANW-Region
required: true
schema:
example: americas
type: string
- description: 'Use a unique Prisma-Tenant identifier for precise tenant management and resource allocation within single or multi-tenant architectures.
'
in: header
name: Prisma-Tenant
required: false
schema:
example: 12345678:12345679
type: string
requestBody:
content:
application/json:
examples:
With mandatory filters:
value:
filter:
rules:
- operator: last_n_hours
property: event_time
values:
- 5
With possible filters:
value:
filter:
rules:
- operator: last_n_hours
property: event_time
values:
- 5
- operator: in
property: edge_location_display_name
values:
- US West
- operator: equals
property: app_accelerated
values:
- true
- operator: in
property: app
values:
- salesforce
- zoom
schema:
properties:
filter:
properties:
rules:
items:
properties:
app:
description: Application name.
example: salesforce
type: string
app_accelerated:
description: Whether the application is accelerated.
example: true
type: boolean
edge_location_display_name:
description: Prisma Access Location.
example: US West
type: string
event_time:
description: Time of the event.
example: 5
type: number
type: object
required:
- event_time
type: array
type: object
type: object
required: true
responses:
'200':
content:
application/json:
schema:
properties:
accelerated_user_count:
description: Number of users with accelerated application experience.
example: 100
type: integer
app:
description: Application name.
example: salesforce
type: string
app_accelerated:
description: Indicates if the application is accelerated.
example: true
type: boolean
avg_throughput:
description: Average throughput for the application.
example: 500000.0
format: float
type: number
better_response_time:
description: Improved response time for the application.
example: 0.2
format: float
type: number
total_data_transfer:
description: Total data transferred for the application.
example: 1000000.0
format: float
type: number
type: object
description: OK
'400':
description: Resource property is not valid
'403':
description: Permission Denied
'404':
description: Resource not found
'500':
description: Failed to process request
security:
- Bearer: []
summary: Accelerated Application List
tags:
- Application API
/insights/v3.0/resource/query/accelerated_applications/accelerated_applications/throughput_before_after_boost_histogram:
post:
description: 'Retrieve a histogram of throughput metrics before and after boost for accelerated applications.
'
operationId: post-insights-v3.0-resource-query-accelerated_applications-accelerated_applications-throughput_before_after_boost_histogram
parameters:
- description: 'Map the region for the tenant.
'
in: header
name: X-PANW-Region
required: true
schema:
example: americas
type: string
- description: 'Use a unique Prisma-Tenant identifier for precise tenant management and resource allocation within single or multi-tenant architectures.
'
in: header
name: Prisma-Tenant
required: false
schema:
example: 12345678:12345679
type: string
requestBody:
content:
application/json:
examples:
With mandatory filters:
value:
filter:
rules:
- operator: last_n_hours
property: event_time
values:
- 5
histogram:
enableEmptyInterval: true
property: event_time
range: minute
value: 30
With possible filters:
value:
filter:
rules:
- operator: last_n_hours
property: event_time
values:
- 5
- operator: in
property: edge_location_display_name
values:
- US West
- operator: in
property: app_accelerated
values:
- true
- false
- operator: in
property: app
values:
- Zoom
- Salesforce
histogram:
enableEmptyInterval: true
property: event_time
range: minute
value: 30
schema:
properties:
filter:
properties:
rules:
items:
properties:
app:
description: Application Name
example: Zoom
type: string
app_accelerated:
description: Whether the application is accelerated.
example: true
type: boolean
edge_location_display_name:
description: Prisma Access Locations
example: US West
type: string
event_time:
description: Time of the event.
example: 5
type: number
type: object
required:
- event_time
type: array
type: object
histogram:
properties:
enableEmptyInterval:
description: Enable empty interval
example: true
type: boolean
property:
description: Property for histogram
example: event_time
type: string
range:
description: Range of histogram
example: minute
type: string
value:
description: Value of histogram
example: 30
type: integer
type: object
type: object
required: true
responses:
'200':
content:
application/json:
schema:
properties:
event_time:
description: Event time
example: 1709226000000
type: number
throughput_after_acceleration:
description: Throughput after acceleration
example: 2000000.0
format: float
type: number
throughput_before_acceleration:
description: Throughput before acceleration
example: 1000000.0
format: float
type: number
type: object
description: OK
'400':
description: Resource property is not valid
'403':
description: Permission Denied
'404':
description: Resource not found
'500':
description: Failed to process request
security:
- Bearer: []
summary: Accelerated Applications Throughput Histogram
tags:
- Application API
/insights/v3.0/resource/query/accelerated_applications/applications_count:
post:
description: 'Retrieve the number of accelerated applications.
'
operationId: post-insights-v3.0-resource-query-accelerated_applications-applications_count
parameters:
- description: 'Map the region for the tenant.
'
in: header
name: X-PANW-Region
required: true
schema:
example: americas
type: string
- description: 'Use a unique Prisma-Tenant identifier for precise tenant management and resource allocation within single or multi-tenant architectures.
'
in: header
name: Prisma-Tenant
required: false
schema:
example: 12345678:12345679
type: string
requestBody:
content:
application/json:
examples:
With mandatory filters:
value:
filter:
rules:
- operator: last_n_hours
property: event_time
values:
- 5
With possible filters:
value:
filter:
rules:
- operator: last_n_hours
property: event_time
values:
- 5
- operator: in
property: edge_location_display_name
values:
- US West
- operator: equals
property: app_accelerated
values:
- true
- operator: in
property: app
values:
- Zoom
- Salesforce
schema:
properties:
filter:
properties:
rules:
items:
properties:
app:
description: Application Name.
example: Zoom
type: string
app_accelerated:
description: Whether the application is accelerated.
example: true
type: boolean
edge_location_display_name:
description: Prisma Access Location.
example: US West
type: string
event_time:
description: Time of the event.
example: 5
type: number
type: object
required:
- event_time
type: array
type: object
type: object
required: true
responses:
'200':
content:
application/json:
schema:
properties:
applications_accelerated:
description: Count of accelerated applications.
example: 10
type: integer
type: object
description: OK
'400':
description: Resource property is not valid
'403':
description: Permission Denied
'404':
description: Resource not found
'500':
description: Failed to process request
security:
- Bearer: []
summary: Retrieve Accelerated Applications Data
tags:
- Application API
/insights/v3.0/resource/query/accelerated_applications/better_response_time:
post:
description: 'Retrieve data related to accelerated applications and their response times.
'
operationId: post-insights-v3.0-resource-query-accelerated_applications-better_response_time
parameters:
- description: 'Map the region for the tenant.
'
in: header
name: X-PANW-Region
required: true
schema:
example: americas
type: string
- description: 'Use a unique Prisma-Tenant identifier for precise tenant management and resource allocation within single or multi-tenant architectures.
'
in: header
name: Prisma-Tenant
required: false
schema:
example: 12345678:12345679
type: string
requestBody:
content:
application/json:
examples:
With mandatory filters:
value:
filter:
rules:
- operator: last_n_hours
property: event_time
values:
- 5
With possible filters:
value:
filter:
rules:
- operator: last_n_hours
property: event_time
values:
- 5
- operator: in
property: edge_location_display_name
values:
- US West
- operator: equals
property: app_accelerated
values:
- true
- operator: in
property: app
values:
- Zoom
- Salesforce
schema:
properties:
filter:
properties:
rules:
items:
properties:
app:
description: Application Name.
example: Zoom
type: string
app_accelerated:
description: Whether the application is accelerated.
example: true
type: boolean
edge_location_display_name:
description: Prisma Access Location.
example: US West
type: string
event_time:
description: Time of the event.
example: 5
type: number
type: object
required:
- event_time
type: array
type: object
type: object
required: true
responses:
'200':
content:
application/json:
schema:
properties:
better_response_time:
description: Response time of the accelerated application.
example: 0.5
format: float
type: number
type: object
description: OK
'400':
description: Resource property is not valid
'403':
description: Permission Denied
'404':
description: Resource not found
'500':
description: Failed to process request
security:
- Bearer: []
summary: Retrieve Application Response Time Data
tags:
- Application API
/insights/v3.0/resource/query/accelerated_applications/data_transfer_throughput_per_app:
post:
description: 'Retrieve data transfer and throughput metrics for specific accelerated applications.
'
operationId: post-insights-v3.0-resource-query-accelerated_applications-data_transfer_throughput_per_app
parameters:
- description: 'Map the region for the tenant.
'
in: header
name: X-PANW-Region
required: true
schema:
example: americas
type: string
- description: 'Use a unique Prisma-Tenant identifier for precise tenant management and resource allocation within single or multi-tenant architectures.
'
in: header
name: Prisma-Tenant
required: false
schema:
example: 12345678:12345679
type: string
requestBody:
content:
application/json:
examples:
With mandatory filters:
value:
filter:
rules:
- operator: last_n_hours
property: event_time
values:
- 5
With possible filters:
value:
filter:
rules:
- operator: last_n_hours
property: event_time
values:
- 5
- operator: in
property: edge_location_display_name
values:
- US West
- operator: in
property: app
values:
- salesforce
- zoom
schema:
properties:
filter:
properties:
rules:
items:
properties:
app:
description: Application name.
example: salesforce
type: string
edge_location_display_name:
description: Prisma Access Location.
example: US West
type: string
event_time:
description: Time of the event.
example: 1678886400000
type: number
type: object
required:
- event_time
type: array
type: object
type: object
required: true
responses:
'200':
content:
application/json:
schema:
properties:
app:
description: Application name.
example: salesforce
type: string
avg_throughput:
description: Average throughput in bytes per second.
example: 1000000.0
format: float
type: number
total_data_transfer:
description: Total data transferred in bytes.
example: 1000000000.0
format: float
type: number
type: object
description: OK
'400':
description: Resource property is not valid
'403':
description: Permission Denied
'404':
description: Resource not found
'500':
description: Failed to process request
security:
- Bearer: []
summary: Data Transfer Throughput Per Application
tags:
- Application API
/insights/v3.0/resource/query/accelerated_applications/packet_loss_per_app_histogram:
post:
description: 'Retrieve a histogram of packet loss for specific accelerated applications.
'
operationId: post-insights-v3.0-resource-query-accelerated_applications-packet_loss_per_app_histogram
parameters:
- description: 'Map the region for the tenant.
'
in: header
name: X-PANW-Region
required: true
schema:
example: americas
type: string
- description: 'Use a unique Prisma-Tenant identifier for precise tenant management and resource allocation within single or multi-tenant architectures.
'
in: header
name: Prisma-Tenant
required: false
schema:
example: 12345678:12345679
type: string
requestBody:
content:
application/json:
examples:
With mandatory filters:
value:
filter:
rules:
- operator: last_n_hours
property: event_time
values:
- 5
histogram:
enableEmptyInterval: true
property: event_time
range: minute
value: 30
With possible filters:
value:
filter:
rules:
- operator: last_n_hours
property: event_time
values:
- 5
- operator: in
property: edge_location_display_name
values:
- US West
- operator: in
property: app_accelerated
values:
- true
- false
- operator: in
property: app
values:
- Zoom
- Salesforce
histogram:
enableEmptyInterval: true
property: event_time
range: minute
value: 30
schema:
properties:
filter:
properties:
rules:
items:
properties:
app:
description: Application Name
example: Zoom
type: string
app_accelerated:
description: Whether the application is accelerated.
example: true
type: boolean
edge_location_display_name:
description: Prisma Access Locations
example: US West
type: string
event_time:
description: Time of the event.
example: 5
type: number
type: object
required:
- event_time
type: array
type: object
histogram:
properties:
enableEmptyInterval:
description: Whether to enable empty intervals in the histogram.
example: true
type: boolean
property:
description: The property to create a histogram for.
example: event_time
type: string
range:
description: The range for the histogram.
example: minute
type: string
value:
description: The value for the histogram range.
example: 30
type: integer
type: object
type: object
required: true
responses:
'200':
content:
application/json:
schema:
properties:
app:
description: Application Name
example: Zoom
type: string
event_time:
description: Event time
example: 1709226000000
type: number
packet_loss:
description: Packet loss percentage
example: 0.05
format: float
type: number
type: object
description: OK
'400':
description: Resource property is not valid
'403':
description: Permission Denied
'404':
description: Resource not found
'500':
description: Failed to process request
security:
- Bearer: []
summary: Packet Loss Per Application Histogram
tags:
- Application API
/insights/v3.0/resource/query/accelerated_applications/performance_boost:
post:
description: 'Retrieve performance boost metrics for accelerated applications.
'
operationId: post-insights-v3.0-resource-query-accelerated_applications-performance_boost
parameters:
- description: 'Map the region for the tenant.
'
in: header
name: X-PANW-Region
required: true
schema:
example: americas
type: string
- description: 'Use a unique Prisma-Tenant identifier for precise tenant management and resource allocation within single or multi-tenant architectures.
'
in: header
name: Prisma-Tenant
required: false
schema:
example: 12345678:12345679
type: string
requestBody:
content:
application/json:
examples:
With mandatory filters:
value:
filter:
rules:
- operator: last_n_hours
property: event_time
values:
- 5
With possible filters:
value:
filter:
rules:
- operator: last_n_hours
property: event_time
values:
- 5
- operator: in
property: edge_location_display_name
values:
- US West
- operator: equals
property: app_accelerated
values:
- true
schema:
properties:
filter:
properties:
rules:
items:
properties:
app_accelerated:
description: Whether the application is accelerated.
example: true
type: boolean
edge_location_display_name:
description: Prisma Access Location.
example: US West
type: string
event_time:
description: Time of the event.
example: 5
type: number
type: object
required:
- event_time
type: array
type: object
type: object
required: true
responses:
'200':
content:
application/json:
schema:
properties:
performance_boost:
description: Performance boost metric.
example: 0.15
format: float
type: number
type: object
description: OK
'400':
description: Resource property is not valid
'403':
description: Permission Denied
'404':
description: Resource not found
'500':
description: Failed to process request
security:
- Bearer: []
summary: Performance Boost Data for Applications
tags:
- Application API
/insights/v3.0/resource/query/accelerated_applications/rtt_variance_histogram:
post:
description: 'Retrieve a histogram of RTT variance metrics for accelerated applications.
'
operationId: post-insights-v3.0-resource-query-accelerated_applications-rtt_variance_histogram
parameters:
- description: 'Map the region for the tenant.
'
in: header
name: X-PANW-Region
required: true
schema:
exampl
# --- truncated at 32 KB (183 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-application-api-api-openapi.yml