Fortinet black logo

FortiLAN Cloud User Guide

Best Practices

Best Practices

Fortinet recommends the following best practices for using the FortiLAN Cloud REST APIs.

  • Use the following query parameters to break large data into chunks for a swift API response.

    • FortiSwitch - Use the page and size query parameters.

    • FortiAP - Use the limit and offset query parameters.

  • The following APIs require the use of query parameters for improved response time and to fetch data using certain filers.

    • /fap/stats/wireless/usage

    • /fap/stats/wireless/usage/top_clients

    • /fap/stats/wireless/usage/top_usernames

    • /fap/stats/wireless/usage/top_usergroups

    • /fap/stats/wireless/usage/top_auths

    • /fap/stats/wireless/usage/top_aps

    • /fap/stats/wireless/usage/top

The following are some example to use query/filter parameters (past_hours, past_days, start_datetime, end_datetime).

  • /fap/stats/wireless/usage/?ap=FP221E5555000558

  • /fap/stats/wireless/usage/?ssid=test

  • /fap/stats/wireless/usage/?auth=wpa2-only-personal

  • /fap/stats/wireless/usage/?client=16:7f:3d:58:b0:43

For more information see the FortiLAN Cloud REST APIs.

Best Practices

Fortinet recommends the following best practices for using the FortiLAN Cloud REST APIs.

  • Use the following query parameters to break large data into chunks for a swift API response.

    • FortiSwitch - Use the page and size query parameters.

    • FortiAP - Use the limit and offset query parameters.

  • The following APIs require the use of query parameters for improved response time and to fetch data using certain filers.

    • /fap/stats/wireless/usage

    • /fap/stats/wireless/usage/top_clients

    • /fap/stats/wireless/usage/top_usernames

    • /fap/stats/wireless/usage/top_usergroups

    • /fap/stats/wireless/usage/top_auths

    • /fap/stats/wireless/usage/top_aps

    • /fap/stats/wireless/usage/top

The following are some example to use query/filter parameters (past_hours, past_days, start_datetime, end_datetime).

  • /fap/stats/wireless/usage/?ap=FP221E5555000558

  • /fap/stats/wireless/usage/?ssid=test

  • /fap/stats/wireless/usage/?auth=wpa2-only-personal

  • /fap/stats/wireless/usage/?client=16:7f:3d:58:b0:43

For more information see the FortiLAN Cloud REST APIs.