# Retrieve details of a specific webdomain Fetches the details of a single webdomain, including its name, URL, and type. ## Endpoint `GET /bsp/api/v1/bmp/webdomains/{web_domain_id}` ## Request ### Request URL https://[*{serverurl}*](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)/bsp/api/v1/bmp/webdomains/{web_domain_id} ### Scope `DesktopCentralCloud.BrowserManager.READ` ### Header ```http Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52 ``` ### Request Parameters #### Request Headers - **Accept** `string` — Mandatory - `application/json` #### Path Parameters - **web_domain_id** `string` — Mandatory - Web domain ID from [List WebDomains](https://www.manageengine.com/products/desktop-central/help/api/cloud/websites-list-web-domains.html) or [Add WebDomain](https://www.manageengine.com/products/desktop-central/help/api/cloud/websites-add-web-domain.html) response ### Sample Request ```curl curl --request GET \ --url https://appdomains/bsp/api/v1/bmp/webdomains/{web_domain_id} \ --header 'Accept: application/json' \ --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' ``` ## Response Parameters ### HTTP Code 200 #### Response Body — application/json `JSON Object` Webdomain details with optional path and query parameters. - **webdomain_id** `integer` - Unique identifier of the webdomain - **webdomain_name** `string` - Name of the webdomain - **url** `string` - Display URL of the webdomain - **url_path** `string` - URL path component, present only for fully-defined URLs - **url_params** `string` - URL query parameters, present only for fully-defined URLs #### Sample Response: HTTP 200 ##### Domain details ```json { "webdomain_name": "facebook.com", "url_params": "", "webdomain_id": 107, "url": "facebook.com", "url_path": "" } ``` ##### Fully-defined URL details ```json { "webdomain_name": "https://example.com/path?q=test", "url_params": "q=test", "webdomain_id": 108, "url": "example.com", "url_path": "/path" } ``` ##### Not found ```json {} ``` ### HTTP Code 401 #### Response Body — application/json `JSON Object` - **errorCode** `long` - Unauthorized error code: credentials missing, expired, or invalid - **errorMsg** `string` - Authentication failure reason #### Sample Response: HTTP 401 ##### Unauthorized ```json { "errorCode": "UNAUTHORIZED", "errorMsg": "You are not authorized to perform this action" } ``` ### HTTP Code 403 #### Response Body — application/json `JSON Object` - **errorCode** `long` - Error code indicating insufficient permissions - **errorMsg** `string` - Message indicating insufficient privileges to access this resource #### Sample Response: HTTP 403 ##### Forbidden ```json { "errorCode": "FORBIDDEN", "errorMsg": "You do not have permission to access this resource" } ``` ### HTTP Code 429 #### Response Body — application/json `JSON Object` - **errorCode** `long` - Rate limit error code returned when the API call reached threshold - **errorMsg** `string` - Rate limit exceeded message with retry guidance #### Sample Response: HTTP 429 ##### Rate limit exceeded ```json { "errorCode": "RATE_LIMIT_EXCEEDED", "errorMsg": "You have exceeded the maximum number of API calls. Please try again later." } ``` ### HTTP Code 500 #### Response Body — application/json `JSON Object` Internal server error when fetching webdomain details. - **error_description** `string` - Message describing the server-side failure - **error_code** `string` - Internal server error code #### Sample Response: HTTP 500 ##### Server error ```json { "error_description": "Internal Server error, Please try again in a moment.", "error_code": "COM0004" } ``` ## Possible Response Codes - `200` — HTTP code - `401` — HTTP code - `403` — HTTP code - `429` — HTTP code - `500` — HTTP code ## Rate Limit **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.