Add a new APN payload configuration to an existing profile

Create Android APN profile payload

Endpoints

post /api/v1/mdm/profiles/{profile_id}/payloads/androidapnpolicy

Copy full URL

Request URL

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

Scope

MDMDeviceMgmt.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/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: ANDROID_APN_EXTENSION

access_point_namestringOptional

Access Point Name

access_point_user_namestringOptional

Access Point User Name

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

android_apn_extensionJSON ObjectOptional

Android APN Extension — carrier-specific APN configuration

Show Sub-Attributes

namestringOptional

APN Name

auth_typeintegerOptional

Authentication Type. Default: -1 (None)

serverstringOptional

APN Server address

protocolintegerOptional

Protocol. Default: 0 (IPv4)

mccstringOptional

Mobile Country Code

mncstringOptional

Mobile Network Code

mmscstringOptional

Multimedia Messaging Service Center URL

mms_portintegerOptional

MMS Proxy Port

mms_proxystringOptional

MMS Proxy Server address

typestringOptional

APN Type. Default: default

roaming_protocolintegerOptional

Roaming Protocol. Default: 0 (IPv4)

is_preferred_apnbooleanOptional

Whether this is the preferred APN. Default: true

mvnointegerOptional

MVNO Type. Default: -1 (None)

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidapnpolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"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}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidapnpolicy"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"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}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"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}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/androidapnpolicy", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data.put("sub_config","value");
    data.put("access_point_name","value");
    data.put("access_point_user_name","value");
    data.put("access_point_password","value");
    data.put("access_point_password_id","1");
    data.put("proxy_server","value");
    data.put("proxy_server_port","1");
    data_android_apn_extension=Map();
    data_android_apn_extension.put("name","value");
    data_android_apn_extension.put("auth_type","1");
    data_android_apn_extension.put("server","value");
    data_android_apn_extension.put("protocol","1");
    data_android_apn_extension.put("mcc","value");
    data_android_apn_extension.put("mnc","value");
    data_android_apn_extension.put("mmsc","value");
    data_android_apn_extension.put("mms_port","1");
    data_android_apn_extension.put("mms_proxy","value");
    data_android_apn_extension.put("type","value");
    data_android_apn_extension.put("roaming_protocol","1");
    data_android_apn_extension.put("is_preferred_apn",true);
    data_android_apn_extension.put("mvno","1");
    data.put("android_apn_extension",data_android_apn_extension);

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/androidapnpolicy"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidapnpolicy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"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}'

Sample Request Body

Add APN payload to the profile

Copied!

  {
    "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

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: 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

APN payload successfully added

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: 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.