Listar los conjuntos de reglas

GET /api/v1/firewall/sets

operationIdgetFirewallSets

Nivel requerido: Solo lectura
Cuota: lectura, 3600 llamadas por hora

Conjuntos de reglas definidos en la cuenta, reutilizables en varios VPS. Lista no paginada.

Un conjunto es una plantilla: solo actúa sobre un VPS una vez aplicado. Por tanto, no describe el estado real del cortafuegos de una máquina, que se lee con GET /servers/{vmid}/firewall.

applied_to se limita a los VPS que cubre la clave: el conjunto sigue visible porque pertenece a la cuenta, pero los servidores fuera del alcance no se enumeran.

Respuestas

200

Conjuntos de reglas de la cuenta

{
  "data": [
    {
      "id": "34",
      "name": "Web public",
      "description": "HTTPS depuis le bureau",
      "rules": [
        {
          "port": "443",
          "protocol": "TCP",
          "sources": [
            "45.54.45.54"
          ],
          "open_to_any": false
        }
      ],
      "applied_to": [
        "116807"
      ]
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 1,
    "total": 1,
    "total_pages": 1
  }
}

Campos de la respuesta 15

data object[]

obligatorio
id string

Ejemplo: 34
name string
description string
rules object[]
port string

Puerto o intervalo inicio-fin

Ejemplo: 443
protocol string

Protocolo, siempre en mayúsculas

uno de: TCP, UDP
sources string[]

Direcciones o rangos CIDR autorizados; vacío si la regla está abierta a todo el mundo
open_to_any boolean

true si ninguna dirección restringe la regla
applied_to string[]

VPS (cubiertos por la clave) a los que está aplicado el conjunto
meta object

Paginación. Las listas no paginadas lo devuelven todo y meta refleja el número devuelto.

PaginationMeta

obligatorio
page integer (int64)

Página devuelta

Ejemplo: 1
per_page integer (int64)

Tamaño de página

Ejemplo: 25
total integer (int64)

Número total de elementos

Ejemplo: 887
total_pages integer (int64)

Número total de páginas

Ejemplo: 36

401

Autenticación rechazada: invalid_token — encabezado Authorization ausente o mal formado, o clave desconocida; access_disabled — acceso a la API cortado para esta cuenta, o servicio de API cortado momentáneamente por LWS.

encabezado Authorization ausente o mal formado, o clave desconocida

{
  "type": "https://docs.lws.fr/kvm/errors/invalid-token",
  "title": "Authentification invalide",
  "status": 401,
  "code": "invalid_token",
  "detail": "Clé inconnue ou révoquée.",
  "request_id": "3f9a1c07b2e45d18"
}

acceso a la API cortado para esta cuenta, o servicio de API cortado momentáneamente por LWS

{
  "type": "https://docs.lws.fr/kvm/errors/access-disabled",
  "title": "Accès API désactivé",
  "status": 401,
  "code": "access_disabled",
  "detail": "L'accès API est désactivé pour ce compte. Réactivez-le depuis la page « API / MCP » du panel.",
  "request_id": "3f9a1c07b2e45d18"
}

Campos de la respuesta 18

type string (uri)

Ejemplo: https://docs.lws.fr/kvm/errors/vm-not-found

obligatorio
title string

Título breve

Ejemplo: VPS introuvable

obligatorio
status integer (int64)

Estado HTTP

Ejemplo: 404

obligatorio
code string

Código de máquina estable (véase «Errores» en Primeros pasos)

Ejemplo: vm_not_found

obligatorio
detail string

Mensaje detallado

Ejemplo: Aucun VPS 999999 sur ce compte.

obligatorio
request_id string

Identificador de la petición, que debe facilitarse al soporte

Ejemplo: 3f9a1c07b2e45d18

obligatorio
errors object

validation_failed: mensaje por parámetro erróneo
required_level string

insufficient_scope: nivel exigido por la operación

uno de: read, exploitation, full
task_id string

task_already_running: tarea en curso en este VPS

Ejemplo: tsk_000002d5
family string

rate_limited: familia de cuota agotada

uno de: read, mutation, heavy
limit integer (int64)

rate_limited: límite por hora de la familia
retry_after integer (int64)

rate_limited: segundos de espera
lock string

server_locked: bloqueo establecido por el hipervisor (backup, snapshot, suspended…)

Ejemplo: snapshot
reason string

server_locked: operation_in_progress, hay una operación en curso, vuelva a intentarlo tras Retry-After; suspended, el VPS está en hibernación, arránquelo primero; support_notified, bloqueo anómalo, el equipo de LWS ha sido avisado y está interviniendo

uno de: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: naturaleza de la intervención, inicio y fin previsto (null para una incidencia)
kind string

uno de: works, incident
started_at string (date-time)
expected_end string (date-time)

403

Acceso denegado: ip_not_allowed — dirección de origen no autorizada.

{
  "type": "https://docs.lws.fr/kvm/errors/ip-not-allowed",
  "title": "Adresse non autorisée",
  "status": 403,
  "code": "ip_not_allowed",
  "detail": "L'adresse 203.0.113.10 ne figure pas parmi les adresses autorisées de ce compte.",
  "request_id": "3f9a1c07b2e45d18"
}

Campos de la respuesta 18

type string (uri)

Ejemplo: https://docs.lws.fr/kvm/errors/vm-not-found

obligatorio
title string

Título breve

Ejemplo: VPS introuvable

obligatorio
status integer (int64)

Estado HTTP

Ejemplo: 404

obligatorio
code string

Código de máquina estable (véase «Errores» en Primeros pasos)

Ejemplo: vm_not_found

obligatorio
detail string

Mensaje detallado

Ejemplo: Aucun VPS 999999 sur ce compte.

obligatorio
request_id string

Identificador de la petición, que debe facilitarse al soporte

Ejemplo: 3f9a1c07b2e45d18

obligatorio
errors object

validation_failed: mensaje por parámetro erróneo
required_level string

insufficient_scope: nivel exigido por la operación

uno de: read, exploitation, full
task_id string

task_already_running: tarea en curso en este VPS

Ejemplo: tsk_000002d5
family string

rate_limited: familia de cuota agotada

uno de: read, mutation, heavy
limit integer (int64)

rate_limited: límite por hora de la familia
retry_after integer (int64)

rate_limited: segundos de espera
lock string

server_locked: bloqueo establecido por el hipervisor (backup, snapshot, suspended…)

Ejemplo: snapshot
reason string

server_locked: operation_in_progress, hay una operación en curso, vuelva a intentarlo tras Retry-After; suspended, el VPS está en hibernación, arránquelo primero; support_notified, bloqueo anómalo, el equipo de LWS ha sido avisado y está interviniendo

uno de: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: naturaleza de la intervención, inicio y fin previsto (null para una incidencia)
kind string

uno de: works, incident
started_at string (date-time)
expected_end string (date-time)

429

Cuota superada: rate_limited — cuota por hora de la familia agotada.

{
  "type": "https://docs.lws.fr/kvm/errors/rate-limited",
  "title": "Quota dépassé",
  "status": 429,
  "code": "rate_limited",
  "detail": "Quota dépassé pour les opérations de type « read » : 3600 appels par heure. Réessayez dans 37 seconde(s).",
  "request_id": "3f9a1c07b2e45d18",
  "family": "read",
  "limit": 3600,
  "retry_after": 37
}

Campos de la respuesta 18

type string (uri)

Ejemplo: https://docs.lws.fr/kvm/errors/vm-not-found

obligatorio
title string

Título breve

Ejemplo: VPS introuvable

obligatorio
status integer (int64)

Estado HTTP

Ejemplo: 404

obligatorio
code string

Código de máquina estable (véase «Errores» en Primeros pasos)

Ejemplo: vm_not_found

obligatorio
detail string

Mensaje detallado

Ejemplo: Aucun VPS 999999 sur ce compte.

obligatorio
request_id string

Identificador de la petición, que debe facilitarse al soporte

Ejemplo: 3f9a1c07b2e45d18

obligatorio
errors object

validation_failed: mensaje por parámetro erróneo
required_level string

insufficient_scope: nivel exigido por la operación

uno de: read, exploitation, full
task_id string

task_already_running: tarea en curso en este VPS

Ejemplo: tsk_000002d5
family string

rate_limited: familia de cuota agotada

uno de: read, mutation, heavy
limit integer (int64)

rate_limited: límite por hora de la familia
retry_after integer (int64)

rate_limited: segundos de espera
lock string

server_locked: bloqueo establecido por el hipervisor (backup, snapshot, suspended…)

Ejemplo: snapshot
reason string

server_locked: operation_in_progress, hay una operación en curso, vuelva a intentarlo tras Retry-After; suspended, el VPS está en hibernación, arránquelo primero; support_notified, bloqueo anómalo, el equipo de LWS ha sido avisado y está interviniendo

uno de: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: naturaleza de la intervención, inicio y fin previsto (null para una incidencia)
kind string

uno de: works, incident
started_at string (date-time)
expected_end string (date-time)

502

Dependencia inaccesible: upstream_unavailable — inventario de VPS momentáneamente no disponible.

{
  "type": "https://docs.lws.fr/kvm/errors/upstream-unavailable",
  "title": "Service momentanément indisponible",
  "status": 502,
  "code": "upstream_unavailable",
  "detail": "Inventaire des VM indisponible.",
  "request_id": "3f9a1c07b2e45d18"
}

Campos de la respuesta 18

type string (uri)

Ejemplo: https://docs.lws.fr/kvm/errors/vm-not-found

obligatorio
title string

Título breve

Ejemplo: VPS introuvable

obligatorio
status integer (int64)

Estado HTTP

Ejemplo: 404

obligatorio
code string

Código de máquina estable (véase «Errores» en Primeros pasos)

Ejemplo: vm_not_found

obligatorio
detail string

Mensaje detallado

Ejemplo: Aucun VPS 999999 sur ce compte.

obligatorio
request_id string

Identificador de la petición, que debe facilitarse al soporte

Ejemplo: 3f9a1c07b2e45d18

obligatorio
errors object

validation_failed: mensaje por parámetro erróneo
required_level string

insufficient_scope: nivel exigido por la operación

uno de: read, exploitation, full
task_id string

task_already_running: tarea en curso en este VPS

Ejemplo: tsk_000002d5
family string

rate_limited: familia de cuota agotada

uno de: read, mutation, heavy
limit integer (int64)

rate_limited: límite por hora de la familia
retry_after integer (int64)

rate_limited: segundos de espera
lock string

server_locked: bloqueo establecido por el hipervisor (backup, snapshot, suspended…)

Ejemplo: snapshot
reason string

server_locked: operation_in_progress, hay una operación en curso, vuelva a intentarlo tras Retry-After; suspended, el VPS está en hibernación, arránquelo primero; support_notified, bloqueo anómalo, el equipo de LWS ha sido avisado y está interviniendo

uno de: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: naturaleza de la intervención, inicio y fin previsto (null para una incidencia)
kind string

uno de: works, incident
started_at string (date-time)
expected_end string (date-time)

Listar los conjuntos de reglas

Respuestas

Informar de un error

Asistente IA