Add a new APN 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 APN policy

Request URL

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

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
access_point_namestringMandatory

Access Point Name

access_point_usernamestringOptional

Access Point Username

access_point_passwordstringOptional

Access Point Password (sensitive - write-only)

access_point_password_idlongOptional

Access Point Password Id

proxy_serverstringOptional

Proxy Server

proxy_server_portintegerOptional

Proxy Server Port. Default: 0

enable_xlat464booleanOptional

Enable Xlat464. Default: false

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/apnpolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"enable_xlat464":false,"proxy_server":"value","access_point_name":"Zylker User","access_point_password":"********","access_point_password_id":1,"proxy_server_port":0,"access_point_username":"Zylker User"}'

Sample Request Body

Add APN payload to the profile

Copied!
  {
    "enable_xlat464": false,
    "proxy_server": "value",
    "access_point_name": "Zylker User",
    "access_point_password": "********",
    "access_point_password_id": 1,
    "proxy_server_port": 0,
    "access_point_username": "Zylker User"
  }
                
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

access_point_namestring

Access Point Name

access_point_usernamestring

Access Point Username

access_point_passwordstring

Access Point Password (sensitive - write-only)

access_point_password_idlong

Access Point Password Id

proxy_serverstring

Proxy Server

proxy_server_portinteger

Proxy Server Port. Default: 0

enable_xlat464boolean

Enable Xlat464. Default: false

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

APN payload successfully added

Copied!
  {
    "payload_id": 9007199254741000,
    "enable_xlat464": false,
    "proxy_server": "value",
    "access_point_name": "Zylker User",
    "access_point_password": "********",
    "access_point_password_id": 1,
    "proxy_server_port": 0,
    "access_point_username": "Zylker User"
  }
                
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.