Retrieve details of a specific 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

Fetches the details of a single webdomain, including its name, URL, and type.

Request URL

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

Scope

BrowserManager.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

web_domain_idstringMandatory

Web domain ID from List WebDomains or Add WebDomain response

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/bsp/api/v1/bmp/webdomains/{web_domain_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object

Webdomain details with optional path and query parameters

Hide Sub-Attributes
webdomain_idinteger

Unique identifier of the webdomain

webdomain_namestring

Name of the webdomain

urlstring

Display URL of the webdomain

url_pathstring

URL path component, present only for fully-defined URLs

url_paramsstring

URL query parameters, present only for fully-defined URLs

- HTTP code 401

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

Unauthorized error code: API key or OAuth token missing, expired or invalid

error_descriptionstring

Authentication failure reason

- HTTP code 403

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

Forbidden error code: the user lacks the required MDM_OSUpdateMgmt UEM role

error_descriptionstring

Message indicating insufficient privileges

- HTTP code 429

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

Rate limit error code: API call threshold exceeded for this endpoint group

error_descriptionstring

Rate limit exceeded message with retry guidance

- HTTP code 500

Response Body - application/json
JSON Object

Internal server error when fetching webdomain details

Hide Sub-Attributes
error_descriptionstring

Message describing the server-side failure

error_codestring

Internal server error code

Sample Response: HTTP 200

Domain details

Copied!
  {
    "webdomain_name": "facebook.com",
    "url_params": "",
    "webdomain_id": 107,
    "url": "facebook.com",
    "url_path": ""
  }
                
▼ Show full

Fully-defined URL details

Copied!
  {
    "webdomain_name": "https://example.com/path?q=test",
    "url_params": "q=test",
    "webdomain_id": 108,
    "url": "example.com",
    "url_path": "/path"
  }
                
▼ Show full

Not found

Copied!
  {}
                
▼ 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.