# Retrieve the full configuration details of a Restrictions payload item Get Android Restriction policy payload ## Endpoint `GET /api/v1/mdm/profiles/{profile_id}/payloads/androidrestrictionspolicy/payloaditems/{payload_id}` ## Request ### Request URL ```text https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/androidrestrictionspolicy/payloaditems/{payload_id} ``` ### Scope ```text MDMDeviceMgmt.READ ``` ### Header ```text Authorization: d92d4xxxxxxxxxxxxx15f52 ``` ### Request Parameters #### Request Headers | Parameter | Type | Required | Value | |---|---|---|---| | Accept | string | Mandatory | application/json | #### Path Parameters | Parameter | Type | Required | Description | |---|---|---|---| | profile_id | string | Mandatory | Unique identifier of the profile. Obtain from the [Create Profile](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mdm-profiles-create-profile.html) or [Get Profiles](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mdm-profiles-get-profile.html) response | | payload_id | string | Mandatory | Unique identifier of the payload item. Obtain from the [Get Payload Item IDs](https://www.manageengine.com/products/desktop-central/help/api/onpremise/android-get-restrictions-payload-android.html) response | ### Sample Request ```bash curl --request GET \ --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidrestrictionspolicy/payloaditems/{payload_id} \ --header 'Accept: application/json' \ --header 'Authorization: d92d4xxxxxxxxxxxxx15f52' ``` ## Response ### HTTP Code 200 Response body: `application/json` | Parameter | Type | Description | |---|---|---| | payload_id | long | Unique identifier of the payload item | | allow_non_market_app_instal | integer | Whether installing apps from non-market sources is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_disabling_cellular_data | integer | Whether disabling cellular data is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_app_auto_sync | integer | Whether app auto-sync is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_data_while_roaming | integer | Whether data usage while roaming is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_background_data | integer | Whether background data usage is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_bluetooth | integer | Whether Bluetooth is allowed. 0 = Restricted, 1 = Allowed, 4 = User Controlled. Default: 4 | | allow_usb | integer | Whether USB connectivity is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_camera | integer | Whether the camera is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_storage_encryption | integer | Whether storage encryption enforcement is configured. 0 = Allow encryption, 1 = Disable encryption, 2 = Not Configured. Default: 2 | | external_storage_encryption | integer | Whether external storage encryption is required. 0 = Not Required, 1 = Required, 2 = Not Configured. Default: 2 | | allow_nfc | integer | Whether NFC is allowed. 0 = Restricted, 1 = Allowed, 4 = User Controlled. Default: 4 | | allow_disabling_gps | integer | Whether disabling GPS is allowed. 0 = Restricted, 1 = Allowed, 4 = User Controlled. Default: 4 | | allow_microphone | integer | Whether the microphone is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_bluetooth_tethering | integer | Whether Bluetooth tethering is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_wifi | integer | Whether Wi-Fi is allowed. 0 = Restricted, 1 = Allowed, 4 = User Controlled. Default: 4 | | allow_whitelist_wifi_only | integer | Whether only allowlisted Wi-Fi networks are permitted. 0 = All networks allowed, 1 = Allowlisted only. Default: 0 | | allow_wifi_tethering | integer | Whether Wi-Fi tethering (hotspot) is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_usb_tethering | integer | Whether USB tethering is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_tethering | integer | Whether tethering is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_usb_debug | integer | Whether USB debugging is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_sd_card | integer | Whether SD card access is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_sd_card_write | integer | Whether writing to SD card is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_clipboard | integer | Whether clipboard access is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_google_crash_report | integer | Whether Google crash reports are allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_mock_location | integer | Whether mock locations are allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_settings | integer | Whether access to device settings is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_factory_reset | integer | Whether factory reset is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_wallpaper_change | integer | Whether wallpaper changes are allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_statusbar_expansion | integer | Whether status bar expansion is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_ota_upgrade | integer | Whether OTA upgrades are allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_vpn | integer | Whether VPN is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_screen_capture | integer | Whether screen capture is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_power_off | integer | Whether powering off the device is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_usb_media_player | integer | Whether USB media player is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_android_market | integer | Whether the Android Market (Play Store) is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_non_market_apps | integer | Whether non-market apps are allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_personal_space_non_market_apps | integer | Whether non-market apps in personal space are allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_you_tube | integer | Whether YouTube is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_voice_dialer | integer | Whether the voice dialer is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_install_app | integer | Whether app installation is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_uninstall_app | integer | Whether app uninstallation is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_android_browser | integer | Whether the Android browser is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | browser_allow_fraud_warning | integer | Whether browser fraud warnings are allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | browser_allow_popups | integer | Whether browser popups are allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | browser_allow_javascript | integer | Whether browser JavaScript is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | browser_allow_autofill | integer | Whether browser autofill is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | browser_allow_cookies | integer | Whether browser cookies are allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_roaming_sync | integer | Whether sync while roaming is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_roaming_voice_calls | integer | Whether voice calls while roaming are allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_roaming_push | integer | Whether push notifications while roaming are allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_roaming_data | integer | Whether data usage while roaming is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_s_voice | integer | Whether S Voice is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_stop_system_app | integer | Whether stopping system apps is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | disable_clear_storage_and_force_stop_apps | JSON Array | List of apps excluded from clear storage and force stop restrictions | | allow_app_control | integer | Whether app control restrictions are enabled. 0 = Disabled, 1 = Enabled. Default: 1 | | allow_clear_app_data_and_force_stop | integer | Whether clearing app data and force stopping apps is allowed. 0 = Restricted, 1 = Allowed, 2 = Restrict Specific Apps. Default: 1 | | allow_airplane_mode | integer | Whether airplane mode is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_android_beam | integer | Whether Android Beam is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_background_process_limit | integer | Whether background process limit is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_s_beam | integer | Whether S Beam is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_wifi_direct | integer | Whether Wi-Fi Direct is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_headphone | integer | Whether headphone use is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_smart_clip_mode | integer | Whether Smart Clip mode is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_clipboard_share | integer | Whether clipboard sharing is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_firmware_recovery | integer | Whether firmware recovery is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_sdcard_move | integer | Whether moving apps to SD card is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_safe_mode | integer | Whether safe mode is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_home_key | integer | Whether the home key is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_lock_screen_menu | integer | Whether the lock screen menu is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_developer_mode | integer | Whether developer mode is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_kill_activity_on_leave | integer | Whether killing activities on leave is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_lock_screen_view | integer | Whether the lock screen view is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_share_list | integer | Whether the share list is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_play_protect_monitoring | integer | Whether Google Play Protect monitoring is allowed. 0 = Restricted, 1 = Allowed. Default: 0 | | allow_user_mobile_data_limit | integer | Whether the user can set mobile data limits. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_date_time_change | integer | Whether changing date and time is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_google_account_auto_sync | integer | Whether Google account auto-sync is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_user_profile | integer | Whether user profiles are allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_app_notification_mode | integer | Whether app notification mode changes are allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_audio_record | integer | Whether audio recording is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_video_record | integer | Whether video recording is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_usb_host_storage | integer | Whether USB host storage is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_use_network_time | integer | Whether using network time is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_gmail | integer | Whether Gmail is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_google_maps | integer | Whether Google Maps is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_bt_discoverable | integer | Whether Bluetooth discoverable mode is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_bt_pairing | integer | Whether Bluetooth pairing is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_bt_outgoing_calls | integer | Whether Bluetooth outgoing calls are allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_bt_pc_connection | integer | Whether Bluetooth PC connections are allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_bt_data_transfer | integer | Whether Bluetooth data transfer is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_emergency_calls_only | integer | Whether emergency calls only mode is enforced. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_mms | integer | Whether MMS is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_incoming_mms | integer | Whether incoming MMS is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_outgoing_mms | integer | Whether outgoing MMS is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_sms | integer | Whether SMS is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_incoming_sms | integer | Whether incoming SMS is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_outgoing_sms | integer | Whether outgoing SMS is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_call | integer | Whether phone calls are allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_outgoing_call | integer | Whether outgoing calls are allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_incoming_call | integer | Whether incoming calls are allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_user_add_accounts | integer | Whether the user can add accounts. 0 = Restricted, 1 = Allowed. Default: 1 | | restricted_account_types | JSON Array | List of restricted account type identifiers | | allow_personal_accounts_in_playstore | boolean | Whether personal accounts are allowed in the Play Store. Default: true | | allow_s_finder | integer | Whether S Finder is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_air_command | integer | Whether Air Command is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_air_view | integer | Whether Air View is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | app_permission_policy | integer | Global runtime permission policy. 0 = Prompt, 1 = Auto Grant, 2 = Auto Deny, 4 = Not Configured. Default: 4 | | allow_timezone | string | Timezone identifier to enforce (e.g., America/New_York). Empty = User Controlled | | allow_ambient_display | boolean | Whether ambient display (always-on display) is enabled. Default: true | | allow_brightness_config | boolean | Whether the user can configure screen brightness. Default: true | | adaptive_brightness | boolean | Whether adaptive brightness is enabled. Default: true | | brightness_value | integer | Screen brightness level (0-255). Default: 126 | | allow_date_time_settings | boolean | Whether the user can change date and time settings. Default: true | | allow_config_screen_timeout | boolean | Whether the user can configure screen timeout. Default: true | | screen_timeout | integer | Screen timeout duration in seconds. Default: 5 | | allow_printing | boolean | Whether printing is allowed. Default: true | | allow_non_secure_keypad | integer | Whether the non-secure keypad is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_contact_to_device | integer | Whether contact sync to device is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_knox_app_store | integer | Whether the Knox App Store is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_keyguard_camera | integer | Whether the keyguard camera is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_keyguard_notifications | integer | Keyguard notification visibility level. 0 = Show All, 1 = Hide Sensitive, 2 = Hide All. Default: 0 | | set_roaming_always_on | boolean | Whether data roaming is forced to always on. Default: false | | allow_data_saver | boolean | Whether Data Saver mode is allowed. Default: false | | allow_data_saver_restriction | boolean | Whether Data Saver restriction is enabled. Default: false | | allow_cert_based_authentication_for_managed_apps | boolean | Whether certificate-based authentication is allowed for managed apps. Default: true | | allow_install_or_modify_certificates | boolean | Whether the user can install or modify certificates. Default: true | | allow_secured_wifi | integer | Whether secured Wi-Fi is allowed. 0 = Restricted, 1 = Allowed. Default: 1 | | allow_auto_fill_service | boolean | Whether the autofill service is allowed. Default: false | | allow_all_apps_access | integer | Whether all apps are accessible in Managed Google Play. 0 = Restricted, 1 = Allowed. Default: 0 | | allow_usb_file_transfer | boolean | Whether USB file transfer is allowed. Default: true | | allow_personal_space_screen_capture | boolean | Whether screen capture is allowed in the personal space. Default: true | | allow_personal_space_camera | boolean | Whether the camera is allowed in the personal space. Default: true | | app_filter_type | integer | App filtering mode. -1 = Not Configured. Default: -1 | | apps_list | JSON Array | List of apps for the app filter | ### Sample Response: HTTP 200 Full configuration details of Restrictions payload item ```json { "payload_id": 9007199254741000, "allow_disabling_cellular_data": 1, "allow_non_market_app_instal": 1, "allow_data_while_roaming": 1, "allow_camera": 1, "allow_bluetooth": 4, "external_storage_encryption": 2, "allow_storage_encryption": 2, "allow_app_auto_sync": 1, "allow_background_data": 1, "allow_usb": 1 } ``` ### Possible Response Codes | Code | Type | |---|---| | 200 | HTTP code | ## Rate Limit ![Help icon](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png) **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.