Updating a Protected Domain Name
Function
This API is used to update a protected domain name.
URI
PUT /v1/edgewaf/domains/{domainid}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domainid |
Yes |
String |
Domain name. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
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 |
No |
Integer |
Protection status Minimum: 0 Maximum: 1 |
access_status |
No |
Integer |
Access status Minimum: 0 Maximum: 1 |
web_tag |
No |
String |
Domain name |
description |
No |
String |
Domain name description |
certificate_id |
No |
String |
Certificate ID, which is obtained through the ListCertificates API.
|
enterprise_project_id |
No |
String |
Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). |
tls |
No |
String |
Minimum TLS version (TLS v1.0, TLS v1.1, or TLS v1.2). The default value is TLS v1.0. The TLS parameter is configured only if the client protocol is HTTPS. Enumeration values:
|
cipher |
No |
String |
The cipher parameter is available only if the client protocol is HTTPS. Its values are as follows, each representing a cryptographic algorithm:
Enumeration values:
|
block_page |
No |
WafBlockPage object |
Blocking page configuration |
traffic_mark |
No |
WafTrafficMark object |
Traffic identifier (used for known attack source rules) |
flag |
No |
Flag object |
Special identifier, which is used by the frontend. |
extend |
No |
Map<String,String> |
Extensible field of the domain name. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
template |
Yes |
String |
Blocking template name |
custom_page |
No |
WafCustomPage object |
User-defined blocking page |
redirect_url |
No |
String |
Redirection URL |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
status_code |
Yes |
String |
Status code |
content_type |
Yes |
String |
Content type of alarm page |
content |
Yes |
String |
Page content Minimum: 1 Maximum: 4096 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
sip |
No |
Array of strings |
IP address in the known attack source rule |
cookie |
No |
String |
cookie Minimum: 1 Maximum: 4096 |
params |
No |
String |
Parameter Minimum: 1 Maximum: 4096 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
pci_3ds |
No |
String |
Whether to enable PCI 3DS compliance certification.
Enumeration values:
|
pci_dss |
No |
String |
Whether to enable PCI DSS compliance certification.
Enumeration values:
|
cname |
No |
String |
old: The old CNAME record is used. new: new CNAME record is used. Enumeration values:
|
is_dual_az |
No |
String |
Whether IPv6 is enabled for the domain name.
Enumeration values:
|
ipv6 |
No |
String |
Whether IPv6 is enabled for the domain name.
Enumeration values:
|
Response Parameters
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
Updating the WAF protection status of a domain name.
PUT https://{Endpoint}/v1/edgewaf/domains/1771a426afcc4e16b8636cb72c2d53e4 { "protect_status" : 1, "enterprise_project_id" : 0 }
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
400 |
Request failed. |
401 |
The token does not have required permissions. |
500 |
Internal server error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot