Retrieve the full configuration details of a APN payload item

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

Get Android APN policy payload

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/androidapnpolicy/payloaditems/{payload_id}

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

profile_idstringMandatory

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

payload_idstringMandatory

Unique identifier of the payload item. Obtain from the Get Payload Item IDs response

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidapnpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Unique identifier of the payload item

sub_configstring

Sub Config. Default: ANDROID_APN_EXTENSION

access_point_namestring

Access Point Name

access_point_user_namestring

Access Point User Name

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

android_apn_extensionJSON Object

Android APN Extension — carrier-specific APN configuration

Show Sub-Attributes
namestring

APN Name

auth_typeinteger

Authentication Type. Default: -1 (None)

serverstring

APN Server address

protocolinteger

Protocol. Default: 0 (IPv4)

mccstring

Mobile Country Code

mncstring

Mobile Network Code

mmscstring

Multimedia Messaging Service Center URL

mms_portinteger

MMS Proxy Port

mms_proxystring

MMS Proxy Server address

typestring

APN Type. Default: default

roaming_protocolinteger

Roaming Protocol. Default: 0 (IPv4)

is_preferred_apnboolean

Whether this is the preferred APN. Default: true

mvnointeger

MVNO Type. Default: -1 (None)

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of APN payload item

Copied!
  {
    "payload_id": 9007199254741000,
    "access_point_user_name": "Zylker User",
    "sub_config": "ANDROID_APN_EXTENSION",
    "proxy_server": "10.0.0.1",
    "access_point_name": "Zylker User",
    "access_point_password": "********",
    "android_apn_extension": {
      "auth_type": -1,
      "protocol": 0,
      "name": "Corporate APN",
      "type": "default",
      "is_preferred_apn": true
    },
    "access_point_password_id": 1,
    "proxy_server_port": 8080
  }
                
Show full

Duration: 1 minute | Threshold: 120 | 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.