Modify the configuration of a Restrictions payload item within a profile

To create Mac SCEP policy

Endpoints

put /api/v1/mdm/profiles/{profile_id}/payloads/tvosrestrictionspolicy/payloaditems/{payload_id}

Copy full URL

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/tvosrestrictionspolicy/payloaditems/{payload_id}

Scope

MDMDeviceMgmt.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

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

- Request Body

application/json

JSON Object

Hide Sub-Attributes

airplay_incoming_requestbooleanOptional

Airplay Incoming Request. Default: true

allow_ibookstore_erotica_mediabooleanOptional

Allow Ibookstore Erotica Media. Default: true

allow_modifi_device_namebooleanOptional

Allow Modifi Device Name. Default: true

allow_device_sleepbooleanOptional

Allow Device Sleep. Default: true

allow_explicit_contentbooleanOptional

Allow Explicit Content. Default: true

allow_password_proximitybooleanOptional

Allow Password Proximity. Default: true

allow_remote_app_pairingbooleanOptional

Allow Remote App Pairing. Default: true

force_airplay_incoming_pwdbooleanOptional

Force Airplay Incoming Pwd. Default: false

force_date_timebooleanOptional

Force Date Time. Default: false

apps_rating_valueintegerOptional

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_valueintegerOptional

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_valueintegerOptional

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_codestringOptional

Country Code. Default: us

time_zonestringOptional

Time Zone. Default: --

allow_automatic_screen_saverbooleanOptional

Allow Automatic Screen Saver. Default: true

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/tvosrestrictionspolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"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}'

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/tvosrestrictionspolicy/payloaditems/{payload_id}"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"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}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"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}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/tvosrestrictionspolicy/payloaditems/{payload_id}", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data.put("airplay_incoming_request",true);
    data.put("allow_ibookstore_erotica_media",true);
    data.put("allow_modifi_device_name",true);
    data.put("allow_device_sleep",true);
    data.put("allow_explicit_content",true);
    data.put("allow_password_proximity",true);
    data.put("allow_remote_app_pairing",true);
    data.put("force_airplay_incoming_pwd",true);
    data.put("force_date_time",true);
    data.put("apps_rating_value","1");
    data.put("movies_rating_value","1");
    data.put("tv_shows_rating_value","1");
    data.put("country_code","value");
    data.put("time_zone","value");
    data.put("allow_automatic_screen_saver",true);

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/tvosrestrictionspolicy/payloaditems/{payload_id}"
        type: PUT
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/tvosrestrictionspolicy/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"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}'

Sample Request Body

Modify Restrictions payload item

Copied!

  {
    "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

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

Restrictions payload item successfully modified

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: 60 | 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.