Ir a la documentación
DocumentaciónReferencia de la APIGestionar un cortafuegos
POSTToken Bearer

Gestionar un cortafuegos

/api/v1/firewalls

Gestiona nombres, reglas, selección predeterminada y asociaciones de servidores de los cortafuegos de la organización.

Antes de llamar

Cambiar reglas o asociaciones puede interrumpir el acceso SSH. Los recursos del sistema no se pueden editar. Conserva requestKey al reintentar; un resultado incierto del proveedor puede devolver 409.

Los nombres de campos, los tipos y el código de la API se mantienen iguales en todos los idiomas.

Ejemplo de petición

cURL
curl "https://tovahub.com/api/v1/firewalls" -X POST \
  -H "Authorization: Bearer $TOVAHUB_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "action": "create",
  "requestKey": "docs_example_001",
  "name": "my-firewall"
}'

Solo ejemplos. Esta página no envía peticiones.

Parámetros

actionCuerpo JSON · Obligatorio

"create" | "rules" | "rename" | "default" | "servers" | "attach" | "delete"

Cada acción acepta solo sus campos: create (name, rules); rules (id, rules); rename (id, name); default/delete (id); servers (id, serverIds); attach (id, serverId). Todas requieren también requestKey.

idCuerpo JSON · Opcional

string

system o un ID de firewall de 24 caracteres. Obligatorio salvo para create. Los recursos del sistema no se pueden editar.

nameCuerpo JSON · Opcional

string

Nombre de 1 a 80 caracteres tras quitar espacios iniciales y finales. Obligatorio para create y rename; las demás acciones lo rechazan.

rulesCuerpo JSON · Opcional

object[]

Hasta 64 reglas. Obligatorio para rules; en create se usa [] por defecto. Cada regla requiere displayName (1–255 caracteres), protocol (tcp, udp, icmp o cadena vacía), destPorts (hasta 15 puertos/rangos, 0–65535), ipv4 (hasta 100 IP/CIDR o AnyIPv4), ipv6 (hasta 100 IP/CIDR o AnyIPv6), action: accept y status: active. Al menos una lista de IP debe contener elementos. TCP/UDP requieren puertos; ICMP no los requiere.

requestKeyCuerpo JSON · Obligatorio

string

Entre 8 y 100 caracteres: A–Z, a–z, 0–9, guion bajo o guion. Al reintentar la misma operación, conserve la clave y todos los datos de entrada.

serverIdsCuerpo JSON · Opcional

string[]

Obligatorio para servers. Hasta 100 ID de servidor de la plataforma, cada uno de 24 caracteres hexadecimales.

serverIdCuerpo JSON · Opcional

string

Obligatorio para attach. ID de servidor de la plataforma de 24 caracteres hexadecimales.

Respuesta

Estado HTTP 200

Devuelve el resultado confirmado del cambio del firewall; si el resultado del proveedor es incierto, genera un error en lugar de inventar un comprobante de tarea.

okboolean (true)

La operación de firewall solicitada se completó o se devolvió correctamente su resultado original.

pendingboolean (false)

Las ramas de éxito de la implementación actual siempre devuelven false.

idstring

Identificador del firewall afectado en la plataforma, o system cuando la acción lo permite.