Get a 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

Retrieves the full details of a Browser Router profile and its routing payloads.

Request URL

https://{server-hostname}:8383/bsp/api/v1/bmp/browser_router/{profile_id}

Scope

BrowserManager.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

profile_idstringMandatory

Browser Router Profile ID from List Browser Router Profiles response (profile_id field)

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/bsp/api/v1/bmp/browser_router/{profile_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Collection reference ID

profile_namestring

Name of the browser router profile

profile_typestring

Profile type. 64011 for Browser Router

platform_typestring

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

latest_versionstring

Current draft version number

is_moved_to_trashboolean

Whether the profile is in the trash

payloadsJSON Array

Payload configurations with routing details

Show Sub-Attributes
JSON Object
Show Sub-Attributes
config_namestring

Configuration label

payload_typestring

Payload type. 64100 for Browser Router

payload_idstring

Unique identifier of the payload

router_detailsJSON Array

Routing rule configurations

Show Sub-Attributes
JSON Object
Show Sub-Attributes
config_data_item_idstring

Unique identifier for this configuration data item

urlsJSON Array

URL routing rules with webdomain details

Show Sub-Attributes
JSON Object
Show Sub-Attributes
doc_typestring

Document compatibility mode. Values: IE11, IE10, IE9, IE8, IE8Enterprise, IE7, IE5, or empty string for default rendering

idstring

Unique identifier of the webdomain

urlstring

The URL or hostname pattern for this routing rule

groupsJSON Array

Webdomain group routing rules

Show Sub-Attributes
JSON Object
Show Sub-Attributes
group_idstring

Unique identifier of the webdomain group

webdomain_groupstring

Display name of the webdomain group

doc_typestring

Document compatibility mode for the group. Values: IE11, IE10, IE9, IE8, IE8Enterprise, IE7, IE5, or empty string for default rendering

browser_modestring

Browser rendering mode. Values: IEModeInEdge, Default

intranet_zoneboolean

Whether to include intranet zone sites in this routing rule

open_instring

Target browser to open matching URLs. Values: chromiumEdge, chrome, firefox, iexplorer

profile_idstring

Unique identifier of the profile

scopestring

Profile scope. 0 = device scope

latest_published_versionstring

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

profile_descriptionstring

Description of the profile

- HTTP code 400

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

Error code for invalid request

errormsgstring

Message indicating the request is invalid

- HTTP code 401

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

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- HTTP code 403

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

Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)

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 threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes

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

Profile details

Copied!
  {
    "collection_id": "222",
    "profile_name": "Corporate Router Policy",
    "profile_type": "64011",
    "platform_type": "1",
    "latest_version": "1",
    "is_moved_to_trash": false,
    "payloads": [
      {
        "config_name": "BROWSER_ROUTER",
        "payload_type": "64100",
        "payload_id": "622",
        "router_details": [
          {
            "config_data_item_id": "622",
            "urls": [
              {
                "doc_type": "IE11",
                "id": "601",
                "url": "localhost"
              }
            ],
            "groups": [
              {
                "group_id": "618",
                "webdomain_group": "Corporate Intranet Sites",
                "doc_type": "IE5"
              }
            ],
            "browser_mode": "IEModeInEdge",
            "intranet_zone": false,
            "open_in": "chromiumEdge"
          }
        ]
      }
    ],
    "profile_id": "111",
    "scope": "0",
    "latest_published_version": "1",
    "profile_description": "Routes internal sites to Edge, others to Chrome"
  }
                
Show full

Sample Response: HTTP 400

Invalid ID

Copied!
  {
    "errorcode": "IAM0003",
    "errormsg": "Invalid 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.