Create a new browser router 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

Creates a new Browser Router profile in Draft state.

Request URL

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

Scope

DesktopCentralCloud.BrowserManager.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Request Body

JSON body with profile name, description, platform type, and profile type (64011 for Browser Router)

application/json
JSON Object
Hide Sub-Attributes
router_profile_namestringOptional

Display name for the browser router profile. Maximum 50 characters

PROFILE_TYPEstringOptional

Profile type constant. Must be 64011 for Browser Router

router_profile_descriptionstringOptional

Description of the browser router profile. Optional, maximum 100 characters

PLATFORM_TYPEstringOptional

Platform type. 1=Windows, 2=Mac, -1=All platforms

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/bsp/api/v1/bmp/browser_router \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

Sample Request Body

Create profile

Copied!
  {
    "router_profile_description": "Routes internal sites to Edge, others to Chrome",
    "PROFILE_TYPE": 64011,
    "PLATFORM_TYPE": "1",
    "router_profile_name": "Corporate Router Policy"
  }
                
Show full

Response Parameters

- HTTP code 200

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

Unique identifier for the browser router profile

router_profile_namestring

Display name of the browser router profile

router_profile_descriptionstring

Description of the browser router profile

platform_typestring

Platform type. 1=Windows, 2=Mac, -1=All platforms

latest_versionstring

Latest version number of the profile

latest_published_versionstring

Latest published version, or '--' if not yet published

PROFILE_TYPEstring

Profile type. 64011 for Browser Router

SCOPEstring

Profile scope. 0 = device scope

IS_MOVED_TO_TRASHboolean

Whether the profile is in the trash

COLLECTION_IDlong

Collection reference ID for the profile

router_payloadJSON Array

Payload configurations

Show Sub-Attributes
JSON Object
Show Sub-Attributes
CONFIG_NAMEstring

Configuration label

payload_typestring

Payload type. 64100 for Browser Router

payload_idlong

Unique identifier of the payload

- HTTP code 400

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

Message describing the invalid request

error_codestring

Error code for invalid request

- 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
Hide Sub-Attributes
error_descriptionstring

Message describing the server-side failure

error_codestring

Internal server error code

Possible Response Codes

200HTTP code
400HTTP code
401HTTP code
403HTTP code
429HTTP code
500HTTP code

Sample Response: HTTP 200

Created profile

Copied!
  {
    "router_profile_description": "Routes internal sites to Edge, others to Chrome",
    "IS_MOVED_TO_TRASH": false,
    "platform_type": 1,
    "latest_version": 1,
    "PROFILE_TYPE": 64011,
    "SCOPE": 0,
    "COLLECTION_ID": 222,
    "router_profile_name": "Corporate Router Policy",
    "latest_published_version": "--",
    "router_profile_id": 111,
    "router_payload": []
  }
                
Show full

Sample Response: HTTP 400

Invalid request

Copied!
  {
    "error_description": "Bad Request",
    "error_code": "BAD_REQUEST"
  }
                
Show full

Sample Response: HTTP 401

Unauthorized

Copied!
  {
    "errorCode": "UNAUTHORIZED",
    "errorMsg": "You are not authorized to perform this action"
  }
                
Show full

Sample Response: HTTP 403

Forbidden

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMsg": "You do not have permission to access this resource"
  }
                
Show full

Sample Response: HTTP 429

Rate limit exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
  }
                
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.