Actualización de una política de protección
Función
Esta API se utiliza para actualizar una política de protección. El cuerpo de la solicitud sólo puede contener la parte que se va a actualizar.
URI
PATCH /v1/{project_id}/waf/policy/{policy_id}
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto |
policy_id |
Sí |
String |
ID de política. Se puede obtener llamando a la API ListPolicy. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
enterprise_project_id |
No |
String |
ID del proyecto de empresa. Se puede obtener mediante el llamado API ListEnterpriseProject de EPS. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener llamando a la API IAM (valor de X-Subject-Token en el encabezado de respuesta). |
Content-Type |
Sí |
String |
Tipo de contenido Predeterminado: application/json;charset=utf8 |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
name |
No |
String |
Nombre de la política |
action |
No |
PolicyAction object |
Operación |
options |
No |
PolicyOption object |
Opción |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
category |
No |
String |
Nivel de protección. El valor puede ser log o block. log: WAF solo registra eventos. block: WAF bloquea eventos. Valores de enumeración:
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
webattack |
No |
Boolean |
Si la protección web básica está habilitada Valores de enumeración:
|
common |
No |
Boolean |
Si la comprobación general está activada Valores de enumeración:
|
crawler |
No |
Boolean |
Si la protección antideslizante está activada Valores de enumeración:
|
crawler_engine |
No |
Boolean |
Si el motor de búsqueda está habilitado Valores de enumeración:
|
crawler_scanner |
No |
Boolean |
Si la detección antideslizante está activada Valores de enumeración:
|
crawler_script |
No |
Boolean |
Si el antideslizador JavaScript está activado Valores de enumeración:
|
crawler_other |
No |
Boolean |
Si está activada la comprobación de otro rastreador Valores de enumeración:
|
webshell |
No |
Boolean |
Si la detección de webshell está habilitada Valores de enumeración:
|
cc |
No |
Boolean |
Si las reglas de protección contra ataques de CC están habilitadas Valores de enumeración:
|
custom |
No |
Boolean |
Si la protección precisa está habilitada Valores de enumeración:
|
whiteblackip |
No |
Boolean |
Si la protección de listas negras y blancas está habilitada. Valores de enumeración:
|
geoip |
No |
Boolean |
Si el control de acceso de geolocalización está habilitado Valores de enumeración:
|
ignore |
No |
Boolean |
Si el enmascaramiento de falsa alarma está habilitado. Valores de enumeración:
|
privacy |
No |
Boolean |
Si el enmascaramiento de datos está habilitado Valores de enumeración:
|
antitamper |
No |
Boolean |
Si la protección contra manipulaciones web está activada Valores de enumeración:
|
antileakage |
No |
Boolean |
Si la prevención de fugas de información está activada Valores de enumeración:
|
bot_enable |
No |
Boolean |
Si la mitigación de bots está habilitada Valores de enumeración:
|
modulex_enabled |
No |
Boolean |
Si la protección contra ataques CC para moduleX está habilitada. Esta función se encuentra en la prueba beta abierta (OBT). Durante la OBT, solo se admite el modo de solo registro. Valores de enumeración:
|
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de política |
name |
String |
Nombre de la política |
level |
Integer |
Nivel de protección |
action |
PolicyAction object |
Operación |
options |
PolicyOption object |
Opción |
hosts |
Array of strings |
Información básica sobre el dominio protegido. |
extend |
Map<String,String> |
Campo extendido |
timestamp |
Long |
Hora en que se crea una política |
full_detection |
Boolean |
Modo de detección en la regla de protección precisa |
bind_host |
Array of BindHost objects |
Información básica sobre el dominio protegido. |
Parámetro |
Tipo |
Descripción |
---|---|---|
category |
String |
Nivel de protección. El valor puede ser log o block. log: WAF solo registra eventos. block: WAF bloquea eventos. Valores de enumeración:
|
Parámetro |
Tipo |
Descripción |
---|---|---|
webattack |
Boolean |
Si la protección web básica está habilitada Valores de enumeración:
|
common |
Boolean |
Si la comprobación general está activada Valores de enumeración:
|
crawler |
Boolean |
Si la protección antideslizante está activada Valores de enumeración:
|
crawler_engine |
Boolean |
Si el motor de búsqueda está habilitado Valores de enumeración:
|
crawler_scanner |
Boolean |
Si la detección antideslizante está activada Valores de enumeración:
|
crawler_script |
Boolean |
Si el antideslizador JavaScript está activado Valores de enumeración:
|
crawler_other |
Boolean |
Si está activada la comprobación de otro rastreador Valores de enumeración:
|
webshell |
Boolean |
Si la detección de webshell está habilitada Valores de enumeración:
|
cc |
Boolean |
Si las reglas de protección contra ataques de CC están habilitadas Valores de enumeración:
|
custom |
Boolean |
Si la protección precisa está habilitada Valores de enumeración:
|
whiteblackip |
Boolean |
Si la protección de listas negras y blancas está habilitada. Valores de enumeración:
|
geoip |
Boolean |
Si el control de acceso de geolocalización está habilitado Valores de enumeración:
|
ignore |
Boolean |
Si el enmascaramiento de falsa alarma está habilitado. Valores de enumeración:
|
privacy |
Boolean |
Si el enmascaramiento de datos está habilitado Valores de enumeración:
|
antitamper |
Boolean |
Si la protección contra manipulaciones web está activada Valores de enumeración:
|
antileakage |
Boolean |
Si la prevención de fugas de información está activada Valores de enumeración:
|
bot_enable |
Boolean |
Si la mitigación de bots está habilitada Valores de enumeración:
|
modulex_enabled |
Boolean |
Si la protección contra ataques CC para moduleX está habilitada. Esta función se encuentra en la prueba beta abierta (OBT). Durante la OBT, solo se admite el modo de solo registro. Valores de enumeración:
|
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de nombre de dominio |
hostname |
String |
Nombre de dominio |
waf_type |
String |
Modo de nombre de dominio: cloud (modo de cloud) / premium (modo dedicado) |
mode |
String |
Este parámetro es requerido solamente por el modo dedicado. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error |
error_msg |
String |
Mensaje de código de error |
Código de estad: 401
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error |
error_msg |
String |
Mensaje de código de error |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error |
error_msg |
String |
Mensaje de código de error |
Solicitudes de ejemplo
PATCH https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}?enterprise_project_id=0 { "options" : { "whiteblackip" : false } }
Ejemplo de respuestas
Código de estado: 200
OK
{ "id" : "38ff0cb9a10e4d5293c642bc0350fa6d", "name" : "demo", "level" : 2, "action" : { "category" : "log" }, "options" : { "webattack" : true, "common" : true, "crawler" : true, "crawler_engine" : false, "crawler_scanner" : true, "crawler_script" : false, "crawler_other" : false, "webshell" : false, "cc" : true, "custom" : true, "precise" : false, "whiteblackip" : false, "geoip" : true, "ignore" : true, "privacy" : true, "antitamper" : true, "anticrawler" : false, "antileakage" : false, "followed_action" : false, "bot_enable" : true }, "hosts" : [ "c0268b883a854adc8a2cd352193b0e13" ], "timestamp" : 1650529538732, "full_detection" : false, "bind_host" : [ { "id" : "c0268b883a854adc8a2cd352193b0e13", "hostname" : "www.demo.com", "waf_type" : "cloud" } ], "share_info" : { "is_receiver" : false, "provider_display" : { "share_count" : 0, "accept_count" : 0, "process_status" : 0 } } }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
OK |
400 |
Error de solicitud. |
401 |
Permisos de token insuficientes. |
500 |
Error de servidor interno. |
Códigos de error
Consulte Códigos de error.