Modify the configuration of a Kernel Extension payload item within a profile

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 modify Mac Kernel Extension policy payload item

Request URL

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

Scope

MDMDeviceMgmt.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
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

- Request Body

application/json
JSON Object
Hide Sub-Attributes
allow_user_overridebooleanOptional

Allow User Override

extensionsJSON ArrayMandatory

List of kernel extension configurations

Show Sub-Attributes
JSON Object
Show Sub-Attributes
prov_idlongOptional

Provisioning ID

allowed_extensionsarrayOptional

List of allowed extension bundle identifiers (strings)

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/mackernelextension/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"extensions":[{"prov_id":9007199254741074,"allowed_extensions":["com.zylker.ext"]}],"allow_user_override":true}'

Sample Request Body

Modify Kernel Extension payload item

Copied!
  {
    "extensions": [
      {
        "prov_id": 9007199254741074,
        "allowed_extensions": [
          "com.zylker.ext"
        ]
      }
    ],
    "allow_user_override": 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

allow_user_overrideboolean

Allow User Override

extensionsJSON Array

List of kernel extension configurations

Show Sub-Attributes
JSON Object
Show Sub-Attributes
prov_idlong

Provisioning ID

allowed_extensionsarray

List of allowed extension bundle identifiers (strings)

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Kernel Extension payload item successfully modified

Copied!
  {
    "payload_id": 9007199254741000,
    "extensions": [
      {
        "prov_id": 9007199254741074,
        "allowed_extensions": [
          "com.zylker.ext"
        ]
      }
    ],
    "allow_user_override": 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.