API Change Log in April 2025
This topic lists the APIs updates in this release.
|
Method |
API |
Description |
|---|---|---|
|
Monitoring > Access Points |
||
|
GET |
/network-monitoring/v1alpha1/aps/{serial-number}/throughput-trends |
This API is used to fetch information about the throughput trend data of an access point. The response includes the amount of data transmitted and received in bits per second for during a given period. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default. |
|
GET |
/network-monitoring/v1alpha1/radios |
This API is used to fetch a list of radios associated with a customer. Each radio in the returned list includes details such as serial number, device name, MAC address, band, status, and current statistics. |
|
GET |
/network-monitoring/v1alpha1/aps/{serial-number}/radios/{radio-number}/channel-utilization-trends |
This API is used to fetch information about radio channel utilization that includes transmitting, receiving (rx), and Non-Wi-Fi interference utilization percentage. The API provides insights into how effectively radio channels are utilized. |
|
GET |
/network-monitoring/v1alpha1/aps/{serial-number}/radios/{radio-number}/channel-quality-trends |
This API is used to fetch information about channel quality for a radio, identified by radio numbers over a specified time period. |
|
GET |
/network-monitoring/v1alpha1/aps/{serial-number}/radios/{radio-number}/noise-floor-trends |
This API is used to fetch information about noise floor for a radio, identified by radio numbers over a specified time period. |
|
GET |
/network-monitoring/v1alpha1/aps/{serial-number}/radios/{radio-number}/frames-trends |
This API is used to fetch information about the transmission trends of drops, and retries frames. |
|
GET |
/network-monitoring/v1alpha1/aps/{serial-number}/cpu-utilization-trends |
This API is used to fetch information about the CPU utilization of an AP for the time range specified in the startTime and endTime parameter. |
|
GET |
/network-monitoring/v1alpha1/aps/{serial-number}/memory-utilization-trends |
This API is used to fetch information about the memory utilization of an AP for the time range specified in the startTime and endTime parameter. |
|
GET |
/network-monitoring/v1alpha1/aps/{serial-number}/power-consumption-trends |
This API is used to fetch information about power consumption trend data for a specified access point. The data is obtained based on the timestamp range provided in the filter. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default. |
|
GET |
/network-monitoring/v1alpha1/aps/{serial-number}/ports/{port-index}/frames-trends |
This API is used to fetch information about frame trends of a specific access point port that is linked to a particular site. It provides key metrics such as errors, drops, error percentage, and drop percentage, for a given port index. |
|
GET |
/network-monitoring/v1alpha1/aps/{serial-number}/ports/{port-index}/crc-trends |
This API is used to fetch information about Cyclic Redundancy Check (CRC) frame trends of a specific access point port that is linked to a particular site. It provides key metrics such as CRC errors and percentage for a given port index. |
|
GET |
/network-monitoring/v1alpha1/aps/{serial-number}/ports/{port-index}/collisions-trends |
This API is used to fetch information about collision data frame trends of a specific access point port that is linked to a particular site. It provides key metrics such as collision errors and percentage for a given port index. |
|
GET |
/network-monitoring/v1alpha1/aps/{serial-number}/throughput-trends |
This API is used to fetch information about throughput trend data for the specific access point, including transmitted(tx) and received(rx) data in bits per second. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default. |
|
GET |
/network-monitoring/v1alpha1/aps/{serial-number}/radios/{radio-number}/throughput-trends |
This API is used to fetch information about the throughput trend data for a specific radio of an access point, including transmitted and received data in bits per second. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default. |
|
GET |
/network-monitoring/v1alpha1/aps/{serial-number}/ports/{port-index}/throughput-trends |
This API is used to fetch information about throughput trend data for a specific port of an access point, including transmitted and received data in bits per second. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default. |
|
GET |
/network-monitoring/v1alpha1/aps/{serial-number}/wlans/{wlan-name}/throughput-trends |
This API is used to fetch information about throughput trend data for a specific WLAN of an access point, including transmitted and received data in bits per second. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default. |
|
Monitoring > IDPS |
||
|
GET |
/network-monitoring/v1alpha1/threats |
This API is used to fetch the list of threats detected by the Suricata engine in the gateways. |
|
GET |
/network-monitoring/v1alpha1/threats/{id} |
This API is used to fetch details information of a specific threat based on the threat ID. |
|
Monitoring > Site Health |
||
|
GET |
/network-monitoring/v1alpha1/sites-health |
This API is used to fetch information about the list of sites. The response includes information such as site-id's, health of the site, and overview of device, client and alerts-related to the specific site is displayed. |
|
GET |
/network-monitoring/v1alpha1/site-health/{site-id} |
This API is used to fetch information about a specific site health. |
|
GET |
/network-monitoring/v1alpha1/sites-device-health |
This API is used to fetch the list of sites with the number of poor, fair, and good performing devices for each site. |
|
GET |
/network-monitoring/v1alpha1/tenant-device-health |
This API is used to fetch information about the health overview of devices categorized as poor, fair or good performing, for each device type (e.g. Switches, Gateways, Access Points) under the customer. |
|
Monitoring > Gateways |
||
|
GET |
GET /network-monitoring/v1alpha1/gateways/{serial-number}/vlans |
This API is used to fetch the list of VLANs configured in the specified gateway. |
|
GET |
/network-monitoring/v1alpha1/gateways/{serial-number}/vlans/{vlan-id} |
This API is used to fetch information about a specific VLAN configured in a specified gateway. |
|
GET |
/network-monitoring/v1alpha1/gateways/{serial-number}/interfaces |
This API is used to fetch a list of wired interfaces present in the specified gateway based on the query parameters provided. |
|
GET |
/network-monitoring/v1alpha1/gateways/{serial-number}/tunnels/lan/{tunnel-id}/detail |
This API is used to fetch information about the tunnel configured in a specific gateway. |
|
GET |
/network-monitoring/v1alpha1/cluster/{cluster-name}/tunnels |
This API is used to fetch the list of tunnels present in a specified cluster based on the query parameters provided. |
|
GET |
/network-monitoring/v1alpha1/cluster/{cluster-name}/members |
This API is used to fetch the list of gateway members present in the specified cluster based on the query parameters provided. |
|
GET |
/network-monitoring/v1alpha1/cluster/{cluster-name}/leader |
This API is used to fetch about the leader of gateway cluster. It provides gateway-related details such as MAC address, name, status, software Version, etc. |
|
GET |
/network-monitoring/v1alpha1/cluster/{cluster-name}/vlan-mismatch |
This API is used to fetch information on VLANs categorized as good or poor, either for the entire cluster or for individual gateways within the cluster. |
|
GET |
/network-monitoring/v1alpha1/cluster/{cluster-name}/connectivity-graph |
This API is used to fetch information about the gateways in a cluster, including their peers and any VLAN mismatches. |
|
Reporting > Reporting |
||
|
GET |
GET /network-reporting/v1alpha1/reports/health |
This API is used to check the health status of the network reporting service. |
|
GET |
/network-reporting/v1alpha1/reports |
This API is used to fetch a list of user reports, based on the query parameters provided. |
|
POST |
/network-reporting/v1alpha1/reports |
This API is used to create reports based on various filters, report periods, and scheduling options. The reports can be scheduled for one-time or recurring execution and sent via email in multiple formats. |
|
PUT and DELETE |
/network-reporting/v1alpha1/reports/{report-id} |
These APIs are used to update or delete a user report with report-id. Report ID can be obtained by executing the GET /network-reporting/v1alpha1/reports (List Reports) API call. |
|
GET |
/network-reporting/v1alpha1/reports/{report-id}/report-runs |
This API is used to fetch a list of report run using the report ID. A report run includes details such as its report run ID, status, export information, start timestamp, and end timestamp. |
|
DELETE |
/network-reporting/v1alpha1/reports/{report-id}/report-runs/{report-run-id} |
This API is used to delete a specific report run with the report ID. |
|
GET |
/network-reporting/v1alpha1/reports/{report-id}/report-executions/{report-run-id}/download-link |
This API is used to fetch a downloadable link for a previously generated report run. Users can specify the export file format (CSV or PDF). |