Add a new Web Clips payload configuration to an existing profile

To create Web Clips policy

Endpoints

post /api/v1/mdm/profiles/{profile_id}/payloads/webclipspolicy

Copy full URL

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/webclipspolicy

Scope

MDMDeviceMgmt.CREATECopied!

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

- Request Body

application/json

JSON Object

Hide Sub-Attributes

webclip_labelstringMandatory

Webclip Label

webclip_namestringMandatory

Webclip Name

webclip_urlstringMandatory

Webclip Url

is_removalbooleanOptional

Is Removal. Default: true

webclips_file_uploadlongOptional

Webclips File Upload. Use the fileID from the File Upload API response

icon_file_namestringOptional

Icon File Name

use_precomp_iconbooleanOptional

Use Precomp Icon. Default: false

allow_full_screenbooleanOptional

Allow Full Screen. Default: false

webclip_policy_idlongOptional

Webclip Policy Id

allow_site_permissionbooleanOptional

Allow Site Permission. Default: false

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/webclipspolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"webclip_url":"https://zylker.com","is_removal":true,"allow_site_permission":false,"webclip_label":"value","webclip_policy_id":1,"webclips_file_upload":"value","webclip_name":"Zylker User","use_precomp_icon":false,"icon_file_name":"value","allow_full_screen":false}'

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/webclipspolicy"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"webclip_url\":\"https://zylker.com\",\"is_removal\":true,\"allow_site_permission\":false,\"webclip_label\":\"value\",\"webclip_policy_id\":1,\"webclips_file_upload\":\"value\",\"webclip_name\":\"Zylker User\",\"use_precomp_icon\":false,\"icon_file_name\":\"value\",\"allow_full_screen\":false}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"webclip_url\":\"https://zylker.com\",\"is_removal\":true,\"allow_site_permission\":false,\"webclip_label\":\"value\",\"webclip_policy_id\":1,\"webclips_file_upload\":\"value\",\"webclip_name\":\"Zylker User\",\"use_precomp_icon\":false,\"icon_file_name\":\"value\",\"allow_full_screen\":false}"

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

conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/webclipspolicy", 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("webclip_label","value");
    data.put("webclip_name","value");
    data.put("webclip_url","value");
    data.put("is_removal",true);
    data.put("webclips_file_upload","1");
    data.put("icon_file_name","value");
    data.put("use_precomp_icon",true);
    data.put("allow_full_screen",true);
    data.put("webclip_policy_id","1");
    data.put("allow_site_permission",true);

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/webclipspolicy"
        type: POST
        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/webclipspolicy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"webclip_url":"https://zylker.com","is_removal":true,"allow_site_permission":false,"webclip_label":"value","webclip_policy_id":1,"webclips_file_upload":"value","webclip_name":"Zylker User","use_precomp_icon":false,"icon_file_name":"value","allow_full_screen":false}'

Sample Request Body

Add Web Clips payload to the profile

Copied!

  {
    "webclip_url": "https://zylker.com",
    "is_removal": true,
    "allow_site_permission": false,
    "webclip_label": "value",
    "webclip_policy_id": 1,
    "webclips_file_upload": "value",
    "webclip_name": "Zylker User",
    "use_precomp_icon": false,
    "icon_file_name": "value",
    "allow_full_screen": false
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

payload_idlong

Unique identifier for the created payload item

webclip_labelstring

Webclip Label

webclip_namestring

Webclip Name

webclip_urlstring

Webclip Url

is_removalboolean

Is Removal. Default: true

webclips_file_uploadlong

Webclips File Upload. Use the fileID from the File Upload API response

icon_file_namestring

Icon File Name

use_precomp_iconboolean

Use Precomp Icon. Default: false

allow_full_screenboolean

Allow Full Screen. Default: false

webclip_policy_idlong

Webclip Policy Id

allow_site_permissionboolean

Allow Site Permission. Default: false

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Web Clips payload successfully added

Copied!

  {
    "webclip_url": "https://zylker.com",
    "payload_id": 9007199254741000,
    "is_removal": true,
    "allow_site_permission": false,
    "webclip_label": "value",
    "webclip_policy_id": 1,
    "webclips_file_upload": "value",
    "webclip_name": "Zylker User",
    "use_precomp_icon": false,
    "icon_file_name": "value",
    "allow_full_screen": false
  }

▼ Show full

Duration: 1 minute | Threshold: 30 | 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.