Add a new Wi-Fi payload configuration to an existing profile

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

To create Wifi policy

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/wifipolicy

Scope

MDMDeviceMgmt.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

profile_idstringMandatory

Unique identifier of the profile. Obtain from the Create Profile or Get Profiles response

- Request Body

application/json
JSON Object
Hide Sub-Attributes
sub_configstringOptional

Sub Config. Default: WIFI_NON_ENTERPRISE

service_set_identifierstringMandatory

Service Set Identifier

auto_joinbooleanOptional

Auto Join. Default: true

hidden_networkbooleanMandatory

Hidden Network. Default: false

security_typeintegerMandatory

WiFi security type. Allowed values: 0=None (Open), 1=WEP (Personal), 2=WPA/WPA2 (Personal), 3=Any (Personal), 4=WEP (Enterprise), 5=WPA/WPA2 (Enterprise), 6=Any (Enterprise), 7=WPA3 (Personal), 8=WPA3 (Enterprise)

wifi_non_enterpriseJSON ObjectOptional

Wifi Non Enterprise

Show Sub-Attributes
wifi_enterpriseJSON ObjectOptional

Wifi Enterprise

Show Sub-Attributes
proxy_typeintegerOptional

Proxy configuration type. Allowed values: 0=None, 1=Manual, 2=Automatic (PAC URL)

proxy_serverstringOptional

Proxy Server

proxy_server_portintegerOptional

Proxy Server Port. Default: 0

proxy_user_namestringOptional

Proxy User Name

proxy_passwordstringOptional

Proxy Password (sensitive - write-only)

proxy_password_idlongOptional

Proxy Password Id

proxy_pac_urlstringOptional

Proxy Pac Url

setup_modesintegerOptional

WiFi setup mode. Allowed values: 1=System mode, 2=Login window mode, 3=Both system and login window

disable_mac_randomizebooleanOptional

Disable Mac Randomize. Default: false

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/wifipolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"wifi_non_enterprise":{},"sub_config":"WIFI_NON_ENTERPRISE","wifi_enterprise":{},"proxy_server":"value","auto_join":true,"hidden_network":false,"proxy_server_port":0,"service_set_identifier":"value","security_type":3,"proxy_type":0}'

Sample Request Body

Add Wi-Fi payload to the profile

Copied!
  {
    "wifi_non_enterprise": {},
    "sub_config": "WIFI_NON_ENTERPRISE",
    "wifi_enterprise": {},
    "proxy_server": "value",
    "auto_join": true,
    "hidden_network": false,
    "proxy_server_port": 0,
    "service_set_identifier": "value",
    "security_type": 3,
    "proxy_type": 0
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
payload_idlong

Unique identifier for the created payload item

sub_configstring

Sub Config. Default: WIFI_NON_ENTERPRISE

service_set_identifierstring

Service Set Identifier

auto_joinboolean

Auto Join. Default: true

hidden_networkboolean

Hidden Network. Default: false

security_typeinteger

WiFi security type. Allowed values: 0=None (Open), 1=WEP (Personal), 2=WPA/WPA2 (Personal), 3=Any (Personal), 4=WEP (Enterprise), 5=WPA/WPA2 (Enterprise), 6=Any (Enterprise), 7=WPA3 (Personal), 8=WPA3 (Enterprise)

wifi_non_enterpriseJSON Object

Wifi Non Enterprise

Show Sub-Attributes
wifi_enterpriseJSON Object

Wifi Enterprise

Show Sub-Attributes
proxy_typeinteger

Proxy configuration type. Allowed values: 0=None, 1=Manual, 2=Automatic (PAC URL)

proxy_serverstring

Proxy Server

proxy_server_portinteger

Proxy Server Port. Default: 0

proxy_user_namestring

Proxy User Name

proxy_passwordstring

Proxy Password (sensitive - write-only)

proxy_password_idlong

Proxy Password Id

proxy_pac_urlstring

Proxy Pac Url

setup_modesinteger

WiFi setup mode. Allowed values: 1=System mode, 2=Login window mode, 3=Both system and login window

disable_mac_randomizeboolean

Disable Mac Randomize. Default: false

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Wi-Fi payload successfully added

Copied!
  {
    "payload_id": 9007199254741000,
    "wifi_non_enterprise": {},
    "sub_config": "WIFI_NON_ENTERPRISE",
    "wifi_enterprise": {},
    "proxy_server": "value",
    "auto_join": true,
    "hidden_network": false,
    "proxy_server_port": 0,
    "service_set_identifier": "value",
    "security_type": 3,
    "proxy_type": 0
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.