Ir al contenido
AdiosDocumentación
Explorar la documentación

API de seguridad de la puerta de enlace

Configura HTTPS, CORS y WAF para un nombre de host que controle tu equipo.

Usa Autenticación de la API para las solicitudes protegidas. Los ejemplos usan tus propios IDs de recursos y un token temporal; las respuestas de ejemplo guardadas son sintéticas.

MétodoRutaOperación
GET/v1/gateway_security_profileListar perfiles de seguridad del gateway
POST/v1/gateway_security_profileCrear perfil de seguridad de puerta de entrada
GET/v1/gateway_security_profile/{id}Obtener perfil de seguridad de la puerta de entrada
PUT/v1/gateway_security_profile/{id}Actualizar perfil de seguridad del gateway
DELETE/v1/gateway_security_profile/{id}Eliminar el perfil de seguridad de la puerta

Listar perfiles de seguridad del gateway

GET /v1/gateway_security_profile

Devuelve una lista paginada de GatewaySecurityProfile

Autenticación: token bearer y la cabecera de equipo que se muestra a continuación.

Parámetros

NombreUbicaciónObligatorioDescripción
X-Tenant-IDcabecerasíID del equipo activo. Debe coincidir con el tenant vinculado al token de diagnóstico.
pageconsultanoNúmero de página
per_pageconsultanoElementos por página

Ejemplo de solicitud

Configura ADIOS_API_URL=https://api.adios.dev. Para las solicitudes protegidas, configura ADIOS_ACCESS_TOKEN y ADIOS_TEAM_ID como en el inicio rápido. Configura las variables adicionales ADIOS_* a partir de los resultados de tus propios recursos.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/gateway_security_profile" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Respuesta: HTTP 200

Lista de GatewaySecurityProfile

Campos de respuesta

CampoTipoDescripción
dataarray
data[].cors_enabledboolean
data[].cors_headersstringCabeceras de solicitud CORS separadas por comas
data[].cors_methodsstringMétodos HTTP separados por comas
data[].cors_originsstringOrígenes separados por comas o *
data[].created_atinteger(marca de tiempo Unix)
data[].deleted_atinteger(marca de tiempo Unix)
data[].enabledboolean
data[].force_httpsboolean
data[].geo_policyobjectPolítica opcional de países permitidos o bloqueados para el host
data[].hostnamestring
data[].hsts_enabledboolean
data[].max_body_bytesintegerLímite opcional del tamaño del cuerpo de solicitud. 0 indica el valor predeterminado de la plataforma.
data[].profile_idstring
data[].team_idstring
data[].updated_atinteger(marca de tiempo Unix)
data[].waf_custom_directivesstringDirectivas Coraza sin procesar usadas cuando waf_template=custom
data[].waf_modestringValores permitidos: off, monitor, block.
data[].waf_overridesobjectAjustes estructurados de la plantilla (por ejemplo, exclusiones por ruta o activación y desactivación de reglas)
data[].waf_rule_exclusionsobjectLista de exclusión administrada opcional. Ejemplo: [{"path_prefix":"/api/monitoring","remove_rule_ids":[920420]}]
data[].waf_templatestringPlantilla preconfigurada de reglas WAF para este host. Valores permitidos: platform_default, workload_default, api_strict, nextjs, django, wordpress, custom.
paginationobject
pagination.pageintegerNúmero de página actual
pagination.per_pageintegerNúmero de elementos por página
pagination.totalintegerNúmero total de elementos

Ejemplo ilustrativo; no es una respuesta real:

{
  "data": [
    {
      "cors_enabled": true,
      "cors_headers": "example",
      "cors_methods": "example",
      "cors_origins": "example",
      "created_at": 1791072000,
      "deleted_at": 0,
      "enabled": true,
      "force_https": true,
      "geo_policy": {},
      "hostname": "app.example.com",
      "hsts_enabled": true,
      "max_body_bytes": 0,
      "profile_id": "000000000000000000000000001",
      "team_id": "000000000000000000000000001",
      "updated_at": 1791072000,
      "waf_custom_directives": "example",
      "waf_mode": "off",
      "waf_overrides": {},
      "waf_rule_exclusions": {},
      "waf_template": "workload_default"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 1,
    "total": 1
  }
}

Crear perfil de seguridad de puerta de entrada

POST /v1/gateway_security_profile

Crea un nuevo GatewaySecurityProfile

Esta solicitud modifica datos o inicia una acción. Revisa el destino y el cuerpo antes de enviarla.

Campos de la solicitud (el cuerpo contiene un ejemplo editable):

CampoTipoObligatorioDescripción
cors_enabledbooleansíValor predeterminado: true.
cors_headersstringnoCabeceras de solicitud CORS separadas por comas
cors_methodsstringnoMétodos HTTP separados por comas
cors_originsstringnoOrígenes separados por comas o *
enabledbooleansíValor predeterminado: true.
force_httpsbooleansíValor predeterminado: true.
geo_policyobjectnoPolítica opcional de países permitidos o bloqueados para el host
hostnamestringsí
hsts_enabledbooleansíValor predeterminado: true.
max_body_bytesintegernoLímite opcional del tamaño del cuerpo de solicitud. 0 indica el valor predeterminado de la plataforma. Valor predeterminado: 0.
team_idstringsí
waf_custom_directivesstringnoDirectivas Coraza sin procesar usadas cuando waf_template=custom
waf_modestringsíValores permitidos: off, monitor, block. Valor predeterminado: "off".
waf_overridesobjectnoAjustes estructurados de la plantilla (por ejemplo, exclusiones por ruta o activación y desactivación de reglas)
waf_rule_exclusionsobjectnoLista de exclusión administrada opcional. Ejemplo: [{"path_prefix":"/api/monitoring","remove_rule_ids":[920420]}]
waf_templatestringsíPlantilla preconfigurada de reglas WAF para este host. Valores permitidos: platform_default, workload_default, api_strict, nextjs, django, wordpress, custom. Valor predeterminado: "workload_default".

Autenticación: token bearer y la cabecera de equipo que se muestra a continuación.

Parámetros

NombreUbicaciónObligatorioDescripción
X-Tenant-IDcabecerasíID del equipo activo. Debe coincidir con el tenant vinculado al token de diagnóstico.

Ejemplo de solicitud

Configura ADIOS_API_URL=https://api.adios.dev. Para las solicitudes protegidas, configura ADIOS_ACCESS_TOKEN y ADIOS_TEAM_ID como en el inicio rápido. Configura las variables adicionales ADIOS_* a partir de los resultados de tus propios recursos.

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/gateway_security_profile" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "cors_enabled": true,
  "enabled": true,
  "force_https": true,
  "hostname": "YOUR_HOSTNAME",
  "hsts_enabled": true,
  "max_body_bytes": 0,
  "team_id": "YOUR_TEAM_ID",
  "waf_mode": "off",
  "waf_template": "workload_default"
}
JSON

Reemplaza los marcadores YOUR_* del cuerpo antes de enviar la solicitud. El heredoc entrecomillado conserva el JSON literal.

Respuesta: HTTP 201

GatewaySecurityProfile creado

Campos de respuesta

CampoTipoDescripción
cors_enabledboolean
cors_headersstringCabeceras de solicitud CORS separadas por comas
cors_methodsstringMétodos HTTP separados por comas
cors_originsstringOrígenes separados por comas o *
created_atinteger(marca de tiempo Unix)
deleted_atinteger(marca de tiempo Unix)
enabledboolean
force_httpsboolean
geo_policyobjectPolítica opcional de países permitidos o bloqueados para el host
hostnamestring
hsts_enabledboolean
max_body_bytesintegerLímite opcional del tamaño del cuerpo de solicitud. 0 indica el valor predeterminado de la plataforma.
profile_idstring
team_idstring
updated_atinteger(marca de tiempo Unix)
waf_custom_directivesstringDirectivas Coraza sin procesar usadas cuando waf_template=custom
waf_modestringValores permitidos: off, monitor, block.
waf_overridesobjectAjustes estructurados de la plantilla (por ejemplo, exclusiones por ruta o activación y desactivación de reglas)
waf_rule_exclusionsobjectLista de exclusión administrada opcional. Ejemplo: [{"path_prefix":"/api/monitoring","remove_rule_ids":[920420]}]
waf_templatestringPlantilla preconfigurada de reglas WAF para este host. Valores permitidos: platform_default, workload_default, api_strict, nextjs, django, wordpress, custom.

Ejemplo ilustrativo; no es una respuesta real:

{
  "cors_enabled": true,
  "cors_headers": "example",
  "cors_methods": "example",
  "cors_origins": "example",
  "created_at": 1791072000,
  "deleted_at": 0,
  "enabled": true,
  "force_https": true,
  "geo_policy": {},
  "hostname": "app.example.com",
  "hsts_enabled": true,
  "max_body_bytes": 0,
  "profile_id": "000000000000000000000000001",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "waf_custom_directives": "example",
  "waf_mode": "off",
  "waf_overrides": {},
  "waf_rule_exclusions": {},
  "waf_template": "workload_default"
}

Obtener perfil de seguridad de la puerta de entrada

GET /v1/gateway_security_profile/{id}

Devuelve un único GatewaySecurityProfile

Configura gateway_security_profile_id usando IDs de tus propias respuestas de la API.

Autenticación: token bearer y la cabecera de equipo que se muestra a continuación.

Parámetros

NombreUbicaciónObligatorioDescripción
idrutasíIdentificador del recurso obtenido de los resultados de la API de tu equipo.
X-Tenant-IDcabecerasíID del equipo activo. Debe coincidir con el tenant vinculado al token de diagnóstico.

Ejemplo de solicitud

Configura ADIOS_API_URL=https://api.adios.dev. Para las solicitudes protegidas, configura ADIOS_ACCESS_TOKEN y ADIOS_TEAM_ID como en el inicio rápido. Configura las variables adicionales ADIOS_* a partir de los resultados de tus propios recursos.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/gateway_security_profile/${ADIOS_GATEWAY_SECURITY_PROFILE_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Respuesta: HTTP 200

GatewaySecurityProfile

Campos de respuesta

CampoTipoDescripción
cors_enabledboolean
cors_headersstringCabeceras de solicitud CORS separadas por comas
cors_methodsstringMétodos HTTP separados por comas
cors_originsstringOrígenes separados por comas o *
created_atinteger(marca de tiempo Unix)
deleted_atinteger(marca de tiempo Unix)
enabledboolean
force_httpsboolean
geo_policyobjectPolítica opcional de países permitidos o bloqueados para el host
hostnamestring
hsts_enabledboolean
max_body_bytesintegerLímite opcional del tamaño del cuerpo de solicitud. 0 indica el valor predeterminado de la plataforma.
profile_idstring
team_idstring
updated_atinteger(marca de tiempo Unix)
waf_custom_directivesstringDirectivas Coraza sin procesar usadas cuando waf_template=custom
waf_modestringValores permitidos: off, monitor, block.
waf_overridesobjectAjustes estructurados de la plantilla (por ejemplo, exclusiones por ruta o activación y desactivación de reglas)
waf_rule_exclusionsobjectLista de exclusión administrada opcional. Ejemplo: [{"path_prefix":"/api/monitoring","remove_rule_ids":[920420]}]
waf_templatestringPlantilla preconfigurada de reglas WAF para este host. Valores permitidos: platform_default, workload_default, api_strict, nextjs, django, wordpress, custom.

Ejemplo ilustrativo; no es una respuesta real:

{
  "cors_enabled": true,
  "cors_headers": "example",
  "cors_methods": "example",
  "cors_origins": "example",
  "created_at": 1791072000,
  "deleted_at": 0,
  "enabled": true,
  "force_https": true,
  "geo_policy": {},
  "hostname": "app.example.com",
  "hsts_enabled": true,
  "max_body_bytes": 0,
  "profile_id": "000000000000000000000000001",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "waf_custom_directives": "example",
  "waf_mode": "off",
  "waf_overrides": {},
  "waf_rule_exclusions": {},
  "waf_template": "workload_default"
}

Actualizar perfil de seguridad del gateway

PUT /v1/gateway_security_profile/{id}

Actualiza un GatewaySecurityProfile existente

Configura gateway_security_profile_id usando IDs de tus propias respuestas de la API.

Esta solicitud modifica datos o inicia una acción. Revisa el destino y el cuerpo antes de enviarla.

Campos de la solicitud (el cuerpo contiene un ejemplo editable):

CampoTipoObligatorioDescripción
cors_enabledbooleansíValor predeterminado: true.
cors_headersstringnoCabeceras de solicitud CORS separadas por comas
cors_methodsstringnoMétodos HTTP separados por comas
cors_originsstringnoOrígenes separados por comas o *
enabledbooleansíValor predeterminado: true.
force_httpsbooleansíValor predeterminado: true.
geo_policyobjectnoPolítica opcional de países permitidos o bloqueados para el host
hostnamestringsí
hsts_enabledbooleansíValor predeterminado: true.
max_body_bytesintegernoLímite opcional del tamaño del cuerpo de solicitud. 0 indica el valor predeterminado de la plataforma. Valor predeterminado: 0.
team_idstringsí
waf_custom_directivesstringnoDirectivas Coraza sin procesar usadas cuando waf_template=custom
waf_modestringsíValores permitidos: off, monitor, block. Valor predeterminado: "off".
waf_overridesobjectnoAjustes estructurados de la plantilla (por ejemplo, exclusiones por ruta o activación y desactivación de reglas)
waf_rule_exclusionsobjectnoLista de exclusión administrada opcional. Ejemplo: [{"path_prefix":"/api/monitoring","remove_rule_ids":[920420]}]
waf_templatestringsíPlantilla preconfigurada de reglas WAF para este host. Valores permitidos: platform_default, workload_default, api_strict, nextjs, django, wordpress, custom. Valor predeterminado: "workload_default".

Autenticación: token bearer y la cabecera de equipo que se muestra a continuación.

Parámetros

NombreUbicaciónObligatorioDescripción
idrutasíIdentificador del recurso obtenido de los resultados de la API de tu equipo.
X-Tenant-IDcabecerasíID del equipo activo. Debe coincidir con el tenant vinculado al token de diagnóstico.

Ejemplo de solicitud

Configura ADIOS_API_URL=https://api.adios.dev. Para las solicitudes protegidas, configura ADIOS_ACCESS_TOKEN y ADIOS_TEAM_ID como en el inicio rápido. Configura las variables adicionales ADIOS_* a partir de los resultados de tus propios recursos.

curl --fail-with-body --request PUT "$ADIOS_API_URL/v1/gateway_security_profile/${ADIOS_GATEWAY_SECURITY_PROFILE_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "cors_enabled": true,
  "enabled": true,
  "force_https": true,
  "hostname": "YOUR_HOSTNAME",
  "hsts_enabled": true,
  "max_body_bytes": 0,
  "team_id": "YOUR_TEAM_ID",
  "waf_mode": "off",
  "waf_template": "workload_default"
}
JSON

Reemplaza los marcadores YOUR_* del cuerpo antes de enviar la solicitud. El heredoc entrecomillado conserva el JSON literal.

Respuesta: HTTP 200

GatewaySecurityProfile actualizado

Campos de respuesta

CampoTipoDescripción
cors_enabledboolean
cors_headersstringCabeceras de solicitud CORS separadas por comas
cors_methodsstringMétodos HTTP separados por comas
cors_originsstringOrígenes separados por comas o *
created_atinteger(marca de tiempo Unix)
deleted_atinteger(marca de tiempo Unix)
enabledboolean
force_httpsboolean
geo_policyobjectPolítica opcional de países permitidos o bloqueados para el host
hostnamestring
hsts_enabledboolean
max_body_bytesintegerLímite opcional del tamaño del cuerpo de solicitud. 0 indica el valor predeterminado de la plataforma.
profile_idstring
team_idstring
updated_atinteger(marca de tiempo Unix)
waf_custom_directivesstringDirectivas Coraza sin procesar usadas cuando waf_template=custom
waf_modestringValores permitidos: off, monitor, block.
waf_overridesobjectAjustes estructurados de la plantilla (por ejemplo, exclusiones por ruta o activación y desactivación de reglas)
waf_rule_exclusionsobjectLista de exclusión administrada opcional. Ejemplo: [{"path_prefix":"/api/monitoring","remove_rule_ids":[920420]}]
waf_templatestringPlantilla preconfigurada de reglas WAF para este host. Valores permitidos: platform_default, workload_default, api_strict, nextjs, django, wordpress, custom.

Ejemplo ilustrativo; no es una respuesta real:

{
  "cors_enabled": true,
  "cors_headers": "example",
  "cors_methods": "example",
  "cors_origins": "example",
  "created_at": 1791072000,
  "deleted_at": 0,
  "enabled": true,
  "force_https": true,
  "geo_policy": {},
  "hostname": "app.example.com",
  "hsts_enabled": true,
  "max_body_bytes": 0,
  "profile_id": "000000000000000000000000001",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "waf_custom_directives": "example",
  "waf_mode": "off",
  "waf_overrides": {},
  "waf_rule_exclusions": {},
  "waf_template": "workload_default"
}

Eliminar el perfil de seguridad de la puerta

DELETE /v1/gateway_security_profile/{id}

Elimina un GatewaySecurityProfile

Configura gateway_security_profile_id usando IDs de tus propias respuestas de la API.

Esta solicitud modifica datos o inicia una acción. Revisa el destino y el cuerpo antes de enviarla.

Autenticación: token bearer y la cabecera de equipo que se muestra a continuación.

Parámetros

NombreUbicaciónObligatorioDescripción
idrutasíIdentificador del recurso obtenido de los resultados de la API de tu equipo.
X-Tenant-IDcabecerasíID del equipo activo. Debe coincidir con el tenant vinculado al token de diagnóstico.

Ejemplo de solicitud

Configura ADIOS_API_URL=https://api.adios.dev. Para las solicitudes protegidas, configura ADIOS_ACCESS_TOKEN y ADIOS_TEAM_ID como en el inicio rápido. Configura las variables adicionales ADIOS_* a partir de los resultados de tus propios recursos.

curl --fail-with-body --request DELETE "$ADIOS_API_URL/v1/gateway_security_profile/${ADIOS_GATEWAY_SECURITY_PROFILE_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Respuesta: HTTP 200

Recurso eliminado.

Campos de respuesta

CampoTipoDescripción
messagestring

Ejemplo ilustrativo; no es una respuesta real:

{
  "message": "Deleted successfully"
}