Modify the configuration of a Device Guard 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

Modify Windows Device Guard Policy payload details

Request URL

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

Configure System Guard

enable_virtual_securityintegerOptional

Enable Virtual Security

credential_guardintegerOptional

Credential Guard

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/windowsdeviceguardpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"enable_virtual_security":1,"configure_system_guard":1,"credential_guard":1}'

Sample Request Body

Modify Device Guard payload item

Copied!
  {
    "enable_virtual_security": 1,
    "configure_system_guard": 1,
    "credential_guard": 1
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
payload_idlong

Unique identifier of the payload item

configure_system_guardinteger

Configure System Guard

enable_virtual_securityinteger

Enable Virtual Security

credential_guardinteger

Credential Guard

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Device Guard payload item successfully modified

Copied!
  {
    "payload_id": 9007199254741296,
    "enable_virtual_security": 1,
    "configure_system_guard": 1,
    "credential_guard": 1
  }
                
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.