openapi: 3.2.0 info: contact: email: support@paloaltonetworks.com description: 'This Open API spec file represents the APIs available for [Palo Alto Networks Aggregate Monitoring](https://docs.paloaltonetworks.com/NEED-URL) APIs. After you have configured your tenants, these APIs can be used to perform aggregated monitoring queries for information about applications, threats, URLs, and licenses across all your tenants of a Prisma Access or Prisma SD-WAN instance. 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 October 01, 2024. To check for a more recent version of this file, see [Aggregate Monitoring APIs on pan.dev](https://pan.dev/sase/api/mt-monitor/). © 2024 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. ' title: Aggreagate Monitoring Data Resource API API version: '1.0' servers: - url: https://api.sase.paloaltonetworks.com tags: - description: "Data Resource \n" name: Data Resource API paths: /mt/monitor/v1/agg/alerts: post: description: "Retrieve an aggregated count of alerts across tenants. \n" operationId: post-mt-monitor-v1-agg-alerts parameters: - description: 'Must be `tenant`. Using the query parameter returns all the aggregated responses for the current parent tenant and its child tenants. If not used, the results for just the current tenant are returned. ' example: tenant in: query name: agg_by schema: type: string - description: "Must be one of the following: `de`, `americas`, `europe`, `uk`, `sg`, `ca`, `jp`, `au`, `in`. Returns details from the Cortex Data Lake (CDL) region specified. If no region is specified, the default response is `americas` CDL region. \n" example: americas in: header name: X-PANW-Region schema: type: string requestBody: content: application/json: examples: Alerts Count By Tenant: value: filter: operator: AND rules: - operator: in property: domain values: - External - external - operator: last_n_days property: updated_time values: - 7 properties: - property: sub_tenant_id - alias: count function: count property: alert_id Alerts Distribution By Severity: value: filter: operator: AND rules: - operator: in property: domain values: - External - external - operator: last_n_days property: updated_time values: - 7 properties: - property: severity - alias: count function: count property: alert_id sort: order: desc Alerts Trend: value: filter: operator: AND rules: - operator: in property: domain values: - External - external - operator: last_n_days property: updated_time values: - 7 histogram: enableEmptyInterval: false property: updated_time range: day value: '1' properties: - alias: count function: count property: alert_id sort: order: desc schema: $ref: '#/components/schemas/RequestBody_Resource' responses: '200': content: application/json: examples: Alerts Count By Tenant: value: - count: 10 sub_tenant_id: Alerts Distribution By Severity: value: - count: 3 severity: Alerts Trend: value: - count: 1 updated_time: 1657238400000 - count: 1 updated_time: 1657411200000 description: Success '400': description: Bad Request '500': description: Server Error security: - Bearer: [] summary: List alert count tags: - Data Resource API /mt/monitor/v1/agg/alerts/list: post: description: "Retrieve an aggregated list of alert counts by source across tenants. \n" operationId: post-mt-monitor-v1-agg-alerts-list parameters: - description: 'Must be `tenant`. Using the query parameter returns all the aggregated responses for the current parent tenant and its child tenants. If not used, the results for just the current tenant are returned. ' example: tenant in: query name: agg_by schema: type: string - description: "Must be one of the following: `de`, `americas`, `europe`, `uk`, `sg`, `ca`, `jp`, `au`, `in`. Returns details from the Cortex Data Lake (CDL) region specified. If no region is specified, the default response is `americas` CDL region. \n" example: americas in: header name: X-PANW-Region schema: type: string requestBody: content: application/json: examples: Alerts Count By Source: value: filter: operator: AND rules: - operator: in property: domain values: - External - external - operator: last_n_days property: event_time values: - 7 properties: - property: total_count - property: mu_count - property: rn_count - property: sc_count schema: $ref: '#/components/schemas/RequestBody_Alert' responses: '200': content: application/json: examples: Alerts Count By Source: value: - mu_count: 10 rn_count: 10 sc_count: 10 total_count: 10 description: Success '400': description: Bad Request '500': description: Server Error security: - Bearer: [] summary: List alerts by source tags: - Data Resource API /mt/monitor/v1/agg/applicationUsage: post: description: "Retrieve a list of application usage by application type. \n" operationId: post-mt-monitor-v1-agg-applicationusage parameters: - description: "Must be `tenant`. Using the query parameter returns all the aggregated responses for the current parent tenant and its child tenants. If not used, the results for just the current tenant are returned. \n" example: tenant in: query name: agg_by schema: type: string - description: "Must be one of the following: `de`, `americas`, `europe`, `uk`, `sg`, `ca`, `jp`, `au`, `in`. Returns details from the Cortex Data Lake (CDL) region specified. If no region is specified, the default response is `americas` CDL region. \n" example: americas in: header name: X-PANW-Region schema: type: string requestBody: content: application/json: examples: Risky Application Usage Trend: value: filter: operator: AND rules: - operator: last_n_days property: event_time values: - 7 - rule: app_risky histogram: enableEmptyInterval: false property: event_time range: day value: '1' properties: - alias: total_bytes_usage function: sum property: total_bytes Top Application Categories by Data Usage: value: count: 5 filter: operator: AND rules: - operator: is_not_null property: app_sub_category - operator: not_equals property: app_sub_category values: - '' - operator: last_n_days property: event_time values: - 30 properties: - alias: app_usage function: sum property: total_bytes sort: order: desc - property: app_sub_category Top Apps by Data: value: filter: operator: AND rules: - operator: last_n_days property: event_time values: - 30 - operator: is_not_null property: app - operator: not_equals property: app values: - '' properties: - property: app - alias: unique_count function: distinct_count property: app - alias: total_bytes_usage function: sum property: total_bytes schema: $ref: '#/components/schemas/RequestBody_Resource' responses: '200': content: application/json: examples: Risky Application Usage Trend: value: - event_time: