Fortinet Document Library

Version:

Version:

Version:

Version:


Table of Contents

FortiWiFi and FortiAP Configuration Guide

Download PDF
Copy Link

FortiAP REST API

FortiAP-S and FortiAP-W2 version 6.2.0 and later support REST API calls.

You can access the host at https://<FAP-IP> where <FAP-IP> is the IP address of the FortiAP.

The following REST API calls are supported:

REST API call

HTTP

Path

Description

cfg-get

GET

/api/v1/cfg-get

List effective FortiAP variables.

To filter for specific parameters: /api/v1/cfg-get?names=parameter-name

Examples:

  • Get WTP_NAME: /api/v1/cfg-get?names=WTP_NAME
  • Get WTP_NAME and ADMIN_TIMEOUT: /api/v1/cfg-get?names=WTP_NAME,ADMIN_TIMEOUT

cfg-meta-get

GET

/api/v1/cfg-meta-get

List all variables.

cfg-set

POST

/api/v1/cfg-set

Add or change variables.

logincheck

POST

/logincheck

Log in to FortiAP with/without a password.

logout

POST

/logout

Log out from FortiAP.

radio-cfg

GET

/api/v1/radio-cfg

Get current radios configuration parameters of the control plane.

To get specific radio configuration parameters of the control plane:

  • rcfg info from radio 0: /api/v1/radio-cfg?rId=0
  • rcfg info from radio 1: /api/v1/radio-cfg?rId=1

reboot

POST

/api/v1/reboot

Reboot FortiAP.

sys-perf

GET

/api/v1/sys-perf

Get system performance values (CPU, memory).

sys-status

GET

/api/v1/sys-status

Get system status (fap-get-status).

vap-cfg

GET

/api/v1/vap-cfg

Get current SSIDs of the control plane.

To get the current SSIDs for each independent radios:

  • vcfg info from radio 0: /api/v1/vap-cfg?rId=0
  • vcfg info from radio-1: /api/v1/vap-cfg?rId=1

To get specific SSIDs from specific radios:

  • wlan 0 vcfg info from radio 0: /api/v1/vap-cfg?rId=0&wId=0
  • wlan 1 vcfg info from radio 0: /api/v1/vap-cfg?rId=0&wId=1

wtp-cfg

GET

/api/v1/wtp-cfg

Get current FortiAP configuration parameters of the control plane.

Example request
https://<FAP-IP>/api/v1/sys-perf
Example response
{
 "cpu_usage": 1,
 "memory_usage": 60
}

FortiAP REST API

FortiAP-S and FortiAP-W2 version 6.2.0 and later support REST API calls.

You can access the host at https://<FAP-IP> where <FAP-IP> is the IP address of the FortiAP.

The following REST API calls are supported:

REST API call

HTTP

Path

Description

cfg-get

GET

/api/v1/cfg-get

List effective FortiAP variables.

To filter for specific parameters: /api/v1/cfg-get?names=parameter-name

Examples:

  • Get WTP_NAME: /api/v1/cfg-get?names=WTP_NAME
  • Get WTP_NAME and ADMIN_TIMEOUT: /api/v1/cfg-get?names=WTP_NAME,ADMIN_TIMEOUT

cfg-meta-get

GET

/api/v1/cfg-meta-get

List all variables.

cfg-set

POST

/api/v1/cfg-set

Add or change variables.

logincheck

POST

/logincheck

Log in to FortiAP with/without a password.

logout

POST

/logout

Log out from FortiAP.

radio-cfg

GET

/api/v1/radio-cfg

Get current radios configuration parameters of the control plane.

To get specific radio configuration parameters of the control plane:

  • rcfg info from radio 0: /api/v1/radio-cfg?rId=0
  • rcfg info from radio 1: /api/v1/radio-cfg?rId=1

reboot

POST

/api/v1/reboot

Reboot FortiAP.

sys-perf

GET

/api/v1/sys-perf

Get system performance values (CPU, memory).

sys-status

GET

/api/v1/sys-status

Get system status (fap-get-status).

vap-cfg

GET

/api/v1/vap-cfg

Get current SSIDs of the control plane.

To get the current SSIDs for each independent radios:

  • vcfg info from radio 0: /api/v1/vap-cfg?rId=0
  • vcfg info from radio-1: /api/v1/vap-cfg?rId=1

To get specific SSIDs from specific radios:

  • wlan 0 vcfg info from radio 0: /api/v1/vap-cfg?rId=0&wId=0
  • wlan 1 vcfg info from radio 0: /api/v1/vap-cfg?rId=0&wId=1

wtp-cfg

GET

/api/v1/wtp-cfg

Get current FortiAP configuration parameters of the control plane.

Example request
https://<FAP-IP>/api/v1/sys-perf
Example response
{
 "cpu_usage": 1,
 "memory_usage": 60
}