Publish a web sandboxing 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

Publishes a Web Sandboxing profile and makes it active for deployment.

Request URL

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

Scope

BrowserManager.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

profile_idstringMandatory

Retrieve the web sandboxing profile ID from the profileid key in the response returned by List Configuration Profiles

- Request Body

JSON body with profile ID and platform type for publishing the web sandboxing profile

application/json
JSON Object

Request body for publishing a configuration or web sandboxing profile

Hide Sub-Attributes
PROFILE_IDstringOptional

Profile ID from List Configuration Profiles response (profileid field)

PLATFORM_TYPEstringOptional

Target platform type. '1'=Windows, '2'=Mac

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/bsp/api/v1/bmp/web_sandboxing/{profile_id}/publish \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"PROFILE_ID":103,"PLATFORM_TYPE":"1"}'

Sample Request Body

Publish a Windows web sandboxing profile

Copied!
  {
    "PROFILE_ID": 103,
    "PLATFORM_TYPE": "1"
  }
                
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 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 404

Response Body - application/json
JSON Object

Returned when the specified web sandboxing profile is not found

Hide Sub-Attributes
error_descriptionstring

Message indicating the specified profile does not exist

- HTTP code 409

Response Body - application/json
JSON Object

Returned when the profile is already published

Hide Sub-Attributes
error_descriptionstring

Message indicating the profile is already in published state

- HTTP code 412

Response Body - application/json
JSON Object

Returned when the profile has no settings configured to publish

Hide Sub-Attributes
error_descriptionstring

Message indicating no settings have been saved in the profile to publish

- 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

Returned when an unexpected server error occurs during profile publish

Hide Sub-Attributes
error_descriptionstring

Message describing the internal server error

error_codestring

Error code identifying the type of server error

Possible Response Codes

204HTTP code

Returns 204 No Content on success.

401HTTP code
403HTTP code
404HTTP code
409HTTP code
412HTTP 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": "UNAUTHORIZED",
    "errorMsg": "You are not authorized to perform this action"
  }
                
Show full

Sample Response: HTTP 403

Forbidden

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMsg": "User does not have permission to perform this operation"
  }
                
Show full

Sample Response: HTTP 404

Profile not found

Copied!
  {
    "error_description": "Profile not found"
  }
                
Show full

Sample Response: HTTP 409

Already published

Copied!
  {
    "error_description": "Profile already published."
  }
                
Show full

Sample Response: HTTP 412

No settings saved

Copied!
  {
    "error_description": "No Settings Saved To be Published"
  }
                
Show full

Sample Response: HTTP 429

Rate limit exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMsg": "Too many requests. Please try again after 5 minutes"
  }
                
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.