> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bentoo.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Whitelist Management Interface

### Function

Bulk adds, deletes, and queries whitelist IPs to automate whitelist maintenance, replacing manual one-by-one operations.

### Applicable Scenarios

Automatically synchronizes the whitelist when business IPs change dynamically, preventing proxy access restrictions.

#### (1) Bulk Add Whitelist IPs

* **Request URL**: `https://api.xxx.com/proxies/whitelist/add`
* **Request Method**: `POST`
* **Request Header**: `Authorization: Bearer [Your API Key]`
* **Request Body** (JSON Format):

```json theme={null}
{
  "ips": ["192.168.0.1", "192.168.0.2", "203.0.113.10"]
}
```

* **Successful Response Example**:

```json theme={null}
{
  "code": 200,
  "msg": "Whitelist added successfully. Total 3 IPs added.",
  "data": {
    "added_ips": ["192.168.0.1", "192.168.0.2", "203.0.113.10"],
    "total_count": 5
  }
}
```

#### (2) Bulk Delete Whitelist IPs

* **Request URL**: `https://api.xxx.com/proxies/whitelist/delete`
* **Request Method**: `POST`
* **Request Body** (JSON Format):

```json theme={null}
{
  "ips": ["192.168.0.2"]
}
```

* **Successful Response Example**:

```json theme={null}
{
  "code": 200,
  "msg": "Whitelist deleted successfully. Total 1 IP deleted.",
  "data": {
    "remaining_count": 4
  }
}
```

#### (3) Query Whitelist List

* **Request URL**: `https://api.xxx.com/proxies/whitelist/list`

* **Request Method**: `GET`

* **Request Header**: `Authorization: Bearer [Your API Key]`

* **Successful Response Example**:

```json theme={null}
{
  "code": 200,
  "msg": "Retrieval successful",
  "data": {
    "ips": ["192.168.0.1", "203.0.113.10", "..."],
    "total_count": 4
  }
}
```