Get a JRM profile's full details

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 Java Rules Manager profile and its payload configurations.

Request URL

https://{serverurl}/bsp/api/v1/bmp/jrm/{jrm_profile_id}

Scope

DesktopCentralCloud.BrowserManager.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

jrm_profile_idstringMandatory

JRM Profile ID from List JRM Profiles response (jrm_profile_id field)

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/bsp/api/v1/bmp/jrm/{jrm_profile_id} \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object

Full JRM profile with all payload rule details

Hide Sub-Attributes
profile_idstring

Unique profile ID use as {jrm_profile_id} in other APIs

profile_namestring

Name of this JRM profile

profile_descriptionstring

Description of what this profile is for

profile_typestring

Always '64012' identifies this as a Java Rules Manager profile

platform_typestring

Target platform: '1' = Windows, '2' = Mac, '-1' = All platforms

latest_versionstring

Current version number of the profile

latest_published_versionstring

Published version number, or '--' if never published

collection_idstring

Internal collection ID grouping profile versions

is_moved_to_trashboolean

Whether this profile is in the trash

scopestring

Profile scope '0' means default scope

payloadsJSON Array

All payload configurations with their URL/group rules, block messages, and Java version settings

Show Sub-Attributes
JSON Object

Complete payload configuration with all Java rules

Show Sub-Attributes
config_namestring

Configuration label (always 'JAVA_RULES_MANAGER')

payload_typestring

Always '64101' identifies this as a Java Rules Manager payload

block_messagestring

Custom message displayed to users when Java is blocked (action=0). Empty string if action is not Block or no custom message is set

jrm_detailsJSON Array

List of rule sets each contains URL-based rules and/or group-based rules. The 'config_data_item_id' in each item is used as {jrm_payload_id} for Modify/Delete Payload APIs

Show Sub-Attributes
JSON Object

Individual rule set with URL and group rules

Show Sub-Attributes
config_data_item_idstring

Unique ID for this rule set use as {jrm_payload_id} in Modify Payload (PUT) API

urlsJSON Array

URL-based rules each entry controls Java behavior for a specific website

Show Sub-Attributes
JSON Object

Java rule for a specific website URL

Show Sub-Attributes
idstring

Webdomain ID (references a site configured in Browser Security > Web Domain Management)

urlstring

The website URL/domain name (read-only, set when the webdomain was created)

actionstring

What to do with Java on this site: '0' = Block Java entirely, '1' = Allow Java to run, '2' = Use browser's default Java setting

java_versionstring

When action is '1' (Allow), specifies the required Java version (e.g., '1.7.0_04'). Leave empty to allow any installed version

groupsJSON Array

Group-based rules each entry controls Java behavior for a group of websites

Show Sub-Attributes
JSON Object

Java rule for a webdomain group

Show Sub-Attributes
group_idstring

Webdomain group ID (references a group configured in Browser Security > Web Domain Management)

webdomain_groupstring

Name of the webdomain group (read-only, set when the group was created)

actionstring

What to do with Java for all sites in this group: '0' = Block Java, '1' = Allow Java, '2' = Use browser default

java_versionstring

When action is '1' (Allow), specifies the required Java version. Leave empty to allow any installed version

default_riasboolean

Whether default Rich Internet Application (RIA) settings are applied

- HTTP code 400

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

Error identifier (e.g., 'IAM0006' for invalid field value)

errormsgstring

Describes which field or value is invalid

- 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
errormsgstring

Description of the server-side error

Possible Response Codes

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

Sample Response: HTTP 200

Profile with URL payload

Copied!
  {
    "collection_id": "222",
    "profile_name": "Corporate Java Rules",
    "profile_type": "64012",
    "platform_type": "1",
    "latest_version": "1",
    "is_moved_to_trash": false,
    "payloads": [
      {
        "config_name": "JAVA_RULES_MANAGER",
        "payload_type": "64101",
        "block_message": "Java applet blocked by policy",
        "jrm_details": [
          {
            "config_data_item_id": "946",
            "urls": [
              {
                "java_version": "1.7.0_04",
                "action": "1",
                "id": "3",
                "url": "localhost"
              }
            ],
            "groups": []
          }
        ],
        "default_rias": false
      }
    ],
    "profile_id": "111",
    "scope": "0",
    "latest_published_version": "--",
    "profile_description": "Java applet rules for corporate sites"
  }
                
Show full

Sample Response: HTTP 400

Invalid profile ID

Copied!
  {
    "errorcode": "IAM0003",
    "errormsg": "Invalid request."
  }
                
Show full

Sample Response: HTTP 401

Unauthorized

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": "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!
  {
    "errormsg": "Internal Server error, Please try again in a moment."
  }
                
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.