Skip to main content
farhanahmed
Staff
Staff
December 31, 2024

Technical Tip: How to create SSIDs in AP Manager using JSON API

  • December 31, 2024
  • 0 replies
  • 330 views
Description This article describes how to add SSIDs (vap) in AP Manager using JSON API.
Scope FortiManager, AP Manager, JSON-API.
Solution

The SSID(s) in AP Manager can be created using the below API request (with dynamic mapping):

{
 "method": "add",
    "params": [
        {
            "data": {
                "name": "{{NAME}}",
                "_centmgmt": 1,
                "_is_factory_setting": 0,
                "address-group-policy": 0,
                "broadcast-ssid": 1,
                "captive-portal": 0,
                "dhcp-address-enforcement": 0,
                "dhcp-lease-time": 2400,
                "dynamic-vlan": 0,
                "dynamic_mapping": [
                    {
                        "_scope": [
                            {
                                "name": "{{FORTIGATE-NAME}}",
                                "vdom": "{{VDOM-NAME}}"
                            }
                        ],
                        "ssid": "{{SSID}}",
                        "utm-status": 0,
                        "vlan-auto": 0,
                        "vlan-pooling": 3,
                        "vlanid": 0,
                        "_intf_ip": [
                            "{{MAPPING_IP_ADDRESS}}",
                            "{{MAPPING_MASK}}"
                        ],
                        "passphrase": [
                            "{{MAPPING_PASSPHRASE}}"
                        ]
                    }
                ],
                "eap-reauth": 0,
                "eap-reauth-intv": 86400,
                "eapol-key-retries": 1,
                "encrypt": 1,
                "gas-fragmentation-limit": 1024,
                "gtk-rekey": 0,
                "gtk-rekey-intv": 86400,
                "high-efficiency": 1,
                "igmp-snooping": 0,
                "intra-vap-privacy": 0,
                "ip": [
                    "{{IP_ADDRESS}}",
                    "{{MASK}}"
                ],
                "local-authentication": 0,
                "local-bridging": 0,
                "local-lan": 1,
                "passphrase": "{{PASSPHRASE}}",
                "security-exempt-list": null,
                "security-obsolete-option": 0,
                "split-tunneling": 0,
                "ssid": "fortinet",
                "vlanid": 0,
                "voice-enterprise": 1
            },
            "url": "pm/config/adom/{{ADOM}}/obj/wireless-controller/vap/"
        }
    ],
    "session": "{{session}}",
    "id": "2"

}

 

Sample output:

 

1.png

 

Verify on GUI:

 

1.png

 

 

Information about all the configurable parameters for SSID creation can be obtained by getting the existing SSIDs:

 

{
  "method": "get",
  "params": [
      {
          "url": "pm/config/adom/{{ADOM}}/obj/wireless-controller/vap/"
      }
  ],
  "id": "1",
  "session": "{{session}}"

}


Sample output:

 

1.png

 

Get details of a specific SSID:

 

{
  "method": "get",
  "params": [
      {
          "url": "pm/config/adom/{{ADOM}}/obj/wireless-controller/vap/{{SSID}}"
      }
  ],
  "id": "1",
  "session": "{{session}}"

}


Sample output:

 

1.png

 

Related articles:

Technical Tip: Using FortiManager API

Fortinet Development Network (FNDN) - FortiManager

Troubleshooting Tip: Custom SSID in AP Manager showing as Factory Default.

Technical Tip: How to create IPSec Template and assign to a device using JSON API

Technical Tip: How to create SD-WAN Template and assign to a device using JSON API

Technical Tip: Managing the JSON API call with Postman and how to delete, create and update an ADOM