Fetches the details of a single webdomain, including its name, URL, and type.
get /bsp/api/v1/bmp/webdomains/{web_domain_id}
https://{server-hostname}:8383/bsp/api/v1/bmp/webdomains/{web_domain_id}
BrowserManager.READCopied!
Authorization: d92d4xxxxxxxxxxxxx15f52
Web domain ID from List WebDomains or Add WebDomain response
curl --request GET \
--url https://appdomain/bsp/api/v1/bmp/webdomains/{web_domain_id} \
--header 'Accept: application/json' \
--header 'Authorization: d92d4xxxxxxxxxxxxx15f52'Webdomain details with optional path and query parameters
Unique identifier of the webdomain
Name of the webdomain
Display URL of the webdomain
URL path component, present only for fully-defined URLs
URL query parameters, present only for fully-defined URLs
Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
Authentication failure reason
Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
Message indicating insufficient privileges to access this resource
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
Rate limit exceeded message with retry guidance
Internal server error when fetching webdomain details
Message describing the server-side failure
Internal server error code
Domain details
{
"webdomain_name": "facebook.com",
"url_params": "",
"webdomain_id": 107,
"url": "facebook.com",
"url_path": ""
}
Fully-defined URL details
{
"webdomain_name": "https://example.com/path?q=test",
"url_params": "q=test",
"webdomain_id": 108,
"url": "example.com",
"url_path": "/path"
}
Not found
{}
Unauthorized
{
"errorCode": "UNAUTHORIZED",
"errorMsg": "You are not authorized to perform this action"
}
Forbidden
{
"errorCode": "FORBIDDEN",
"errorMsg": "You do not have permission to access this resource"
}
Rate limit exceeded
{
"errorCode": "RATE_LIMIT_EXCEEDED",
"errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
}
Server error
{
"error_description": "Internal Server error, Please try again in a moment.",
"error_code": "COM0004"
}
![]()
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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.