Retrieve the full configuration details of a Custom Profile 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 Mac Custom profiles payload item

Request URL

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

custom_profile_file_idlong

File ID of the uploaded custom profile. Obtained from the File Upload API response

custom_profile_idlong

Identifier for the custom profile configuration

allow_existing_payloadboolean

Whether existing payload types are allowed to coexist. Default: false

custom_profile_typestring

Custom profile type. Values: 1=Configuration Profile, 2=Custom command, 3=DDM Configuration

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of Custom Profile payload item

Copied!
  {
    "payload_id": 6967000001030056,
    "custom_profile_type": "1",
    "custom_profile_file_id": 6967000001030034,
    "custom_profile_id": 6967000001030045,
    "allow_existing_payload": false
  }
                
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.