# Retrieve list of webdomains

Retrieves all configured webdomains.

## Endpoint

`GET /bsp/api/v1/bmp/webdomains`

## Request

### Request URL

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

`{serverurl}`: [OAuth Authentication Endpoint Domain](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)

### Scope

`DesktopCentralCloud.BrowserManager.READ`

### Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

- **Accept** `string` (Mandatory): `application/json`

#### Query Parameters

- **type** `string` (Optional): Filter by webdomain type category. Example: 'allowed', 'blocked'
- **search_bsp** `string` (Optional): Search string to filter webdomains by URL or name (contains match). Example: 'google.com', 'social'
- **limit** `integer` (Optional): Max results per page. Example: 50, 100, 200
- **offset** `integer` (Optional): Starting index for results (0-based). Example: 0, 50, 100
- **skip-token** `string` (Optional): Cursor-based pagination token returned from previous response for fetching next page

### Sample Request

```bash
curl --request GET \
  --url https://appdomains/bsp/api/v1/bmp/webdomains \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP 200

Response Body: `application/json`

`JSON Object`: Paginated webdomain list response with standard webdomain entries.

- **paging** `JSON Object`: Pagination metadata
- **webdomains** `JSON Array`: Webdomain entries

### HTTP 400

Response Body: `application/json`

`JSON Object`: Bad request error when limit exceeds maximum allowed value.

- **errorCode** `string`: Error code indicating the limit parameter exceeds the allowed maximum
- **errorMsg** `string`: Message indicating the allowed range was exceeded
- **url** `string`: Request URL that triggered the error

### HTTP 401

Response Body: `application/json`

`JSON Object`

- **errorCode** `long`: Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
- **errorMsg** `string`: Authentication failure reason

### HTTP 403

Response Body: `application/json`

`JSON Object`

- **errorCode** `long`: Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
- **errorMsg** `string`: Message indicating insufficient privileges to access this resource

### HTTP 429

Response Body: `application/json`

`JSON Object`

- **errorCode** `long`: 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
- **errorMsg** `string`: Rate limit exceeded message with retry guidance

### HTTP 500

Response Body: `application/json`

`JSON Object`: Internal server error when listing webdomains.

- **error_description** `string`: Message describing the server-side failure
- **error_code** `string`: Internal server error code

## Sample Responses

### HTTP 200

#### All webdomains

```json
{
  "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"
    }
  ]
}
```

#### Page with previous link

```json
{
  "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"
  }
}
```

#### Webdomains with plugin count

```json
{
  "webdomains": [
    {
      "webdomain_name": "flash-site.com",
      "webdomain_id": "15",
      "plugin_count": 5,
      "url": "flash-site.com"
    }
  ]
}
```

### HTTP 400

#### Limit exceeded

```json
{
  "errorCode": "ARRAY_SIZE_OUT_OF_RANGE",
  "url": "/bsp/api/v1/bmp/webdomains",
  "errorMsg": "Range limit exceeded. Maximum allowed: 1000"
}
```

### HTTP 401

#### Unauthorized

```json
{
  "errorCode": "UNAUTHORIZED",
  "errorMsg": "You are not authorized to perform this action"
}
```

### HTTP 403

#### Forbidden

```json
{
  "errorCode": "FORBIDDEN",
  "errorMsg": "You do not have permission to access this resource"
}
```

### 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 500

#### Server error

```json
{
  "error_description": "Internal Server error, Please try again in a moment.",
  "error_code": "COM0004"
}
```

## Rate Limits

![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

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