Add a new webdomain

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

Adds a new webdomain and returns the created webdomain details.

Endpoints

Request URL

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

Scope

BrowserManager.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Request Body

JSON body with webdomain URL and type

application/json
JSON Object

Request body for adding a new webdomain

Hide Sub-Attributes
webDomainstringOptional

Website URL to add. Maximum 2048 characters.

typestringOptional

Webdomain type: 2 = Domain, 4 = Subdomain, 8 = Fully-defined URL.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/bsp/api/v1/bmp/webdomains \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"webDomain":"facebook.com","type":"2"}'

Sample Request Body

Add domain (type=2)

Copied!
  {
    "webDomain": "facebook.com",
    "type": "2"
  }
                
Show full

Add subdomain (type=4)

Copied!
  {
    "webDomain": "mail.google.com",
    "type": "4"
  }
                
Show full

Add fully-defined URL (type=8)

Copied!
  {
    "webDomain": "https://example.com/path?q=test",
    "type": "8"
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object

Single webdomain details response

Hide Sub-Attributes
webdomain_idinteger

Unique identifier of the webdomain

webdomain_namestring

Name of the webdomain

urlstring

Display URL of the webdomain

- 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

Internal server error when adding a webdomain

Hide Sub-Attributes
error_descriptionstring

Message describing the server-side failure

error_codestring

Internal server error code

Possible Response Codes

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

Sample Response: HTTP 200

Domain added

Copied!
  {
    "webdomain_name": "facebook.com",
    "webdomain_id": "19",
    "url": "*.facebook.com"
  }
                
Show full

Subdomain added

Copied!
  {
    "webdomain_name": "mail.google.com",
    "webdomain_id": "21",
    "url": "mail.google.com"
  }
                
Show full

Fully-defined URL added

Copied!
  {
    "webdomain_name": "https://example.com",
    "url_params": "q=test",
    "webdomain_id": "23",
    "url": "https://example.com/path?q=test",
    "url_path": "path"
  }
                
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.