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 Mac Wifi policy

Request URL

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

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

WiFi configuration sub-type indicating the authentication mode. Values: WIFI_NON_ENTERPRISE (personal/PSK networks) or WIFI_ENTERPRISE (802.1X networks). Default: WIFI_NON_ENTERPRISE

service_set_identifierstringMandatory

The network name (SSID) of the WiFi network to connect to

auto_joinbooleanOptional

Whether the device automatically joins this WiFi network when in range. Default: true

hidden_networkbooleanMandatory

Whether the WiFi network is hidden (does not broadcast its SSID). When true, the device will probe for the 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

Configuration object for personal/PSK WiFi networks containing the pre-shared key or WEP password

Show Sub-Attributes
wifi_enterpriseJSON ObjectOptional

Configuration object for 802.1X enterprise WiFi networks containing EAP settings, certificates, and authentication credentials

Show Sub-Attributes
proxy_typeintegerOptional

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

proxy_serverstringOptional

Hostname or IP address of the HTTP proxy server. Required when proxy_type is 1 (Manual)

proxy_server_portintegerOptional

Port number of the HTTP proxy server. Valid range: 0-65535. Default: 0

proxy_user_namestringOptional

Username for proxy server authentication

proxy_passwordstringOptional

Password for proxy server authentication (sensitive - write-only, not returned in responses)

proxy_password_idlongOptional

Internal identifier for the stored proxy password credential

proxy_pac_urlstringOptional

URL of the Proxy Auto-Configuration (PAC) file. Required when proxy_type is 2 (Automatic)

setup_modesintegerOptional

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

disable_mac_randomizebooleanOptional

Whether to disable MAC address randomization for this network. When true, the device uses its real hardware MAC address. Default: false

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macwifipolicy \
  --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

WiFi configuration sub-type indicating the authentication mode. Values: WIFI_NON_ENTERPRISE (personal/PSK networks) or WIFI_ENTERPRISE (802.1X networks). Default: WIFI_NON_ENTERPRISE

service_set_identifierstring

The network name (SSID) of the WiFi network to connect to

auto_joinboolean

Whether the device automatically joins this WiFi network when in range. Default: true

hidden_networkboolean

Whether the WiFi network is hidden (does not broadcast its SSID). When true, the device will probe for the network. Default: false

security_typestring

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

Configuration object for personal/PSK WiFi networks containing the pre-shared key or WEP password

Show Sub-Attributes
wifi_enterpriseJSON Object

Configuration object for 802.1X enterprise WiFi networks containing EAP settings, certificates, and authentication credentials

Show Sub-Attributes
proxy_typestring

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

proxy_serverstring

Hostname or IP address of the HTTP proxy server. Required when proxy_type is 1 (Manual)

proxy_server_portstring

Port number of the HTTP proxy server. Valid range: 0-65535. Default: 0

proxy_user_namestring

Username for proxy server authentication

proxy_passwordstring

Password for proxy server authentication (sensitive - write-only, not returned in responses)

proxy_password_idlong

Internal identifier for the stored proxy password credential

proxy_pac_urlstring

URL of the Proxy Auto-Configuration (PAC) file. Required when proxy_type is 2 (Automatic)

setup_modesstring

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

disable_mac_randomizeboolean

Whether to disable MAC address randomization for this network. When true, the device uses its real hardware MAC address. 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.