Retrieve the full configuration details of a Restrictions payload item

To get Mac Restrictions policy payload item

Endpoints

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

Copy full URL

Request URL

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

allow_game_centerboolean

Allow Game Center. Default: true

allow_modifi_wallpaperboolean

Allow Modifi Wallpaper. Default: true

allow_use_of_cameraboolean

Allow Use Of Camera. Default: true

allow_cloud_document_syncboolean

Allow Cloud Document Sync. Default: true

allow_cloud_keychain_syncboolean

Allow Cloud Keychain Sync. Default: true

allow_touch_idboolean

Allow Touch Id. Default: true

safari_allow_autofillboolean

Safari Allow Autofill. Default: true

allow_spotlight_resultboolean

Allow Spotlight Result. Default: true

force_assist_profanity_filterboolean

Force Assist Profanity Filter. Default: false

allow_activity_continuationboolean

Allow Activity Continuation. Default: true

allow_dictionary_lookupboolean

Allow Dictionary Lookup. Default: true

allow_music_serviceboolean

Allow Music Service. Default: true

allow_screen_captureboolean

Allow Screen Capture. Default: true

allow_classroom_remoteviewboolean

Allow Classroom Remoteview. Default: true

force_classroom_auto_joinboolean

Force Classroom Auto Join. Default: false

force_classroom_appdevicelockboolean

Force Classroom Appdevicelock. Default: false

force_classroom_remoteviewboolean

Force Classroom Remoteview. Default: false

allow_password_autofillboolean

Allow Password Autofill. Default: true

allow_password_proximityboolean

Allow Password Proximity. Default: true

allow_password_sharingboolean

Allow Password Sharing. Default: true

allow_cloud_photo_libboolean

Allow Cloud Photo Lib. Default: true

request_to_leave_classroomboolean

Request To Leave Classroom. Default: false

allow_content_cachingboolean

Allow Content Caching. Default: true

allow_itunes_file_sharingboolean

Allow Itunes File Sharing. Default: true

allow_auto_unlockboolean

Allow Auto Unlock. Default: true

allow_cloud_desktop_documentboolean

Allow Cloud Desktop Document. Default: true

allow_cloud_bookmarksboolean

Allow Cloud Bookmarks. Default: true

allow_cloud_mailboolean

Allow Cloud Mail. Default: true

allow_cloud_calenderboolean

Allow Cloud Calender. Default: true

allow_cloud_remindersboolean

Allow Cloud Reminders. Default: true

allow_cloud_addressbookboolean

Allow Cloud Addressbook. Default: true

allow_cloud_notesboolean

Allow Cloud Notes. Default: true

gatekeeper_settingstring

Gatekeeper app source restriction. Allowed values: 1=App Store Only, 2=App Store and Identified Developers, 3=Anywhere, 4=Not Configured. Default: 3

allow_override_gatekeeperboolean

Allow Override Gatekeeper. Default: false

allow_dictationboolean

Allow Dictation. Default: true

allow_assistantboolean

Allow Assistant. Default: true

allow_use_of_ibookstoreboolean

Allow Use Of Ibookstore. Default: true

allow_ibookstore_erotica_mediaboolean

Allow Ibookstore Erotica Media. Default: true

movies_rating_valuestring

Movie content rating filter. Allowed values vary by country. US values: 0=Don't Allow, 100=G, 200=PG, 300=PG-13, 400=R, 500=NC-17, 1000=Allow All Movies. Default: 1000

tv_shows_rating_valuestring

TV show content rating filter. Allowed values vary by country. US values: 0=Don't Allow, 100=TV-Y, 200=TV-Y7, 300=TV-G, 400=TV-PG, 500=TV-14, 600=TV-MA, 1000=Allow All TV Shows. Default: 1000

apps_rating_valuestring

App Store content rating filter. Allowed values vary by country. US values: 0=Don't Allow, 100=4+, 200=9+, 300=12+, 600=17+, 1000=Allow All Apps. Default: 1000

allow_find_my_friendboolean

Allow Find My Friend. Default: true

allow_find_my_deviceboolean

Allow Find My Device. Default: true

allow_erase_content_settingsboolean

Allow Erase Content Settings. Default: true

is_rating_enabledboolean

Is Rating Enabled. Default: false

country_codestring

Country Code. Default: us

allow_cloud_private_relayboolean

Allow Cloud Private Relay. Default: true

allow_usb_restriction_modeboolean

Allow Usb Restriction Mode. Default: true

allow_universal_controlboolean

Allow Universal Control. Default: true

allow_profile_installationboolean

Allow Profile Installation. Default: true

allow_rapid_security_response_installationboolean

Allow Rapid Security Response Installation. Default: true

allow_rapid_security_response_removalboolean

Allow Rapid Security Response Removal. Default: true

allow_airdropboolean

Allow Airdrop. Default: true

allow_bluetooth_modificationboolean

Allow Bluetooth Modification. Default: true

bluetooth_settingstring

Bluetooth setting. Allowed values: 0=Off, 1=On, 2=Not Configured

allow_marketplace_app_installationboolean

Allow Marketplace App Installation. Default: true

allow_web_distribution_app_installationboolean

Allow Web Distribution App Installation. Default: true

allow_modifi_passcodeboolean

Allow Modifi Passcode. Default: true

allow_diagnostic_submissionboolean

Allow Diagnostic Submission. Default: True

allow_apple_personalized_adsboolean

Allow Apple Personalized Ads. Default: True

allow_iphone_mirroringboolean

Allow Iphone Mirroring. Default: True

allow_modifi_device_nameboolean

Allow Modifi Device Name. Default: True

allow_cloud_freeformboolean

Allow Cloud Freeform. Default: True

enforced_fingerprint_timeoutstring

Enforced Fingerprint Timeout. Default: 172800

allow_modify_touch_idboolean

Allow Modify Touch Id. Default: True

allow_printer_sharing_modificationboolean

Allow Printer Sharing Modification. Default: True

allow_file_sharing_modificationboolean

Allow File Sharing Modification. Default: True

allow_internet_sharing_modificationboolean

Allow Internet Sharing Modification. Default: True

allow_bluetooth_sharing_modificationboolean

Allow Bluetooth Sharing Modification. Default: True

allow_time_machine_backupboolean

Allow Time Machine Backup. Default: True

allow_multiplayer_gamingboolean

Allow Multiplayer Gaming. Default: True

allow_local_user_creationboolean

Allow Local User Creation. Default: True

airplay_incoming_requestboolean

Airplay Incoming Request. Default: True

allow_account_modificationboolean

Allow Account Modification. Default: True

allow_ard_remote_management_modificationboolean

Allow Ard Remote Management Modification. Default: True

allow_startup_disk_modificationboolean

Allow Startup Disk Modification. Default: True

allow_remote_apple_events_modificationboolean

Allow Remote Apple Events Modification. Default: True

allow_image_playgroundboolean

Allow Image Playground. Default: True

allow_writing_toolsboolean

Allow Writing Tools. Default: True

allow_external_intelligence_integrationsboolean

Allow External Intelligence Integrations. Default: True

force_delayed_software_updatesboolean

Force Delayed Software Updates. Default: False

force_delayed_app_software_updatesboolean

Force Delayed App Software Updates. Default: False

force_delayed_major_software_updatesboolean

Force Delayed Major Software Updates. Default: False

software_update_delaystring

Software Update Delay. Default: 30

software_update_minor_os_deferred_install_delaystring

Software Update Minor Os Deferred Install Delay. Default: 30

software_update_major_os_deferred_install_delaystring

Software Update Major Os Deferred Install Delay. Default: 30

software_update_non_os_deferred_install_delaystring

Software Update Non Os Deferred Install Delay. Default: 30

allow_external_intelligence_integrations_signinboolean

Allow External Intelligence Integrations Signin. Default: True

allow_mail_summaryboolean

Allow Mail Summary. Default: True

allow_notes_transcription_summaryboolean

Allow Notes Transcription Summary. Default: True

allow_external_intelligence_workspace_idsstring

Allow External Intelligence Workspace Ids

force_bypass_screen_capture_alertboolean

Force Bypass Screen Capture Alert. Default: False

allow_media_sharing_modificationboolean

Allow Media Sharing Modification. Default: False

allow_apple_intelligence_reportboolean

Allow Apple Intelligence Report. Default: True

allow_mail_smart_repliesboolean

Allow Mail Smart Replies. Default: True

allow_safari_summaryboolean

Allow Safari Summary. Default: True

allow_safari_private_browsingboolean

Allow Safari Private Browsing. Default: True

allow_safari_history_clearingboolean

Allow Safari History Clearing. Default: True

allow_add_game_center_friendboolean

Allow adding Game Center friends. Default: true

allow_airprintboolean

Allow AirPrint. Default: true

allow_airprint_credential_storageboolean

Allow AirPrint credential storage. Default: true

allow_airprint_ibeacon_discoveryboolean

Allow AirPrint iBeacon discovery. Default: true

allow_app_cellular_databoolean

Allow app cellular data modification. Default: true

allow_app_installationboolean

Allow app installation. Default: true

allow_app_removalboolean

Allow app removal. Default: true

allow_assistant_user_contentboolean

Allow Siri user-generated content. Default: true

allow_assistant_when_lockedboolean

Allow Siri when locked. Default: true

allow_auto_app_downloadboolean

Allow automatic app downloads. Default: true

allow_auto_correctionboolean

Allow auto-correction. Default: true

allow_cloud_backupboolean

Allow iCloud backup. Default: true

allow_diag_sub_modificationboolean

Allow diagnostics submission modification. Default: true

allow_enabling_restrictionboolean

Allow enabling restrictions. Default: true

allow_esim_modificationboolean

Allow eSIM modification. Default: true

allow_explicit_contentboolean

Allow explicit content. Default: true

allow_face_timeboolean

Allow FaceTime. Default: true

allow_find_my_friends_modboolean

Allow Find My Friends modification. Default: true

allow_host_pairingboolean

Allow host pairing. Default: true

allow_hotspot_modificationboolean

Allow hotspot modification. Default: true

allow_imessageboolean

Allow iMessage. Default: true

allow_inapp_purchaseboolean

Allow in-app purchase. Default: true

allow_itunesboolean

Allow iTunes. Default: true

allow_keyboard_shortcutboolean

Allow keyboard shortcuts. Default: true

allow_managed_app_cloud_syncboolean

Allow managed app cloud sync. Default: true

allow_managed_app_trustboolean

Allow trusting managed app developers. Default: true

allow_managed_book_backupboolean

Allow managed book backup. Default: true

allow_managed_book_syncboolean

Allow managed book sync. Default: true

allow_managed_write_unmanaged_contactboolean

Allow managed apps to write to unmanaged contacts. Default: true

allow_newsboolean

Allow News. Default: true

allow_open_doc_in_managedboolean

Allow opening documents in managed apps. Default: true

allow_open_doc_in_unmanagedboolean

Allow opening documents in unmanaged apps. Default: true

allow_ota_pki_updatesboolean

Allow OTA PKI updates. Default: true

allow_paired_watchboolean

Allow paired Apple Watch. Default: true

allow_passbook_when_lockedboolean

Allow Wallet when locked. Default: true

allow_photo_streamboolean

Allow Photo Stream. Default: true

allow_podcastsboolean

Allow Podcasts. Default: true

allow_predictive_keyboardboolean

Allow predictive keyboard. Default: true

allow_proximity_for_newdeviceboolean

Allow proximity setup for new devices. Default: true

allow_radio_serviceboolean

Allow Radio Service. Default: true

allow_safariboolean

Allow Safari. Default: true

allow_shared_streamboolean

Allow shared Photo Stream. Default: true

allow_siri_loggingboolean

Allow Siri server logging. Default: true

allow_spellcheckboolean

Allow spellcheck. Default: true

allow_sync_while_roamingboolean

Allow sync while roaming. Default: true

allow_unmanaged_read_managed_contactboolean

Allow unmanaged apps to read managed contacts. Default: true

allow_untrusted_tls_promptboolean

Allow untrusted TLS prompt. Default: true

allow_use_of_youtubeboolean

Allow use of YouTube. Default: true

allow_voice_dialingboolean

Allow voice dialing. Default: true

allow_vpn_creationboolean

Allow VPN creation. Default: true

allowCloudAddressBookboolean

Allow iCloud Address Book sync. Default: true

authenticate_before_autofillboolean

Require authentication before autofill. Default: false

force_airdrop_unmanagedboolean

Treat AirDrop as unmanaged destination. Default: false

force_airplay_incoming_pwdboolean

Force password for incoming AirPlay requests. Default: false

force_airplay_outgoing_pwdboolean

Force password for outgoing AirPlay requests. Default: false

force_airprint_tlsboolean

Force AirPrint to use TLS. Default: false

force_date_timeboolean

Force automatic date and time. Default: false

force_encrypted_backupboolean

Force encrypted backup. Default: false

force_istore_pwd_entryboolean

Force iTunes Store password entry. Default: false

force_limited_ad_trackingboolean

Force limited ad tracking. Default: false

force_watch_wrist_detectboolean

Force Apple Watch wrist detection. Default: false

force_wifi_whitelistingboolean

Force WiFi whitelisting. Default: false

safari_allow_javascriptboolean

Safari allow JavaScript. Default: true

safari_allow_popupsboolean

Safari allow pop-ups. Default: true

safari_force_fraud_warningboolean

Safari force fraud warning. Default: true

show_control_centerboolean

Show Control Center on lock screen. Default: true

show_notification_centerboolean

Show Notification Center on lock screen. Default: true

show_today_viewboolean

Show Today View on lock screen. Default: true

hotspot_settingstring

Personal hotspot setting. Allowed values: 0=Disable, 1=Enable

safari_accept_cookiesstring

Safari cookie acceptance policy. Allowed values: 0=Always, 1=Never, 1.5=From visited sites, 2=From current website only

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of Restrictions payload item

Copied!

  {
    "allow_activity_continuation": true,
    "payload_id": 9007199254741000,
    "safari_allow_autofill": true,
    "force_assist_profanity_filter": false,
    "allow_cloud_document_sync": true,
    "allow_game_center": true,
    "allow_use_of_camera": true,
    "allow_touch_id": true,
    "allow_modifi_wallpaper": true,
    "allow_spotlight_result": true,
    "allow_cloud_keychain_sync": true
  }

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