Retrieve the list of payload types configured within a 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

Get the payload details of the profile

Request URL

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

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

Sample Request

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

Response Parameters

- HTTP code 200

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

List of payload type names in the profile

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

List of payload types in the profile

Copied!
  {
    "payloads": [
      "restrictionspolicy",
      "passcodepolicy"
    ]
  }
                
Show full

No payloads configured in the profile

Copied!
  {
    "payloads": []
  }
                
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.