Creare un set di regole

POST /api/v1/firewall/sets

operationIdpostFirewallSet

Livello richiesto: Operatività
Quota: modifica, 300 chiamate all'ora

Definisce un modello di regole. Alla creazione non è applicato ad alcun VPS (applied_to vuoto): non c'è nulla da seguire.

Ogni regola comprende una port (valore singolo o intervallo inizio-fine, limiti da 1 a 65535), un protocol (TCP o UDP) e una subnet facoltativa: uno o più indirizzi IPv4/IPv6, con o senza CIDR, separati da virgole. subnet assente, vuota o NULL significa «da qualsiasi origine», sia in IPv4 sia in IPv6. Il prefisso /0 non è accettato in IPv6 (::/0): per aprire a tutti, lasci subnet vuota.

Request body

application/json

name string

max 100 characters

required
description string

optional
rules object[]

required
port string

Porta (443) o intervallo (8000-8100), limiti da 1 a 65535

Example: 443

required
protocol string

one of: TCP, UDP

required
subnet string

Indirizzi IPv4/IPv6 (CIDR accettato, tranne /0 in IPv6) separati da virgole; assente, vuoto o NULL: da qualsiasi origine, sia in IPv4 sia in IPv6

Example: 45.54.45.54

optional

Example request

{
  "name": "Web public",
  "description": "HTTPS depuis le bureau",
  "rules": [
    {
      "port": "443",
      "protocol": "TCP",
      "subnet": "45.54.45.54"
    }
  ]
}

Responses

201

Set creato

{
  "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": []
  }
}

Response fields 10

data object

FirewallSet

required
id string

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

Porta o intervallo inizio-fine

Example: 443
protocol string

Protocollo, sempre in maiuscolo

one of: TCP, UDP
sources string[]

Indirizzi o intervalli CIDR autorizzati; vuoto se la regola è aperta a tutti
open_to_any boolean

true se nessun indirizzo limita la regola
applied_to string[]

VPS (coperti dalla chiave) a cui il set è applicato

400

Parametri non validi: validation_failed — nome assente o troppo lungo, oppure regola non valida (ne viene indicata la posizione).

{
  "type": "https://docs.lws.fr/kvm/errors/validation-failed",
  "title": "Paramètres invalides",
  "status": 400,
  "code": "validation_failed",
  "detail": "Règle #2 : port hors limites (99999)",
  "request_id": "3f9a1c07b2e45d18",
  "errors": {
    "rules": "Règle #2 : port hors limites (99999)"
  }
}

Response fields 18

type string (uri)

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

required
title string

Titolo breve

Example: VPS introuvable

required
status integer (int64)

Stato HTTP

Example: 404

required
code string

Codice macchina stabile (vedere «Errori» in Per iniziare)

Example: vm_not_found

required
detail string

Messaggio dettagliato

Example: Aucun VPS 999999 sur ce compte.

required
request_id string

Identificativo della richiesta, da comunicare al supporto

Example: 3f9a1c07b2e45d18

required
errors object

validation_failed: messaggio per ogni parametro errato
required_level string

insufficient_scope: livello richiesto dall'operazione

one of: read, exploitation, full
task_id string

task_already_running: task in corso su questo VPS

Example: tsk_000002d5
family string

rate_limited: famiglia di quota esaurita

one of: read, mutation, heavy
limit integer (int64)

rate_limited: limite orario della famiglia
retry_after integer (int64)

rate_limited: secondi da attendere
lock string

server_locked: blocco impostato dall'hypervisor (backup, snapshot, suspended…)

Example: snapshot
reason string

server_locked: operation_in_progress, è in corso un'operazione, riprovi dopo Retry-After; suspended, il VPS è in ibernazione, lo avvii prima; support_notified, blocco anomalo, il team LWS è stato avvisato e sta intervenendo

one of: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: natura dell'intervento, inizio e fine prevista (null per un incidente)
kind string

one of: works, incident
started_at string (date-time)
expected_end string (date-time)

401

Autenticazione rifiutata: invalid_token — intestazione Authorization assente o non valida, oppure chiave sconosciuta; access_disabled — accesso API disattivato per questo account, oppure servizio API momentaneamente sospeso da LWS.

intestazione Authorization assente o non valida, oppure chiave sconosciuta

{
  "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"
}

accesso API disattivato per questo account, oppure servizio API momentaneamente sospeso da 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"
}

Response fields 18

type string (uri)

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

required
title string

Titolo breve

Example: VPS introuvable

required
status integer (int64)

Stato HTTP

Example: 404

required
code string

Codice macchina stabile (vedere «Errori» in Per iniziare)

Example: vm_not_found

required
detail string

Messaggio dettagliato

Example: Aucun VPS 999999 sur ce compte.

required
request_id string

Identificativo della richiesta, da comunicare al supporto

Example: 3f9a1c07b2e45d18

required
errors object

validation_failed: messaggio per ogni parametro errato
required_level string

insufficient_scope: livello richiesto dall'operazione

one of: read, exploitation, full
task_id string

task_already_running: task in corso su questo VPS

Example: tsk_000002d5
family string

rate_limited: famiglia di quota esaurita

one of: read, mutation, heavy
limit integer (int64)

rate_limited: limite orario della famiglia
retry_after integer (int64)

rate_limited: secondi da attendere
lock string

server_locked: blocco impostato dall'hypervisor (backup, snapshot, suspended…)

Example: snapshot
reason string

server_locked: operation_in_progress, è in corso un'operazione, riprovi dopo Retry-After; suspended, il VPS è in ibernazione, lo avvii prima; support_notified, blocco anomalo, il team LWS è stato avvisato e sta intervenendo

one of: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: natura dell'intervento, inizio e fine prevista (null per un incidente)
kind string

one of: works, incident
started_at string (date-time)
expected_end string (date-time)

403

Accesso negato: insufficient_scope — livello della chiave insufficiente; ip_not_allowed — indirizzo di chiamata non autorizzato.

livello della chiave insufficiente

{
  "type": "https://docs.lws.fr/kvm/errors/insufficient-scope",
  "title": "Droits insuffisants",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "Niveau de permission « exploitation » requis.",
  "request_id": "3f9a1c07b2e45d18",
  "required_level": "exploitation"
}

indirizzo di chiamata non autorizzato

{
  "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"
}

Response fields 18

type string (uri)

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

required
title string

Titolo breve

Example: VPS introuvable

required
status integer (int64)

Stato HTTP

Example: 404

required
code string

Codice macchina stabile (vedere «Errori» in Per iniziare)

Example: vm_not_found

required
detail string

Messaggio dettagliato

Example: Aucun VPS 999999 sur ce compte.

required
request_id string

Identificativo della richiesta, da comunicare al supporto

Example: 3f9a1c07b2e45d18

required
errors object

validation_failed: messaggio per ogni parametro errato
required_level string

insufficient_scope: livello richiesto dall'operazione

one of: read, exploitation, full
task_id string

task_already_running: task in corso su questo VPS

Example: tsk_000002d5
family string

rate_limited: famiglia di quota esaurita

one of: read, mutation, heavy
limit integer (int64)

rate_limited: limite orario della famiglia
retry_after integer (int64)

rate_limited: secondi da attendere
lock string

server_locked: blocco impostato dall'hypervisor (backup, snapshot, suspended…)

Example: snapshot
reason string

server_locked: operation_in_progress, è in corso un'operazione, riprovi dopo Retry-After; suspended, il VPS è in ibernazione, lo avvii prima; support_notified, blocco anomalo, il team LWS è stato avvisato e sta intervenendo

one of: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: natura dell'intervento, inizio e fine prevista (null per un incidente)
kind string

one of: works, incident
started_at string (date-time)
expected_end string (date-time)

429

Quota superata: rate_limited — quota oraria della famiglia esaurita.

{
  "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 « mutation » : 300 appels par heure. Réessayez dans 95 seconde(s).",
  "request_id": "3f9a1c07b2e45d18",
  "family": "mutation",
  "limit": 300,
  "retry_after": 95
}

Response fields 18

type string (uri)

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

required
title string

Titolo breve

Example: VPS introuvable

required
status integer (int64)

Stato HTTP

Example: 404

required
code string

Codice macchina stabile (vedere «Errori» in Per iniziare)

Example: vm_not_found

required
detail string

Messaggio dettagliato

Example: Aucun VPS 999999 sur ce compte.

required
request_id string

Identificativo della richiesta, da comunicare al supporto

Example: 3f9a1c07b2e45d18

required
errors object

validation_failed: messaggio per ogni parametro errato
required_level string

insufficient_scope: livello richiesto dall'operazione

one of: read, exploitation, full
task_id string

task_already_running: task in corso su questo VPS

Example: tsk_000002d5
family string

rate_limited: famiglia di quota esaurita

one of: read, mutation, heavy
limit integer (int64)

rate_limited: limite orario della famiglia
retry_after integer (int64)

rate_limited: secondi da attendere
lock string

server_locked: blocco impostato dall'hypervisor (backup, snapshot, suspended…)

Example: snapshot
reason string

server_locked: operation_in_progress, è in corso un'operazione, riprovi dopo Retry-After; suspended, il VPS è in ibernazione, lo avvii prima; support_notified, blocco anomalo, il team LWS è stato avvisato e sta intervenendo

one of: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: natura dell'intervento, inizio e fine prevista (null per un incidente)
kind string

one of: works, incident
started_at string (date-time)
expected_end string (date-time)

502

Dipendenza irraggiungibile: upstream_unavailable — registrazione impossibile.

{
  "type": "https://docs.lws.fr/kvm/errors/upstream-unavailable",
  "title": "Service momentanément indisponible",
  "status": 502,
  "code": "upstream_unavailable",
  "detail": "Le jeu de règles n'a pas pu être enregistré.",
  "request_id": "3f9a1c07b2e45d18"
}

Response fields 18

type string (uri)

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

required
title string

Titolo breve

Example: VPS introuvable

required
status integer (int64)

Stato HTTP

Example: 404

required
code string

Codice macchina stabile (vedere «Errori» in Per iniziare)

Example: vm_not_found

required
detail string

Messaggio dettagliato

Example: Aucun VPS 999999 sur ce compte.

required
request_id string

Identificativo della richiesta, da comunicare al supporto

Example: 3f9a1c07b2e45d18

required
errors object

validation_failed: messaggio per ogni parametro errato
required_level string

insufficient_scope: livello richiesto dall'operazione

one of: read, exploitation, full
task_id string

task_already_running: task in corso su questo VPS

Example: tsk_000002d5
family string

rate_limited: famiglia di quota esaurita

one of: read, mutation, heavy
limit integer (int64)

rate_limited: limite orario della famiglia
retry_after integer (int64)

rate_limited: secondi da attendere
lock string

server_locked: blocco impostato dall'hypervisor (backup, snapshot, suspended…)

Example: snapshot
reason string

server_locked: operation_in_progress, è in corso un'operazione, riprovi dopo Retry-After; suspended, il VPS è in ibernazione, lo avvii prima; support_notified, blocco anomalo, il team LWS è stato avvisato e sta intervenendo

one of: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: natura dell'intervento, inizio e fine prevista (null per un incidente)
kind string

one of: works, incident
started_at string (date-time)
expected_end string (date-time)

Creare un set di regole

Request body

Responses

Report an error

AI assistant