Create a configuration profile

Creates a new configuration profile in Draft state. Payloads can be added before publishing.

Endpoints

post /bsp/api/v1/bmp/profiles

Copy full URL

Request URL

https://{serverurl}/bsp/api/v1/bmp/profiles

Scope

DesktopCentralCloud.BrowserManager.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Request Body

JSON body with profile metadata. Use the dropdown to switch between the 8 supported profile-type examples

application/json

Examples

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomains/bsp/api/v1/bmp/profiles \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

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://appdomains/bsp/api/v1/bmp/profiles"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{}"

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

conn.request("POST", "/bsp/api/v1/bmp/profiles", 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();

    response = invokeUrl
    [
        url: "https://appDomains/bsp/api/v1/bmp/profiles"
        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", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/bsp/api/v1/bmp/profiles' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'

Sample Request Body - Browser Customization (64100)

Browser Customization (64100) - container for browser customization payloads. Add browser-specific payloads (Chrome / Edge / Firefox / IE / Ulaa / Other Chromium) via POST /profiles/{profile_id}/payloads after creation. Windows + Mac supported via platform_type='-1'.

Copied!

  {
    "profile_name": "Browser Configuration Baseline",
    "SECURITY_TYPE": 1,
    "profile_type": 64100,
    "platform_type": "1",
    "SCOPE": 0,
    "profile_id": -1,
    "CLONE_FROM": -1,
    "profile_description": "Container for Chrome/Edge/Firefox customization payloads"
  }

▼ Show full

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomains/bsp/api/v1/bmp/profiles \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

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://appdomains/bsp/api/v1/bmp/profiles"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{}"

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

conn.request("POST", "/bsp/api/v1/bmp/profiles", 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();

    response = invokeUrl
    [
        url: "https://appDomains/bsp/api/v1/bmp/profiles"
        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", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/bsp/api/v1/bmp/profiles' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'

Sample Request Body - File Activity Restriction (64005)

File Activity Restriction profile (64005). Parent for Download Filter (64800) and Upload Filter (64801) payloads. Add filter payloads via POST /profiles/{profile_id}/payloads after creation. Windows + Mac.

Copied!

  {
    "profile_name": "File Download / Upload Restriction",
    "SECURITY_TYPE": 1,
    "profile_type": 64005,
    "platform_type": "-1",
    "SCOPE": 0,
    "profile_id": -1,
    "CLONE_FROM": -1,
    "profile_description": "Controls file downloads and uploads by type, size, and source URL"
  }

▼ Show full

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomains/bsp/api/v1/bmp/profiles \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

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://appdomains/bsp/api/v1/bmp/profiles"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{}"

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

conn.request("POST", "/bsp/api/v1/bmp/profiles", 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();

    response = invokeUrl
    [
        url: "https://appDomains/bsp/api/v1/bmp/profiles"
        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", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/bsp/api/v1/bmp/profiles' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'

Sample Request Body - Web Isolation (64050)

Web Isolation profile (64050). Microsoft Defender Application Guard site-isolation container. Windows only.

Copied!

  {
    "profile_name": "Web Isolation - Defender App Guard",
    "SECURITY_TYPE": 1,
    "profile_type": 64050,
    "platform_type": "1",
    "SCOPE": 0,
    "profile_id": -1,
    "CLONE_FROM": -1,
    "profile_description": "Isolates enterprise sites in a hardware-level container"
  }

▼ Show full

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomains/bsp/api/v1/bmp/profiles \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

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://appdomains/bsp/api/v1/bmp/profiles"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{}"

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

conn.request("POST", "/bsp/api/v1/bmp/profiles", 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();

    response = invokeUrl
    [
        url: "https://appDomains/bsp/api/v1/bmp/profiles"
        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", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/bsp/api/v1/bmp/profiles' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'

Sample Request Body - Threat Prevention (64200)

Threat Prevention profile (64200). Phishing protection, download restrictions, certificate enforcement, intrusive-ad blocking. Windows + Mac (Mac covers a subset).

Copied!

  {
    "profile_name": "Threat Prevention Baseline",
    "SECURITY_TYPE": 1,
    "profile_type": 64200,
    "platform_type": "1",
    "SCOPE": 0,
    "profile_id": -1,
    "CLONE_FROM": -1,
    "profile_description": "Phishing, download, ActiveX and certificate protections"
  }

▼ Show full

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomains/bsp/api/v1/bmp/profiles \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

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://appdomains/bsp/api/v1/bmp/profiles"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{}"

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

conn.request("POST", "/bsp/api/v1/bmp/profiles", 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();

    response = invokeUrl
    [
        url: "https://appDomains/bsp/api/v1/bmp/profiles"
        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", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/bsp/api/v1/bmp/profiles' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'

Sample Request Body - Data Leakage Prevention (64201)

Data Leakage Prevention profile (64201). Restricts printing, autofill, screen capture, file upload, sync, history, passwords, cookies, devtools, clipboard. Windows; Mac variant covers a subset.

Copied!

  {
    "profile_name": "Data Leakage Prevention",
    "SECURITY_TYPE": 1,
    "profile_type": 64201,
    "platform_type": "1",
    "SCOPE": 0,
    "profile_id": -1,
    "CLONE_FROM": -1,
    "profile_description": "Restricts data-loss vectors across browsers"
  }

▼ Show full

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomains/bsp/api/v1/bmp/profiles \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

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://appdomains/bsp/api/v1/bmp/profiles"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{}"

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

conn.request("POST", "/bsp/api/v1/bmp/profiles", 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();

    response = invokeUrl
    [
        url: "https://appDomains/bsp/api/v1/bmp/profiles"
        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", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/bsp/api/v1/bmp/profiles' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'

Sample Request Body - Browser Lockdown / Web Sandboxing (64210)

Browser Lockdown / Web Sandboxing profile (64210). Sandboxes specified sites in a restricted browser session. Windows only.

Copied!

  {
    "profile_name": "Browser Lockdown - Sandbox",
    "SECURITY_TYPE": 1,
    "profile_type": 64210,
    "platform_type": "1",
    "SCOPE": 0,
    "profile_id": -1,
    "CLONE_FROM": -1,
    "profile_description": "Sandboxed browsing session for specified sites"
  }

▼ Show full

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomains/bsp/api/v1/bmp/profiles \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

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://appdomains/bsp/api/v1/bmp/profiles"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{}"

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

conn.request("POST", "/bsp/api/v1/bmp/profiles", 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();

    response = invokeUrl
    [
        url: "https://appDomains/bsp/api/v1/bmp/profiles"
        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", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/bsp/api/v1/bmp/profiles' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'

Sample Request Body - URL Filter / Web Filter / Web Activity (64950)

URL Filter / Web Filter / Web Activity Control profile (64950). Malicious-site blocking, SSL protection, web-category filtering, domain filtering, schedule filtering. Windows + Mac.

Copied!

  {
    "profile_name": "Web Activity Control",
    "SECURITY_TYPE": 1,
    "profile_type": 64950,
    "platform_type": "-1",
    "SCOPE": 0,
    "profile_id": -1,
    "CLONE_FROM": -1,
    "profile_description": "URL filter, web categories, schedule filtering"
  }

▼ Show full

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomains/bsp/api/v1/bmp/profiles \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

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://appdomains/bsp/api/v1/bmp/profiles"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{}"

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

conn.request("POST", "/bsp/api/v1/bmp/profiles", 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();

    response = invokeUrl
    [
        url: "https://appDomains/bsp/api/v1/bmp/profiles"
        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", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/bsp/api/v1/bmp/profiles' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'

Sample Request Body - Managed Browser / Browser Restriction (64960)

Managed Browser / Browser Restriction profile (64960). Allow / block specific browser applications. Windows only.

Copied!

  {
    "profile_name": "Browser Restriction",
    "SECURITY_TYPE": 1,
    "profile_type": 64960,
    "platform_type": "1",
    "SCOPE": 0,
    "profile_id": -1,
    "CLONE_FROM": -1,
    "profile_description": "Allow/block specific browsers"
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Full configuration profile details including metadata, version info, and associated payloads

Hide Sub-Attributes

profile_idstring

Profile ID

profile_namestring

Display name

profile_descriptionstring

Description

profile_typestring

Profile type code. 64100=Browser Customization, 64005=File Activity, 64011=Browser Router, 64050=Web Isolation, 64200=Threat Prevention, 64201=Data Leakage Prevention, 64210=Browser Lockdown, 64500=Compliance, 64510=Default Extension, 64950=URL Filter, 64960=Managed Browser

scopestring

'0'=Device, '1'=User

is_moved_to_trashboolean

In trash

collection_idstring

Collection reference ID

platform_typestring

'1'=Windows, '2'=Mac, '-1'=All platforms (Windows + Mac)

latest_versionstring

Latest version (increments on modify)

latest_published_versionstring

Latest published version, or '--' if never published

payloadsJSON Array

Associated payload configurations

Show Sub-Attributes

JSON Object

Individual payload configuration item returned in profile responses

Show Sub-Attributes

config_namestring

Internal config name (config_label in Add/Modify responses)

payload_typestring

Payload type code. 64200=Threat, 64201=DLP, 64151=Web Isolation, 64210=Browser Lockdown, 64950=URL Filter, 64960=Managed Browser, 64025=Add-on, 64011=Browser Router, 64012=Java Rules, 64800=Content Restriction, 64801=Upload Restriction

payload_idstring

Payload instance ID

- HTTP code 400

Response Body - application/json

JSON Object

Bad request error for invalid input or constraint violations

Hide Sub-Attributes

errorcodestring

Error code identifying the specific validation failure

errormsgstring

Message describing the validation failure

- HTTP code 401

Response Body - application/json

JSON Object

Hide Sub-Attributes

errorCodelong

Unauthorized error code: credentials missing, expired, or invalid

errorMsgstring

Authentication failure reason

- HTTP code 403

Response Body - application/json

JSON Object

Hide Sub-Attributes

errorCodelong

Error code indicating insufficient permissions

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 429

Response Body - application/json

JSON Object

Hide Sub-Attributes

errorCodelong

Rate limit error code returned when the API call reached threshold

errorMsgstring

Rate limit exceeded message with retry guidance

- HTTP code 500

Response Body - application/json

JSON Object

Internal server error response for profile operations

Hide Sub-Attributes

error_descriptionstring

Error message describing the server failure

error_codestring

Error code for internal server errors

Possible Response Codes

200HTTP code

400HTTP code

401HTTP code

403HTTP code

429HTTP code

500HTTP code

Response Examples

Sample Response: HTTP 200 - Browser Customization (64100)

Newly created Browser Customization profile (64100)

Copied!

  {
    "collection_id": "222",
    "profile_name": "Browser Configuration Baseline",
    "profile_type": "64100",
    "platform_type": "1",
    "latest_version": "1",
    "is_moved_to_trash": false,
    "payloads": [],
    "profile_id": "111",
    "scope": "0",
    "latest_published_version": "--",
    "profile_description": "Container for Chrome/Edge/Firefox customization payloads"
  }

▼ Show full

Sample Response: HTTP 200 - File Activity Restriction (64005)

Newly created File Activity Restriction profile (64005)

Copied!

  {
    "collection_id": "222",
    "profile_name": "File Download / Upload Restriction",
    "profile_type": "64005",
    "platform_type": "-1",
    "latest_version": "1",
    "is_moved_to_trash": false,
    "payloads": [],
    "profile_id": "111",
    "scope": "0",
    "latest_published_version": "--",
    "profile_description": "Controls file downloads and uploads by type, size, and source URL"
  }

▼ Show full

Sample Response: HTTP 200 - Web Isolation (64050)

Newly created Web Isolation profile (64050)

Copied!

  {
    "collection_id": "222",
    "profile_name": "Web Isolation - Defender App Guard",
    "profile_type": "64050",
    "platform_type": "1",
    "latest_version": "1",
    "is_moved_to_trash": false,
    "payloads": [],
    "profile_id": "111",
    "scope": "0",
    "latest_published_version": "--",
    "profile_description": "Isolates enterprise sites in a hardware-level container"
  }

▼ Show full

Sample Response: HTTP 200 - Threat Prevention (64200)

Newly created Threat Prevention profile (64200)

Copied!

  {
    "collection_id": "222",
    "profile_name": "Threat Prevention Baseline",
    "profile_type": "64200",
    "platform_type": "1",
    "latest_version": "1",
    "is_moved_to_trash": false,
    "payloads": [],
    "profile_id": "111",
    "scope": "0",
    "latest_published_version": "--",
    "profile_description": "Phishing, download, ActiveX and certificate protections"
  }

▼ Show full

Sample Response: HTTP 200 - Data Leakage Prevention (64201)

Newly created Data Leakage Prevention profile (64201)

Copied!

  {
    "collection_id": "222",
    "profile_name": "Data Leakage Prevention",
    "profile_type": "64201",
    "platform_type": "1",
    "latest_version": "1",
    "is_moved_to_trash": false,
    "payloads": [],
    "profile_id": "111",
    "scope": "0",
    "latest_published_version": "--",
    "profile_description": "Restricts data-loss vectors across browsers"
  }

▼ Show full

Sample Response: HTTP 200 - Browser Lockdown / Web Sandboxing (64210)

Newly created Browser Lockdown / Web Sandboxing profile (64210)

Copied!

  {
    "collection_id": "222",
    "profile_name": "Browser Lockdown - Sandbox",
    "profile_type": "64210",
    "platform_type": "1",
    "latest_version": "1",
    "is_moved_to_trash": false,
    "payloads": [],
    "profile_id": "111",
    "scope": "0",
    "latest_published_version": "--",
    "profile_description": "Sandboxed browsing session for specified sites"
  }

▼ Show full

Sample Response: HTTP 200 - URL Filter / Web Filter / Web Activity (64950)

Newly created URL Filter / Web Activity Control profile (64950)

Copied!

  {
    "collection_id": "222",
    "profile_name": "Web Activity Control",
    "profile_type": "64950",
    "platform_type": "-1",
    "latest_version": "1",
    "is_moved_to_trash": false,
    "payloads": [],
    "profile_id": "111",
    "scope": "0",
    "latest_published_version": "--",
    "profile_description": "URL filter, web categories, schedule filtering"
  }

▼ Show full

Sample Response: HTTP 200 - Managed Browser / Browser Restriction (64960)

Newly created Managed Browser / Browser Restriction profile (64960)

Copied!

  {
    "collection_id": "222",
    "profile_name": "Browser Restriction",
    "profile_type": "64960",
    "platform_type": "1",
    "latest_version": "1",
    "is_moved_to_trash": false,
    "payloads": [],
    "profile_id": "111",
    "scope": "0",
    "latest_published_version": "--",
    "profile_description": "Allow/block specific browsers"
  }

▼ Show full

Sample Response: HTTP 400

Invalid profile creation parameters

Copied!

  {
    "errorcode": "IAM0003",
    "errormsg": "Invalid request."
  }

▼ Show full

Sample Response: HTTP 401

API key is missing or invalid

Copied!

  {
    "errorCode": "IAM0001",
    "errorMsg": "Authentication key is invalid. Please regenerate the key and try again."
  }

▼ Show full

Sample Response: HTTP 403

Forbidden

Copied!

  {
    "errorCode": "FORBIDDEN",
    "errorMsg": "User does not have permission to perform this operation"
  }

▼ Show full

Sample Response: HTTP 429

Rate limit exceeded

Copied!

  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMsg": "Too many requests. Please try again after 5 minutes"
  }

▼ Show full

Sample Response: HTTP 500

Server error

Copied!

  {
    "error_description": "Internal Server error, Please try again in a moment.",
    "error_code": "COM0004"
  }

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