Creación de una política de protección
Función
Esta API se utiliza para crear una política WAF.
URI
POST /v1/{project_id}/waf/policy
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto |
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 |
Sí |
String |
Nombre de la política. Puede contener solo dígitos, letras y guiones bajos (_) y no puede superar los 64 caracteres. |
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 |
full_detection |
Boolean |
Modo de detección en la regla de protección precisa |
hosts |
Array of strings |
ID del sitio web protegido |
bind_host |
Array of BindHost objects |
Información del sitio web protegido |
timestamp |
Long |
Hora en que se crea una política |
extend |
Object |
Campo extendido |
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: nube (modo nube) / 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: 403
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
POST https://{Endpoint}/v1/{project_id}/waf/policy?enterprise_project_id=0 { "name" : "demo" }
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" : true, "geoip" : true, "ignore" : true, "privacy" : true, "antitamper" : true, "anticrawler" : false, "antileakage" : false, "followed_action" : false, "bot_enable" : true, "modulex_enabled" : false }, "hosts" : [ ], "extend" : { }, "timestamp" : 1650529538732, "full_detection" : false, "bind_host" : [ ] }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
OK |
400 |
Error de solicitud. |
401 |
Permisos de token insuficientes. |
403 |
La cuota de recursos es insuficiente. |
500 |
Error de servidor interno. |
Códigos de error
Consulte Códigos de error.