Retrieve the full configuration details of a Email 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

To get Email policy payload item

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/emailpolicy/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

- Query Parameters

includestringOptional

Comma-separated list of related fields to include in the response (e.g., assigned_to, payload_details). When omitted, only top-level fields are returned

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/emailpolicy/payloaditems/{payload_id}?include=payloaditems' \
  --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

account_namestring

Account Name

account_typestring

Account Type. Default: IMAP

account_path_prefixstring

Account Path Prefix

account_user_namestring

Account User Name

mail_addressstring

Mail Address

allow_moveboolean

Allow Move. Default: true

prevent_moveboolean

Prevent Move. Default: false

disable_mail_recents_syncingboolean

Disable Mail Recents Syncing. Default: false

incoming_server_hostnamestring

Incoming Server Hostname

incoming_server_portinteger

Incoming Server Port. Default: 143

incoming_server_usernamestring

Incoming Server Username

incoming_server_authstring

Incoming Server Auth. Allowed values: none, password, md5, ntlm, httpmd5. Default: password

incoming_passwordstring

Incoming Password (sensitive - write-only)

incoming_password_idlong

Incoming Password Id

incoming_server_use_sslboolean

Incoming Server Use Ssl. Default: false

outgoing_server_hostnamestring

Outgoing Server Hostname

outgoing_server_portinteger

Outgoing Server Port. Default: 587

outgoing_server_usernamestring

Outgoing Server Username

outgoing_server_authstring

Outgoing Server Auth. Allowed values: none, password, md5, ntlm, httpmd5. Default: password

outgoing_passwordstring

Outgoing Password (sensitive - write-only)

outgoing_password_idlong

Outgoing Password Id

outgoing_pwd_as_income_pwdboolean

Outgoing Pwd As Income Pwd. Default: false

use_only_mail_appboolean

Use Only Mail App. Default: false

outgoing_server_use_sslboolean

Outgoing Server Use Ssl. Default: false

use_mime_encryptboolean

Use Mime Encrypt. Default: false

signing_cert_idlong

Signing identity certificate ID obtained from the Certificates API.

encryption_cert_idlong

Encryption identity certificate ID obtained from the Certificates API.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of Email payload item

Copied!
  {
    "prevent_move": false,
    "payload_id": 9007199254741000,
    "account_type": "IMAP",
    "disable_mail_recents_syncing": false,
    "incoming_server_username": "user@zylker.com",
    "outgoing_server_username": "user@zylker.com",
    "allow_move": true,
    "incoming_server_hostname": "https://zylker.com",
    "outgoing_server_hostname": "smtp.zylker.com",
    "account_user_name": "Zylker User",
    "account_path_prefix": "value",
    "account_name": "Zylker User",
    "incoming_server_auth": "password",
    "mail_address": "user@zylker.com",
    "outgoing_server_auth": "password",
    "incoming_server_port": 143
  }
                
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.