Retrieve the full configuration details of a Exchange ActiveSync payload item

Get Android Exchange policy payload

Endpoints

get /api/v1/mdm/profiles/{profile_id}/payloads/androidexchangeactivesyncpolicy/payloaditems/{payload_id}

Copy full URL

Request URL

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

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/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/androidexchangeactivesyncpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

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/androidexchangeactivesyncpolicy/payloaditems/{payload_id}"))
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

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

conn.request("GET", "/api/v1/mdm/profiles/{profile_id}/payloads/androidexchangeactivesyncpolicy/payloaditems/{payload_id}", headers=headers)

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

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


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

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/androidexchangeactivesyncpolicy/payloaditems/{payload_id}"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidexchangeactivesyncpolicy/payloaditems/{payload_id}' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

payload_idlong

Unique identifier of the payload item

account_typeinteger

Exchange account type. 1 = Exchange (default)

account_namestring

Display name for the Exchange account, shown on the device. Default: Corporate E-mail

user_namestring

Username for Exchange authentication. Use %upn% to auto-populate with the user principal name

domainstring

Windows domain for Exchange authentication. Use %domainname% to auto-populate

active_sync_hoststring

Hostname or URL of the Exchange ActiveSync server (required)

email_addressstring

Email address for the Exchange account. Use %email% to auto-populate

passwordstring

Password for Exchange authentication. Write-only; not returned in responses

password_idlong

ID of a stored credential used as the Exchange account password. Use -1 when providing password directly

accept_all_certificatesboolean

Accept all SSL certificates, including self-signed ones, from the Exchange server. Default: true

use_sslboolean

Enable SSL/TLS encryption for the Exchange ActiveSync connection. Default: true

default_accountboolean

Set this as the default email account on the device. Default: true

allow_always_vibrateboolean

Enable vibration for email notifications at all times. Default: false

allow_silent_vibrateboolean

Enable vibration for email notifications when the device is on silent mode. Default: false

sync_mailboolean

Enable synchronization of mail from Exchange. Default: true

sync_calandarboolean

Enable synchronization of calendar events from Exchange. Default: true

sync_contactsboolean

Enable synchronization of contacts from Exchange. Default: true

sync_notesboolean

Enable synchronization of notes from Exchange. Default: true

sync_tasksboolean

Enable synchronization of tasks from Exchange. Default: true

past_days_mail_to_syncinteger

Number of past days of mail to synchronize. 2 = last 3 days, 3 = last week, 4 = last 2 weeks, 5 = last month, 6 = all. Default: 2

identity_cert_idlong

ID of the client identity certificate for mutual TLS authentication. Use -1 for none. Default: -1

past_days_to_calander_syncinteger

Number of past days of calendar events to synchronize. Default: 5

peak_daysinteger

Bitmask of days classified as peak hours (bit 0 = Sunday … bit 6 = Saturday). Default: 0 (no peak schedule)

peak_start_minsinteger

Start time of peak hours, in minutes from midnight (e.g. 480 = 8:00 AM). Default: 8

peak_end_minsinteger

End time of peak hours, in minutes from midnight (e.g. 1020 = 5:00 PM). Default: 17

peak_days_sycn_frequencyinteger

Mail sync frequency in minutes during peak hours. Default: 2

off_peak_days_sycn_frequencyinteger

Mail sync frequency in minutes during off-peak hours. Default: 2

incoming_attachment_max_sizeinteger

Maximum attachment size in KB to download automatically. Use 0 for unlimited. Default: 0

allow_notifyboolean

Enable email push notifications on the device. Default: true

signaturestring

Default email signature appended to outgoing messages

allow_change_mail_settingsboolean

Allow the user to modify mail settings from the device. Default: true

allow_forward_emailboolean

Allow the user to forward emails. Default: true

allow_html_contentboolean

Allow rendering of HTML-formatted email content. Default: true

retrival_sizeinteger

Maximum email body size in KB to retrieve. Use 9 to retrieve the full message. Default: 9

roaming_settingsinteger

Mail sync behavior while roaming. 0 = automatic, 1 = never, 2 = always. Default: 1

primary_client_prefinteger

Preferred client for viewing emails. 1 = MDM Email app, 2 = Device default email app. Default: 1

secondary_client_prefinteger

Secondary email client preference. 1 = MDM Email app, 2 = Device default email app. Default: 1

advancedSettingsboolean

Enable advanced Exchange ActiveSync settings configuration on the device. Default: false

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of Exchange ActiveSync payload item

Copied!

  {
    "account_type": 1,
    "peak_start_mins": 480,
    "signature": "Regards, %username%",
    "user_name": "%upn%",
    "allow_silent_vibrate": false,
    "roaming_settings": 1,
    "default_account": true,
    "past_days_mail_to_sync": 2,
    "off_peak_days_sycn_frequency": 60,
    "password_id": -1,
    "sync_calandar": true,
    "advancedSettings": false,
    "account_name": "Corporate E-mail",
    "allow_html_content": true,
    "peak_end_mins": 1020,
    "secondary_client_pref": 1,
    "peak_days_sycn_frequency": 15,
    "past_days_to_calander_sync": 5,
    "incoming_attachment_max_size": 0,
    "payload_id": 9007199254741000,
    "sync_notes": true,
    "allow_always_vibrate": false,
    "identity_cert_id": -1,
    "use_ssl": true,
    "sync_contacts": true,
    "sync_tasks": true,
    "allow_change_mail_settings": true,
    "allow_notify": true,
    "allow_forward_email": true,
    "sync_mail": true,
    "retrival_size": 9,
    "accept_all_certificates": true,
    "email_address": "%email%",
    "peak_days": 0,
    "primary_client_pref": 1,
    "domain": "%domainname%",
    "active_sync_host": "mail.zylker.com"
  }

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