Modifying the Protection Status of a Domain Name in Dedicated Mode¶
Function¶
This API is used to modify the protection status of a domain name connected to a dedicated WAF instance.
URI¶
PUT /v1/{project_id}/premium-waf/host/{host_id}/protect_status
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID. To obtain it, go to Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.Then, in the Projects area, view Project ID of the corresponding project. |
host_id | Yes | String | ID of the domain name protected by the dedicated WAF engine |
Parameter | Mandatory | Type | Description |
---|---|---|---|
enterprise_project_id | No | String | You can obtain the ID by calling the ListEnterpriseProject API of EPS. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
Content-Type | Yes | String | Content type. Default: application/json;charset=utf8 |
X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Parameter | Mandatory | Type | Description |
---|---|---|---|
protect_status | Yes | Integer | WAF status of the protected domain name.
|
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
protect_status | Integer | WAF status of the protected domain name.
|
Status code: 400
Parameter | Type | Description |
---|---|---|
error_code | String | Error code |
error_msg | String | Error message |
Status code: 401
Parameter | Type | Description |
---|---|---|
error_code | String | Error code |
error_msg | String | Error message |
Status code: 500
Parameter | Type | Description |
---|---|---|
error_code | String | Error code |
error_msg | String | Error message |
Example Requests¶
PUT https://{Endpoint}/v1/{project_id}/premium-waf/host/{host_id}/protect_status?enterprise_project_id=0
{
"protect_status" : 1
}
Example Responses¶
Status code: 200
OK
{
"protect_status" : 1
}
Status Codes¶
Status Code | Description |
---|---|
200 | OK |
400 | Invalid request |
401 | The token does not have the required permission. |
500 | Internal server error. |
Error Codes¶
See Error Codes.