Retrieve list of configured webdomain groups

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

Retrieves all configured webdomain groups.

Request URL

https://{serverurl}/bsp/api/v1/bmp/webdomain-groups

Scope

DesktopCentralCloud.BrowserManager.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

searchstringOptional

Search string to filter webdomain groups by name (contains match). Example: 'corporate', 'social-media'

limitintegerOptional

Max results per page. Example: 50, 100, 200

offsetintegerOptional

Starting index for results (0-based). Example: 0, 50, 100

skip-tokenstringOptional

Cursor-based pagination token returned from previous response for fetching next page

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/bsp/api/v1/bmp/webdomain-groups \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
webdomain-groupsJSON Array

Webdomain group summaries. Empty when no groups match the search criteria

Show Sub-Attributes
JSON Object
Show Sub-Attributes
webdomain_group_idstring

Unique identifier for the webdomain group

webdomain_group_namestring

Display name of the webdomain group

- HTTP code 400

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

Error code indicating a query parameter value is out of the allowed range

errorMsgstring

Message describing which parameter exceeded the allowed range

urlstring

The request URL that triggered the error

- HTTP code 401

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

Unauthorized error code: credentials missing, expired, or invalid

errorMsgstring

Authentication failure reason

- HTTP code 403

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

Error code indicating insufficient permissions

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 reached threshold

errorMsgstring

Rate limit exceeded message with retry guidance

- HTTP code 500

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

Message describing the internal server error

error_codestring

Error code identifying the type of server error

Possible Response Codes

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

Sample Response: HTTP 200

Paginated group list

Copied!
  {
    "webdomain-groups": [
      {
        "webdomain_group_id": "623",
        "webdomain_group_name": "Social Media Sites"
      },
      {
        "webdomain_group_id": "619",
        "webdomain_group_name": "Sports"
      }
    ],
    "paging": {
      "previous": "<server-url>/bsp/api/v1/bmp/webdomain-groups?skip-token=NTA6LTQ4OjI6MTc3NTQwODQ4MjQxMA%3D%3D"
    }
  }
                
Show full

Empty result

Copied!
  {
    "webdomain-groups": []
  }
                
Show full

Sample Response: HTTP 400

Limit exceeded

Copied!
  {
    "errorCode": "ARRAY_SIZE_OUT_OF_RANGE",
    "url": "/bsp/api/v1/bmp/webdomain-groups",
    "errorMsg": "Range limit exceeded. Maximum allowed: 1000"
  }
                
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

Insufficient permissions

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.