Create a new JRM 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 Java Rules Manager profile.

Endpoints

Request URL

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

Scope

DesktopCentralCloud.BrowserManager.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Request Body

Send profile metadata in the request body. All four fields are required when creating: profile_name, profile_description, profile_type (must be 64012), and platform_type ('1'=Windows, '2'=Mac, '-1'=All)

application/json
JSON Object

Fields for creating or updating a JRM profile

Hide Sub-Attributes
profile_namestringOptional

Required. A descriptive name for the profile (e.g., 'Corporate Java Rules')

profile_typestringOptional

Required when creating. Must always be 64012 (Java Rules Manager type). Not needed when modifying

profile_descriptionstringOptional

Required. A brief description of the profile's purpose. Send empty string to clear, but cannot be null

platform_typestringOptional

Required when creating. Target platform: '1' = Windows only, '2' = Mac only, '-1' = All platforms. Not needed when modifying

Sample Request

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

Sample Request Body

Create a new JRM profile for Windows

Copied!
  {
    "profile_name": "Corporate Java Rules",
    "profile_type": 64012,
    "platform_type": "1",
    "profile_description": "Java applet rules for corporate sites"
  }
                
Show full

Response Parameters

- HTTP code 200

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

Internal collection ID used by the system to group profile versions

jrm_profile_namestring

The name you gave the profile

jrm_profile_descriptionstring

The description you provided for this profile

profile_typestring

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

platform_typestring

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

latest_versionstring

Current version number of the profile (starts at '1')

is_moved_to_trashboolean

Whether this profile has been moved to trash (false for new profiles)

scopestring

Profile scope '0' means default scope

latest_published_versionstring

Version number that is currently published, or '--' if the profile has never been published

jrm_profile_idstring

Unique ID of this profile use this as {jrm_profile_id} in all other JRM APIs

jrm_payloadsJSON Array

List of payload rules attached to this profile (empty for newly created profiles)

Show Sub-Attributes
JSON Object
Show Sub-Attributes
payload_typestring

Always 64101 identifies this as a Java Rules Manager payload

payload_idlong

Unique payload ID use as {jrm_payload_id} in Modify/Delete Payload APIs

CONFIG_NAMEstring

Configuration label (always 'JAVA_RULES_MANAGER')

- 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

Created profile

Copied!
  {
    "collection_id": "222",
    "jrm_profile_name": "Corporate Java Rules",
    "jrm_profile_description": "Java applet rules for corporate sites",
    "profile_type": "64012",
    "platform_type": "1",
    "latest_version": "1",
    "is_moved_to_trash": false,
    "scope": "0",
    "latest_published_version": "--",
    "jrm_profile_id": "333",
    "jrm_payloads": []
  }
                
Show full

Sample Response: HTTP 400

Bad request

Copied!
  {
    "errorcode": "IAM0006",
    "errormsg": "Field value of {0} is invalid."
  }
                
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.