Retrieve the full configuration details of a Restrictions 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 Tv Os Restrictions policy payload item

Request URL

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

airplay_incoming_requestboolean

Airplay Incoming Request. Default: true

allow_ibookstore_erotica_mediaboolean

Allow Ibookstore Erotica Media. Default: true

allow_modifi_device_nameboolean

Allow Modifi Device Name. Default: true

allow_device_sleepboolean

Allow Device Sleep. Default: true

allow_explicit_contentboolean

Allow Explicit Content. Default: true

allow_password_proximityboolean

Allow Password Proximity. Default: true

allow_remote_app_pairingboolean

Allow Remote App Pairing. Default: true

force_airplay_incoming_pwdboolean

Force Airplay Incoming Pwd. Default: false

force_date_timeboolean

Force Date Time. Default: false

apps_rating_valueinteger

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

movies_rating_valueinteger

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_valueinteger

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

country_codestring

Country Code. Default: us

time_zonestring

Time Zone. Default: --

allow_automatic_screen_saverboolean

Allow Automatic Screen Saver. Default: true

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of Restrictions payload item

Copied!
  {
    "payload_id": 9007199254741000,
    "force_airplay_incoming_pwd": false,
    "force_date_time": false,
    "allow_password_proximity": true,
    "allow_remote_app_pairing": true,
    "airplay_incoming_request": true,
    "allow_ibookstore_erotica_media": true,
    "allow_modifi_device_name": true,
    "allow_device_sleep": true,
    "apps_rating_value": 1000,
    "allow_explicit_content": 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.