Retrieve the full configuration details of a System Preference 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 System Preference policy payload item

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/macsystempreference/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/macsystempreference/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
enabled_preferencesJSON Array

List of enabled preference panes (by bundle identifier)

Show Sub-Attributes
JSON Object
Show Sub-Attributes
bundle_idstring

Bundle identifier of the preference pane

disabled_preferencesJSON Array

List of disabled preference panes (by bundle identifier)

Show Sub-Attributes
JSON Object
Show Sub-Attributes
bundle_idstring

Bundle identifier of the preference pane

hidden_preferencesJSON Array

List of hidden preference panes (by bundle identifier)

Show Sub-Attributes
JSON Object
Show Sub-Attributes
bundle_idstring

Bundle identifier of the preference pane

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of System Preference payload item

Copied!
  {
    "payload_id": 6967000001030056,
    "hidden_preferences": [
      {
        "bundle_id": "com.apple.preference.sound"
      }
    ],
    "enabled_preferences": [
      {
        "bundle_id": "com.apple.preference.general"
      }
    ],
    "disabled_preferences": [
      {
        "bundle_id": "com.apple.preference.displays"
      }
    ]
  }
                
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.