Retrieve list of webdomains

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 webdomains.

Endpoints

Request URL

https://{serverurl}/bsp/api/v1/bmp/webdomains

Scope

DesktopCentralCloud.BrowserManager.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

typestringOptional

Filter by webdomain type category. Example: 'allowed', 'blocked'

search_bspstringOptional

Search string to filter webdomains by URL or name (contains match). Example: 'google.com', 'social'

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/webdomains \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object

Paginated webdomain list response with standard webdomain entries

Hide Sub-Attributes
pagingJSON Object

Pagination metadata

Show Sub-Attributes
nextstring

URL for the next page of results, if available

previousstring

URL for the previous page of results, if available

webdomainsJSON Array

Webdomain entries

Show Sub-Attributes
JSON Object

Webdomain item in list response

Show Sub-Attributes
webdomain_idinteger

Unique identifier of the webdomain

webdomain_namestring

Name of the webdomain

urlstring

Display URL of the webdomain

- HTTP code 400

Response Body - application/json
JSON Object

Bad request error when limit exceeds maximum allowed value

Hide Sub-Attributes
errorCodestring

Error code indicating the limit parameter exceeds the allowed maximum

errorMsgstring

Message indicating the allowed range was exceeded

urlstring

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

Internal server error when listing webdomains

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

All webdomains

Copied!
  {
    "webdomains": [
      {
        "webdomain_name": "localhost",
        "webdomain_id": "3",
        "url": "localhost"
      },
      {
        "webdomain_name": "mail.google.com",
        "webdomain_id": "21",
        "url": "mail.google.com"
      },
      {
        "webdomain_name": "www.abc.com",
        "webdomain_id": "10",
        "url": "www.abc.com"
      },
      {
        "webdomain_name": "www.youtube.com",
        "webdomain_id": "7",
        "url": "www.youtube.com"
      }
    ]
  }
                
Show full

Page with previous link

Copied!
  {
    "webdomains": [
      {
        "webdomain_name": "www.bbc.com",
        "webdomain_id": "17",
        "url": "www.bbc.com"
      },
      {
        "webdomain_name": "www.xyz.com",
        "webdomain_id": "13",
        "url": "www.xyz.com"
      },
      {
        "webdomain_name": "www.youtube.com",
        "webdomain_id": "7",
        "url": "www.youtube.com"
      }
    ],
    "paging": {
      "previous": "<server-url>/bsp/api/v1/bmp/webdomains?skip-token=NTA6LTQ2OjI6MTc3NTU4MzA2NTE1Mg%3D%3D"
    }
  }
                
Show full

Webdomains with plugin count

Copied!
  {
    "webdomains": [
      {
        "webdomain_name": "flash-site.com",
        "webdomain_id": "15",
        "plugin_count": 5,
        "url": "flash-site.com"
      }
    ]
  }
                
Show full

Sample Response: HTTP 400

Limit exceeded

Copied!
  {
    "errorCode": "ARRAY_SIZE_OUT_OF_RANGE",
    "url": "/bsp/api/v1/bmp/webdomains",
    "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

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: 120 | 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.