Fortinet black logo

FortiLAN Cloud User Guide

Pagination REST APIs

Pagination REST APIs

The wireless REST APIs and the Switch REST APIs are now aligned with data pagination support. This is especially helpful in organizing huge amounts of data returned for some API queries, into smaller chunks. You can use this feature through the limit (the number of results to return) and offset (where in the dataset to start returning results) approach.

Consider this example, /api/v1/networks/{nwoid}/fap/monitor/stations/?offset=20&limit=10. Here, the API returns the result from the 21st to the 30th items in the dataset and the next page displays the results from the 31st to the 40th items, and so on.

Pagination support is available for the following APIs.

  • /api/v1/inventory/undeployed/

  • /api/v1/inventory/deployed/

  • /api/v1/networks/{nwoid}/fap/monitor/stations

  • /api/v1/networks/{nwoid}/fap/monitor/ble_devices

  • /api/v1/networks/{nwoid}/fap/monitor/detected_aps

  • /api/v1/networks/{nwoid}/fap/monitor/rogue_aps

  • /api/v1/networks/{nwoid}/fap/access_points/

  • /api/v1/networks/{nwoid}/fap/config/change_history

  • /api/v1/networks/{nwoid}/fap/logs/wireless

  • /api/v1/networks/{nwoid}/fap/logs/antivirus

  • /api/v1/networks/{nwoid}/fap/logs/botnet

  • /api/v1/networks/{nwoid}/fap/logs/ips

  • /api/v1/networks/{nwoid}/fap/logs/web_access

  • /api/v1/networks/{nwoid}/fap/logs/app_control

Pagination REST APIs

The wireless REST APIs and the Switch REST APIs are now aligned with data pagination support. This is especially helpful in organizing huge amounts of data returned for some API queries, into smaller chunks. You can use this feature through the limit (the number of results to return) and offset (where in the dataset to start returning results) approach.

Consider this example, /api/v1/networks/{nwoid}/fap/monitor/stations/?offset=20&limit=10. Here, the API returns the result from the 21st to the 30th items in the dataset and the next page displays the results from the 31st to the 40th items, and so on.

Pagination support is available for the following APIs.

  • /api/v1/inventory/undeployed/

  • /api/v1/inventory/deployed/

  • /api/v1/networks/{nwoid}/fap/monitor/stations

  • /api/v1/networks/{nwoid}/fap/monitor/ble_devices

  • /api/v1/networks/{nwoid}/fap/monitor/detected_aps

  • /api/v1/networks/{nwoid}/fap/monitor/rogue_aps

  • /api/v1/networks/{nwoid}/fap/access_points/

  • /api/v1/networks/{nwoid}/fap/config/change_history

  • /api/v1/networks/{nwoid}/fap/logs/wireless

  • /api/v1/networks/{nwoid}/fap/logs/antivirus

  • /api/v1/networks/{nwoid}/fap/logs/botnet

  • /api/v1/networks/{nwoid}/fap/logs/ips

  • /api/v1/networks/{nwoid}/fap/logs/web_access

  • /api/v1/networks/{nwoid}/fap/logs/app_control