Remove a payload from a 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

Removes a payload and its Java rules from a JRM profile.

Request URL

https://{server-hostname}:8383/bsp/api/v1/bmp/jrm/{jrm_profile_id}/jrm_payloads/{jrm_payload_id}

Scope

BrowserManager.DELETECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

jrm_payload_idstringMandatory

JRM Payload ID from Get JRM Profile response (config_data_item_id field)

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 DELETE \
  --url https://appdomain/bsp/api/v1/bmp/jrm/{jrm_profile_id}/jrm_payloads/{jrm_payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
Show full

Response Parameters

- HTTP code 204

Response Body - application/json

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

Description of the server-side error

Possible Response Codes

204HTTP code

Returns 204 No Content on success.

401HTTP code
429HTTP code
500HTTP code

Sample Response: HTTP 204

Copied!
204 Returns 204 No Content on success.
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 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.