Prisma SD-WAN monitoring API's

[Swati.Singh22]

We are currently working on bandwidth monitoring for our SD-WAN using the following API endpoint: /sdwan/monitor/v2.0/api/monitor/network_point_metrics_bw

So far, we have been able to successfully retrieve ingress and egress bandwidth use data using the "BandwidthUsage" metric in the request payload.

1. Could you please provide a list of all the other available metrics supported by this endpoint, apart from "BandwidthUsage"?
   Is there any API to aggregate metrics (example across multiple sites/circuits) ?
2. Given the current limitation of 2 API calls per second per object per IP, and since bandwidth data is fetched per circuit per site, are there any recommended practices or alternate API endpoints for fetching site-level aggregated bandwidth capacityinstead of making multiple calls per circuit?
3. Is there official documentation available that provides details on:
1. All supported metrics and parameters for this endpoint?
2. Sample payloads and responses?
3. API usage best practices for large-scale implementations?

[ecraig · Accepted solution]

Do you have the reference to all API calls?

Here is the metrics section:

https://pan.dev/sdwan/api/metrics/

Here is the aggregate bandwidth call:

https://pan.dev/sdwan/api/post-sdwan-monitor-v-2-0-api-monitor-aggregatebandwidth-query/

[Swati.Singh22]

Hi Team,

We are currently using the following API to retrieve bandwidth metrics:
https://api.sase.paloaltonetworks.com/sdwan/monitor/v2.0/api/monitor/network_point_metrics_bw

We're successfully receiving the bandwidth usage data; however, the response does not include the bandwidth capacityas expected.
Could you please clarify whether the API supports returning bandwidth capacity? If so, are there any specific parameters or configurations required to retrieve it?

[ecraig]

Try:

https://pan.dev/sdwan/api/get-sdwan-v-2-9-api-sites-site-id-waninterfaces-wan-interface-id/

Key Fields in Response:

• link_bw_up: The upstream capacity in Mbps.

• link_bw_down: The downstream capacity in Mbps.

• bw_config_mode: Indicates if the capacity is set to auto or manual.

If you want capacity prediction:

https://pan.dev/sdwan/api/post-sdwan-monitor-v-2-0-api-monitor-aiops-forecast/

You will probably need a WAN Clarity Reporting license to get predictive data like this.