# Add Domain Whitelist - AddWafDomainWhiteList

## Overview

Add Domain Whitelist






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `AddWafDomainWhiteList`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.dezai.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ProjectId** | string | Project ID. If not filled in, the default project is used, and the sub-account must be filled in. Please refer to the [GetProjectList interface](/docs/api/summary/get_project_list). |No|
| **FullDomain** | string | Domain name to be added to the whitelist |**Yes**|
| **Source** | string | Whitelist Source; Optional values: User-defined (custom), Machine Behavior Detection (bot), bot-rule |**Yes**|
| **CIDRS.N** | string | IP, subnet or IP range, pass array |**Yes**|
| **RecordId** | int | Domain Record |No|
| **Name** | string | Name |No|
| **Remark** | string | Note Information |No|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **Id** | int | Domain whitelist ID returned after successful addition |No|




## Example

### Request Example
    
```
https://api.dezai.com/?Action=AddWafDomainWhiteList
&ProjectId=org-xxx
&FullDomain=www.test.com
&Source=custom
&Type=custom
&CIDRS.0=2.2.2.2/28
&Name=test
&Remark=test
```

### Response Example
    
```json
{
  "Action": "AddWafDomainWhiteListResponse",
  "Id": 2,
  "RetCode": 0
}
```