Modifier un jeu de règles

PUT /api/v1/firewall/sets/{id}

operationIdputFirewallSet

Niveau requis: Exploitation
Quota: mutation, 300 appels par heure

Remplace le nom et l'intégralité des règles : ce n'est pas une fusion, les règles absentes du corps disparaissent. description absente du corps est conservée ; présente et vide, elle est effacée.

La mise à jour du pare-feu de tous les VPS où le jeu est appliqué est mise en file aussitôt (comptez quelques minutes) : modifier un jeu en usage change le pare-feu de plusieurs machines d'un coup (applied_to dit lesquelles).

Avec une clé limitée à une sélection de VPS, un jeu également appliqué à un VPS que la clé ne couvre pas ne peut être ni modifié ni supprimé (409 invalid_state) : faites-le depuis le panel, ou étendez la portée de la clé.

Paramètres du chemin

id string requis: Identifiant du jeu de règles.

motif ^\d+$ Exemple: 34

Corps de la requête

application/json

name string

max. 100 caractères

requis
description string

facultatif
rules object[]

requis
port string

Port (443) ou intervalle (8000-8100), bornes 1 à 65535

Exemple: 443

requis
protocol string

parmi : TCP, UDP

requis
subnet string

Adresses IPv4/IPv6 (CIDR accepté, sauf /0 en IPv6) séparées par des virgules ; absent, vide ou NULL : depuis n'importe où, en IPv4 comme en IPv6

Exemple: 45.54.45.54

facultatif

Exemple de requête

{
  "name": "Web public",
  "rules": [
    {
      "port": "443",
      "protocol": "TCP",
      "subnet": "45.54.45.54"
    },
    {
      "port": "8000-8100",
      "protocol": "TCP",
      "subnet": "NULL"
    }
  ]
}

Réponses

200

Jeu mis à jour

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

Champs de la réponse 10

data object

FirewallSet

requis
id string

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

Port ou intervalle début-fin

Exemple: 443
protocol string

Protocole, toujours en majuscules

parmi : TCP, UDP
sources string[]

Adresses ou plages CIDR autorisées ; vide si la règle est ouverte à tous
open_to_any boolean

true si aucune adresse ne restreint la règle
applied_to string[]

VPS (couverts par la clé) auxquels le jeu est appliqué

400

Paramètres invalides : validation_failed — nom absent ou trop long, ou règle invalide (le rang est indiqué).

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

Champs de la réponse 18

type string (uri)

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

requis
title string

Titre court

Exemple: VPS introuvable

requis
status integer (int64)

Statut HTTP

Exemple: 404

requis
code string

Code machine stable (voir « Erreurs » dans Pour commencer)

Exemple: vm_not_found

requis
detail string

Message détaillé

Exemple: Aucun VPS 999999 sur ce compte.

requis
request_id string

Identifiant de la requête, à communiquer au support

Exemple: 3f9a1c07b2e45d18

requis
errors object

validation_failed : message par paramètre fautif
required_level string

insufficient_scope : niveau exigé par l'opération

parmi : read, exploitation, full
task_id string

task_already_running : tâche en cours sur ce VPS

Exemple: tsk_000002d5
family string

rate_limited : famille de quota épuisée

parmi : read, mutation, heavy
limit integer (int64)

rate_limited : plafond horaire de la famille
retry_after integer (int64)

rate_limited : secondes à attendre
lock string

server_locked : verrou posé par l'hyperviseur (backup, snapshot, suspended…)

Exemple: snapshot
reason string

server_locked : operation_in_progress, une opération est en cours, réessayez après Retry-After ; suspended, le VPS hiberne, démarrez-le d'abord ; support_notified, verrou anormal, l'équipe LWS est prévenue et intervient

parmi : operation_in_progress, suspended, support_notified
maintenance object

server_maintenance : nature de l'intervention, début et fin prévue (null pour un incident)
kind string

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

401

Authentification refusée : invalid_token — en-tête Authorization absent ou malformé, ou clé inconnue ; access_disabled — accès API coupé pour ce compte, ou service API momentanément coupé par LWS.

en-tête Authorization absent ou malformé, ou clé inconnue

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

accès API coupé pour ce compte, ou service API momentanément coupé par 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"
}

Champs de la réponse 18

type string (uri)

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

requis
title string

Titre court

Exemple: VPS introuvable

requis
status integer (int64)

Statut HTTP

Exemple: 404

requis
code string

Code machine stable (voir « Erreurs » dans Pour commencer)

Exemple: vm_not_found

requis
detail string

Message détaillé

Exemple: Aucun VPS 999999 sur ce compte.

requis
request_id string

Identifiant de la requête, à communiquer au support

Exemple: 3f9a1c07b2e45d18

requis
errors object

validation_failed : message par paramètre fautif
required_level string

insufficient_scope : niveau exigé par l'opération

parmi : read, exploitation, full
task_id string

task_already_running : tâche en cours sur ce VPS

Exemple: tsk_000002d5
family string

rate_limited : famille de quota épuisée

parmi : read, mutation, heavy
limit integer (int64)

rate_limited : plafond horaire de la famille
retry_after integer (int64)

rate_limited : secondes à attendre
lock string

server_locked : verrou posé par l'hyperviseur (backup, snapshot, suspended…)

Exemple: snapshot
reason string

server_locked : operation_in_progress, une opération est en cours, réessayez après Retry-After ; suspended, le VPS hiberne, démarrez-le d'abord ; support_notified, verrou anormal, l'équipe LWS est prévenue et intervient

parmi : operation_in_progress, suspended, support_notified
maintenance object

server_maintenance : nature de l'intervention, début et fin prévue (null pour un incident)
kind string

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

403

Accès refusé : insufficient_scope — niveau de la clé insuffisant ; ip_not_allowed — adresse d'appel non autorisée.

niveau de la clé insuffisant

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

adresse d'appel non autorisée

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

Champs de la réponse 18

type string (uri)

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

requis
title string

Titre court

Exemple: VPS introuvable

requis
status integer (int64)

Statut HTTP

Exemple: 404

requis
code string

Code machine stable (voir « Erreurs » dans Pour commencer)

Exemple: vm_not_found

requis
detail string

Message détaillé

Exemple: Aucun VPS 999999 sur ce compte.

requis
request_id string

Identifiant de la requête, à communiquer au support

Exemple: 3f9a1c07b2e45d18

requis
errors object

validation_failed : message par paramètre fautif
required_level string

insufficient_scope : niveau exigé par l'opération

parmi : read, exploitation, full
task_id string

task_already_running : tâche en cours sur ce VPS

Exemple: tsk_000002d5
family string

rate_limited : famille de quota épuisée

parmi : read, mutation, heavy
limit integer (int64)

rate_limited : plafond horaire de la famille
retry_after integer (int64)

rate_limited : secondes à attendre
lock string

server_locked : verrou posé par l'hyperviseur (backup, snapshot, suspended…)

Exemple: snapshot
reason string

server_locked : operation_in_progress, une opération est en cours, réessayez après Retry-After ; suspended, le VPS hiberne, démarrez-le d'abord ; support_notified, verrou anormal, l'équipe LWS est prévenue et intervient

parmi : operation_in_progress, suspended, support_notified
maintenance object

server_maintenance : nature de l'intervention, début et fin prévue (null pour un incident)
kind string

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

404

Ressource introuvable : set_not_found — jeu inconnu ou appartenant à un autre compte.

{
  "type": "https://docs.lws.fr/kvm/errors/set-not-found",
  "title": "Jeu de règles introuvable",
  "status": 404,
  "code": "set_not_found",
  "detail": "Jeu de règles introuvable.",
  "request_id": "3f9a1c07b2e45d18"
}

Champs de la réponse 18

type string (uri)

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

requis
title string

Titre court

Exemple: VPS introuvable

requis
status integer (int64)

Statut HTTP

Exemple: 404

requis
code string

Code machine stable (voir « Erreurs » dans Pour commencer)

Exemple: vm_not_found

requis
detail string

Message détaillé

Exemple: Aucun VPS 999999 sur ce compte.

requis
request_id string

Identifiant de la requête, à communiquer au support

Exemple: 3f9a1c07b2e45d18

requis
errors object

validation_failed : message par paramètre fautif
required_level string

insufficient_scope : niveau exigé par l'opération

parmi : read, exploitation, full
task_id string

task_already_running : tâche en cours sur ce VPS

Exemple: tsk_000002d5
family string

rate_limited : famille de quota épuisée

parmi : read, mutation, heavy
limit integer (int64)

rate_limited : plafond horaire de la famille
retry_after integer (int64)

rate_limited : secondes à attendre
lock string

server_locked : verrou posé par l'hyperviseur (backup, snapshot, suspended…)

Exemple: snapshot
reason string

server_locked : operation_in_progress, une opération est en cours, réessayez après Retry-After ; suspended, le VPS hiberne, démarrez-le d'abord ; support_notified, verrou anormal, l'équipe LWS est prévenue et intervient

parmi : operation_in_progress, suspended, support_notified
maintenance object

server_maintenance : nature de l'intervention, début et fin prévue (null pour un incident)
kind string

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

409

Conflit avec l'état courant : invalid_state — jeu aussi appliqué à des VPS que la clé ne couvre pas.

{
  "type": "https://docs.lws.fr/kvm/errors/invalid-state",
  "title": "Opération impossible en l'état",
  "status": 409,
  "code": "invalid_state",
  "detail": "Ce jeu de règles est aussi appliqué à des VPS que cette clé ne couvre pas. Modifiez-le depuis le panel, ou étendez la portée de la clé à ces VPS.",
  "request_id": "3f9a1c07b2e45d18"
}

Champs de la réponse 18

type string (uri)

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

requis
title string

Titre court

Exemple: VPS introuvable

requis
status integer (int64)

Statut HTTP

Exemple: 404

requis
code string

Code machine stable (voir « Erreurs » dans Pour commencer)

Exemple: vm_not_found

requis
detail string

Message détaillé

Exemple: Aucun VPS 999999 sur ce compte.

requis
request_id string

Identifiant de la requête, à communiquer au support

Exemple: 3f9a1c07b2e45d18

requis
errors object

validation_failed : message par paramètre fautif
required_level string

insufficient_scope : niveau exigé par l'opération

parmi : read, exploitation, full
task_id string

task_already_running : tâche en cours sur ce VPS

Exemple: tsk_000002d5
family string

rate_limited : famille de quota épuisée

parmi : read, mutation, heavy
limit integer (int64)

rate_limited : plafond horaire de la famille
retry_after integer (int64)

rate_limited : secondes à attendre
lock string

server_locked : verrou posé par l'hyperviseur (backup, snapshot, suspended…)

Exemple: snapshot
reason string

server_locked : operation_in_progress, une opération est en cours, réessayez après Retry-After ; suspended, le VPS hiberne, démarrez-le d'abord ; support_notified, verrou anormal, l'équipe LWS est prévenue et intervient

parmi : operation_in_progress, suspended, support_notified
maintenance object

server_maintenance : nature de l'intervention, début et fin prévue (null pour un incident)
kind string

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

429

Quota dépassé : rate_limited — quota horaire de la famille épuisé.

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

Champs de la réponse 18

type string (uri)

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

requis
title string

Titre court

Exemple: VPS introuvable

requis
status integer (int64)

Statut HTTP

Exemple: 404

requis
code string

Code machine stable (voir « Erreurs » dans Pour commencer)

Exemple: vm_not_found

requis
detail string

Message détaillé

Exemple: Aucun VPS 999999 sur ce compte.

requis
request_id string

Identifiant de la requête, à communiquer au support

Exemple: 3f9a1c07b2e45d18

requis
errors object

validation_failed : message par paramètre fautif
required_level string

insufficient_scope : niveau exigé par l'opération

parmi : read, exploitation, full
task_id string

task_already_running : tâche en cours sur ce VPS

Exemple: tsk_000002d5
family string

rate_limited : famille de quota épuisée

parmi : read, mutation, heavy
limit integer (int64)

rate_limited : plafond horaire de la famille
retry_after integer (int64)

rate_limited : secondes à attendre
lock string

server_locked : verrou posé par l'hyperviseur (backup, snapshot, suspended…)

Exemple: snapshot
reason string

server_locked : operation_in_progress, une opération est en cours, réessayez après Retry-After ; suspended, le VPS hiberne, démarrez-le d'abord ; support_notified, verrou anormal, l'équipe LWS est prévenue et intervient

parmi : operation_in_progress, suspended, support_notified
maintenance object

server_maintenance : nature de l'intervention, début et fin prévue (null pour un incident)
kind string

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

502

Dépendance injoignable : upstream_unavailable — enregistrement impossible.

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

Champs de la réponse 18

type string (uri)

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

requis
title string

Titre court

Exemple: VPS introuvable

requis
status integer (int64)

Statut HTTP

Exemple: 404

requis
code string

Code machine stable (voir « Erreurs » dans Pour commencer)

Exemple: vm_not_found

requis
detail string

Message détaillé

Exemple: Aucun VPS 999999 sur ce compte.

requis
request_id string

Identifiant de la requête, à communiquer au support

Exemple: 3f9a1c07b2e45d18

requis
errors object

validation_failed : message par paramètre fautif
required_level string

insufficient_scope : niveau exigé par l'opération

parmi : read, exploitation, full
task_id string

task_already_running : tâche en cours sur ce VPS

Exemple: tsk_000002d5
family string

rate_limited : famille de quota épuisée

parmi : read, mutation, heavy
limit integer (int64)

rate_limited : plafond horaire de la famille
retry_after integer (int64)

rate_limited : secondes à attendre
lock string

server_locked : verrou posé par l'hyperviseur (backup, snapshot, suspended…)

Exemple: snapshot
reason string

server_locked : operation_in_progress, une opération est en cours, réessayez après Retry-After ; suspended, le VPS hiberne, démarrez-le d'abord ; support_notified, verrou anormal, l'équipe LWS est prévenue et intervient

parmi : operation_in_progress, suspended, support_notified
maintenance object

server_maintenance : nature de l'intervention, début et fin prévue (null pour un incident)
kind string

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

Modifier un jeu de règles

Paramètres du chemin

Corps de la requête

Réponses

Signaler une erreur

Assistant IA