Bulk import webdomains from CSV

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

Imports webdomains from a CSV file and associates them with a webdomain group.

Request URL

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

Scope

BrowserManager.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Request Body

JSON body with group details and CSV file reference

application/json
JSON Object

Request body for CSV-based bulk webdomain import

Hide Sub-Attributes
webdomain_group_namestringOptional

Name of the webdomain group. Maximum 50 characters.

descriptionstringOptional

Description of the webdomain group. Maximum 100 characters.

csv_file_idintegerOptional

File ID of the uploaded CSV file to import.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/bsp/api/v1/bmp/webdomains/csvimport \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"csv_file_id":12345,"webdomain_group_name":"Blocked Sites","description":"Bulk imported blocked sites"}'

Sample Request Body

Initiate CSV import

Copied!
  {
    "csv_file_id": 12345,
    "webdomain_group_name": "Blocked Sites",
    "description": "Bulk imported blocked sites"
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object

CSV import progress/status response

Hide Sub-Attributes
totalstring

Total number of webdomains in the CSV file

statusstring

Current import status: in_progress, success, or failed

- HTTP code 400

Response Body - application/json
JSON Object

Bad request error for CSV import validation failures

Hide Sub-Attributes
error_descriptionstring

Message describing the CSV validation failure

error_codestring

Validation error code for the specific CSV issue

- 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 during CSV import processing

Hide Sub-Attributes
error_descriptionstring

Message describing the server-side failure

error_codestring

Internal server error code

Possible Response Codes

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

Sample Response: HTTP 200

Import started

Copied!
  {
    "total": "2",
    "status": "in_progress"
  }
                
Show full

Sample Response: HTTP 400

Too many entries

Copied!
  {
    "error_description": "CSV contains more than 1000 entries",
    "error_code": "BSP_COM0023"
  }
                
Show full

Empty file

Copied!
  {
    "error_description": "CSV file is empty",
    "error_code": "BSP_COM0027"
  }
                
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.