Modify the configuration of a Service Management payload item within a profile

To modify Mac Service Mgmt policy payload item

Endpoints

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

Copy full URL

Request URL

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

mac_service_mgmt_rulesJSON ArrayMandatory

List of rules controlling which services and daemons are allowed or denied on the Mac

Show Sub-Attributes

JSON Object

Show Sub-Attributes

rule_typeintegerOptional

Service rule type. Allowed values: 1=Allow, 2=Deny

rule_valuestringOptional

Bundle identifier or launchd label of the service or daemon (e.g., com.apple.smbd)

commentstringOptional

Optional descriptive comment explaining the purpose of this rule

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macservicemgmtpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"mac_service_mgmt_rules":[{"rule_type":1,"rule_value":"com.zylker.service","comment":"Zylker rule"}]}'

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/macservicemgmtpolicy/payloaditems/{payload_id}"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"mac_service_mgmt_rules\":[{\"rule_type\":1,\"rule_value\":\"com.zylker.service\",\"comment\":\"Zylker rule\"}]}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"mac_service_mgmt_rules\":[{\"rule_type\":1,\"rule_value\":\"com.zylker.service\",\"comment\":\"Zylker rule\"}]}"

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

conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/macservicemgmtpolicy/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_mac_service_mgmt_rules=List();
    data_mac_service_mgmt_rules_item1=Map();
    data_mac_service_mgmt_rules_item1.put("rule_type","1");
    data_mac_service_mgmt_rules_item1.put("rule_value","value");
    data_mac_service_mgmt_rules_item1.put("comment","value");
    data_mac_service_mgmt_rules.add(data_mac_service_mgmt_rules_item1);
    data.put("mac_service_mgmt_rules",data_mac_service_mgmt_rules);

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/macservicemgmtpolicy/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/macservicemgmtpolicy/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"mac_service_mgmt_rules":[{"rule_type":1,"rule_value":"com.zylker.service","comment":"Zylker rule"}]}'

Sample Request Body

Modify Service Management payload item

Copied!

  {
    "mac_service_mgmt_rules": [
      {
        "rule_type": 1,
        "rule_value": "com.zylker.service",
        "comment": "Zylker rule"
      }
    ]
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

payload_idlong

Unique identifier of the payload item

mac_service_mgmt_rulesJSON Array

List of service management rules configured for this payload

Show Sub-Attributes

JSON Object

Show Sub-Attributes

rule_typestring

Service rule type. Values: 1=Allow, 2=Deny

rule_valuestring

Bundle identifier or launchd label of the service or daemon

commentstring

Descriptive comment explaining the purpose of this rule

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Service Management payload item successfully modified

Copied!

  {
    "payload_id": 9007199254741000,
    "mac_service_mgmt_rules": [
      {
        "rule_type": 1,
        "rule_value": "com.zylker.service",
        "comment": "Zylker rule"
      }
    ]
  }

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