Modify the configuration of a Certificate 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 Android Certificate payload

Request URL

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

ID of the certificate to deploy to devices. Obtain from the Get Certificates response

url_patternstringOptional

URL pattern filter; only traffic to URLs matching this pattern uses this certificate. Optional.

certificate_to_apps_listJSON ArrayOptional

List of apps to associate with this certificate. Applicable only for Android Device Policy profiles.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
group_display_namestringOptional

Display name of the app or app group

app_idlongOptional

Unique identifier of the app group

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidcertificatepolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"certificate_id":1,"url_pattern":"https://zylker.com","certificate_to_apps_list":[{"group_display_name":"Corporate App Group","app_id":12345}]}'

Sample Request Body

Modify Certificate payload item

Copied!
  {
    "certificate_id": 1,
    "url_pattern": "https://zylker.com",
    "certificate_to_apps_list": [
      {
        "group_display_name": "Corporate App Group",
        "app_id": 12345
      }
    ]
  }
                
Show full

Response Parameters

- HTTP code 200

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

Unique identifier of the payload item

certificate_idlong

ID of the certificate to deploy to devices

url_patternstring

URL pattern filter; only traffic to URLs matching this pattern uses this certificate. Optional.

certificate_to_apps_listJSON Array

List of apps to associate with this certificate. Applicable only for Android Device Policy profiles.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
group_display_namestring

Display name of the app or app group

app_idlong

Unique identifier of the app group

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Certificate payload item successfully modified

Copied!
  {
    "certificate_id": 1,
    "url_pattern": "https://zylker.com",
    "payload_id": 9007199254741000,
    "certificate_to_apps_list": [
      {
        "group_display_name": "Corporate App Group",
        "app_id": 12345
      }
    ]
  }
                
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.