Firewall aktivieren oder deaktivieren
Verzögert Asynchron · 202
PUT
/api/v1/
operationIdputServerFirewall
- Erforderliche Stufe
- Betrieb zum Aktivieren, Vollständig zum Deaktivieren
- Kontingent
- Mutation, 300 Aufrufe pro Stunde
Aktiviert oder deaktiviert die Filterung auf dem VPS und aktualisiert anschließend seine Regeln.
Die Aktivierung betrifft die Regeln der auf den VPS angewendeten Regelsätze: Sobald die Firewall aktiv ist, wird jeder eingehende Verkehr, den keiner von ihnen erlaubt, blockiert, sowohl über IPv4 als auch über IPv6. Ohne angewendeten Regelsatz hat sie keine Wirkung, und enabled bleibt false: Wenden Sie zuerst einen Regelsatz an (POST /servers/{vmid}/firewall/sets/{id}).
Die geforderte Stufe hängt von der Richtung der Änderung ab: Aktivieren (enabled: true) schützt, ein Schlüssel der Stufe Betrieb genügt; Deaktivieren (enabled: false) exponiert die Maschine, dafür ist ein Schlüssel der Stufe Vollständig nötig.
Das Array tasks kann leer sein, wenn die Synchronisierungsaufgabe zum Zeitpunkt der Antwort noch nicht sichtbar ist: Der Zustand lässt sich dann über GET /servers/{vmid}/firewall erneut abrufen.
Diese Anfrage wird im Hintergrund verarbeitet: Sie antwortet sofort, während die Arbeit weiterläuft. Verfolgen Sie sie über die Task- oder Request-Endpunkte.
Pfadparameter
-
vmidstring erforderlich -
Bezeichner des VPS. Er muss zum Konto und zum Umfang des Schlüssels gehören.
Anfrage-Body
application/json
-
enabledbooleanerforderlichtrue: Filterung aktivieren;false: sie deaktivieren
Beispielanfrage
{
"enabled": true
}
Antworten
202
Anfrage angenommen und in die Warteschlange gestellt. Verfolgen Sie die zurückgegebene Aufgabe mit GET /tasks/{id}.
GET /tasks/{id}.Die Anfrage wurde angenommen, nicht ausgeführt. Die Antwort enthält eine zu verfolgende Aufgabe.
{
"data": {
"tasks": [
{
"id": "tsk_000002e1",
"status": "pending",
"action": "firewall.sync",
"vmid": "116807",
"description": "Mise à jour des règles Firewall pour la VM : 116807",
"created_at": "2026-08-20T14:31:02+02:00",
"finished_at": null
}
]
}
}
Felder der Antwort 9
-
dataobject -
tasksobject[]Erstellte Aufgaben; immer ein Array
-
idstringOpaker Bezeichner
-
statusstringunknownwürde einen Zustand anzeigen, den die API nicht benennen kann -
actionstringArt der Aufgabe
-
vmidstring -
descriptionstring -
created_atstring (date-time) -
finished_atstring (date-time)null, solange die Aufgabe läuft
400
Ungültige Parameter: validation_failed — enabled fehlt oder ist kein boolescher Wert.
validation_failed — enabled fehlt oder ist kein boolescher Wert.{
"type": "https://docs.lws.fr/kvm/errors/validation-failed",
"title": "Paramètres invalides",
"status": 400,
"code": "validation_failed",
"detail": "Paramètre « enabled » invalide.",
"request_id": "3f9a1c07b2e45d18",
"errors": {
"enabled": "Booléen attendu : true pour activer le pare-feu, false pour le désactiver."
}
}
Felder der Antwort 18
-
typestring (uri)erforderlich -
titlestringerforderlichKurztitel
-
statusinteger (int64)erforderlichHTTP-Status
-
codestringerforderlichStabiler Maschinencode (siehe „Fehler“ in Erste Schritte)
-
detailstringerforderlichAusführliche Meldung
-
request_idstringerforderlichBezeichner der Anfrage, an den Support weiterzugeben
-
errorsobjectvalidation_failed: Meldung je fehlerhaftem Parameter -
required_levelstringinsufficient_scope: vom Vorgang geforderte Stufe -
task_idstringtask_already_running: laufende Aufgabe auf diesem VPS -
familystringrate_limited: ausgeschöpfte Kontingentgruppe -
limitinteger (int64)rate_limited: stündliche Obergrenze der Gruppe -
retry_afterinteger (int64)rate_limited: Sekunden bis zum nächsten Versuch -
lockstringserver_locked: vom Hypervisor gesetzte Sperre (backup,snapshot,suspended…) -
reasonstringserver_locked:operation_in_progress– ein Vorgang läuft, versuchen Sie es nachRetry-Aftererneut;suspended– der VPS befindet sich im Ruhezustand, starten Sie ihn zuerst;support_notified– ungewöhnliche Sperre, das LWS-Team ist informiert und kümmert sich darum -
maintenanceobjectserver_maintenance: Art des Eingriffs, Beginn und voraussichtliches Ende (nullbei einem Vorfall) -
kindstring -
started_atstring (date-time) -
expected_endstring (date-time)
401
Authentifizierung abgelehnt: invalid_token — Header Authorization fehlt oder ist fehlerhaft, oder Schlüssel unbekannt; access_disabled — API-Zugang für dieses Konto gesperrt, oder API-Dienst vorübergehend von LWS abgeschaltet.
invalid_token — Header Authorization fehlt oder ist fehlerhaft, oder Schlüssel unbekannt; access_disabled — API-Zugang für dieses Konto gesperrt, oder API-Dienst vorübergehend von LWS abgeschaltet.Header Authorization fehlt oder ist fehlerhaft, oder Schlüssel unbekannt
{
"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"
}
API-Zugang für dieses Konto gesperrt, oder API-Dienst vorübergehend von LWS abgeschaltet
{
"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"
}
Felder der Antwort 18
-
typestring (uri)erforderlich -
titlestringerforderlichKurztitel
-
statusinteger (int64)erforderlichHTTP-Status
-
codestringerforderlichStabiler Maschinencode (siehe „Fehler“ in Erste Schritte)
-
detailstringerforderlichAusführliche Meldung
-
request_idstringerforderlichBezeichner der Anfrage, an den Support weiterzugeben
-
errorsobjectvalidation_failed: Meldung je fehlerhaftem Parameter -
required_levelstringinsufficient_scope: vom Vorgang geforderte Stufe -
task_idstringtask_already_running: laufende Aufgabe auf diesem VPS -
familystringrate_limited: ausgeschöpfte Kontingentgruppe -
limitinteger (int64)rate_limited: stündliche Obergrenze der Gruppe -
retry_afterinteger (int64)rate_limited: Sekunden bis zum nächsten Versuch -
lockstringserver_locked: vom Hypervisor gesetzte Sperre (backup,snapshot,suspended…) -
reasonstringserver_locked:operation_in_progress– ein Vorgang läuft, versuchen Sie es nachRetry-Aftererneut;suspended– der VPS befindet sich im Ruhezustand, starten Sie ihn zuerst;support_notified– ungewöhnliche Sperre, das LWS-Team ist informiert und kümmert sich darum -
maintenanceobjectserver_maintenance: Art des Eingriffs, Beginn und voraussichtliches Ende (nullbei einem Vorfall) -
kindstring -
started_atstring (date-time) -
expected_endstring (date-time)
403
Zugriff verweigert: insufficient_scope — Stufe des Schlüssels unzureichend; ip_not_allowed — aufrufende Adresse nicht zugelassen.
insufficient_scope — Stufe des Schlüssels unzureichend; ip_not_allowed — aufrufende Adresse nicht zugelassen.Stufe des Schlüssels unzureichend
{
"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"
}
aufrufende Adresse nicht zugelassen
{
"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"
}
Felder der Antwort 18
-
typestring (uri)erforderlich -
titlestringerforderlichKurztitel
-
statusinteger (int64)erforderlichHTTP-Status
-
codestringerforderlichStabiler Maschinencode (siehe „Fehler“ in Erste Schritte)
-
detailstringerforderlichAusführliche Meldung
-
request_idstringerforderlichBezeichner der Anfrage, an den Support weiterzugeben
-
errorsobjectvalidation_failed: Meldung je fehlerhaftem Parameter -
required_levelstringinsufficient_scope: vom Vorgang geforderte Stufe -
task_idstringtask_already_running: laufende Aufgabe auf diesem VPS -
familystringrate_limited: ausgeschöpfte Kontingentgruppe -
limitinteger (int64)rate_limited: stündliche Obergrenze der Gruppe -
retry_afterinteger (int64)rate_limited: Sekunden bis zum nächsten Versuch -
lockstringserver_locked: vom Hypervisor gesetzte Sperre (backup,snapshot,suspended…) -
reasonstringserver_locked:operation_in_progress– ein Vorgang läuft, versuchen Sie es nachRetry-Aftererneut;suspended– der VPS befindet sich im Ruhezustand, starten Sie ihn zuerst;support_notified– ungewöhnliche Sperre, das LWS-Team ist informiert und kümmert sich darum -
maintenanceobjectserver_maintenance: Art des Eingriffs, Beginn und voraussichtliches Ende (nullbei einem Vorfall) -
kindstring -
started_atstring (date-time) -
expected_endstring (date-time)
404
Ressource nicht gefunden: vm_not_found — VPS existiert nicht oder liegt außerhalb des Umfangs des Schlüssels.
vm_not_found — VPS existiert nicht oder liegt außerhalb des Umfangs des Schlüssels.{
"type": "https://docs.lws.fr/kvm/errors/vm-not-found",
"title": "VPS introuvable",
"status": 404,
"code": "vm_not_found",
"detail": "Aucun VPS 999999 sur ce compte.",
"request_id": "3f9a1c07b2e45d18"
}
Felder der Antwort 18
-
typestring (uri)erforderlich -
titlestringerforderlichKurztitel
-
statusinteger (int64)erforderlichHTTP-Status
-
codestringerforderlichStabiler Maschinencode (siehe „Fehler“ in Erste Schritte)
-
detailstringerforderlichAusführliche Meldung
-
request_idstringerforderlichBezeichner der Anfrage, an den Support weiterzugeben
-
errorsobjectvalidation_failed: Meldung je fehlerhaftem Parameter -
required_levelstringinsufficient_scope: vom Vorgang geforderte Stufe -
task_idstringtask_already_running: laufende Aufgabe auf diesem VPS -
familystringrate_limited: ausgeschöpfte Kontingentgruppe -
limitinteger (int64)rate_limited: stündliche Obergrenze der Gruppe -
retry_afterinteger (int64)rate_limited: Sekunden bis zum nächsten Versuch -
lockstringserver_locked: vom Hypervisor gesetzte Sperre (backup,snapshot,suspended…) -
reasonstringserver_locked:operation_in_progress– ein Vorgang läuft, versuchen Sie es nachRetry-Aftererneut;suspended– der VPS befindet sich im Ruhezustand, starten Sie ihn zuerst;support_notified– ungewöhnliche Sperre, das LWS-Team ist informiert und kümmert sich darum -
maintenanceobjectserver_maintenance: Art des Eingriffs, Beginn und voraussichtliches Ende (nullbei einem Vorfall) -
kindstring -
started_atstring (date-time) -
expected_endstring (date-time)
409
Konflikt mit dem aktuellen Zustand: task_already_running — eine Firewall-Synchronisierung oder eine Neuinstallation läuft bereits; service_suspended — VPS deaktiviert oder abgelaufen: Nur Lesevorgänge bleiben möglich.
task_already_running — eine Firewall-Synchronisierung oder eine Neuinstallation läuft bereits; service_suspended — VPS deaktiviert oder abgelaufen: Nur Lesevorgänge bleiben möglich.eine Firewall-Synchronisierung oder eine Neuinstallation läuft bereits
{
"type": "https://docs.lws.fr/kvm/errors/task-already-running",
"title": "Opération déjà en cours",
"status": 409,
"code": "task_already_running",
"detail": "Une synchronisation du pare-feu est déjà en cours sur ce VPS. Attendez qu'elle aboutisse.",
"request_id": "3f9a1c07b2e45d18",
"task_id": "tsk_000002d5"
}
VPS deaktiviert oder abgelaufen: Nur Lesevorgänge bleiben möglich
{
"type": "https://docs.lws.fr/kvm/errors/service-suspended",
"title": "Service suspendu",
"status": 409,
"code": "service_suspended",
"detail": "Le VPS 116807 est expiré.",
"request_id": "3f9a1c07b2e45d18"
}
Felder der Antwort 18
-
typestring (uri)erforderlich -
titlestringerforderlichKurztitel
-
statusinteger (int64)erforderlichHTTP-Status
-
codestringerforderlichStabiler Maschinencode (siehe „Fehler“ in Erste Schritte)
-
detailstringerforderlichAusführliche Meldung
-
request_idstringerforderlichBezeichner der Anfrage, an den Support weiterzugeben
-
errorsobjectvalidation_failed: Meldung je fehlerhaftem Parameter -
required_levelstringinsufficient_scope: vom Vorgang geforderte Stufe -
task_idstringtask_already_running: laufende Aufgabe auf diesem VPS -
familystringrate_limited: ausgeschöpfte Kontingentgruppe -
limitinteger (int64)rate_limited: stündliche Obergrenze der Gruppe -
retry_afterinteger (int64)rate_limited: Sekunden bis zum nächsten Versuch -
lockstringserver_locked: vom Hypervisor gesetzte Sperre (backup,snapshot,suspended…) -
reasonstringserver_locked:operation_in_progress– ein Vorgang läuft, versuchen Sie es nachRetry-Aftererneut;suspended– der VPS befindet sich im Ruhezustand, starten Sie ihn zuerst;support_notified– ungewöhnliche Sperre, das LWS-Team ist informiert und kümmert sich darum -
maintenanceobjectserver_maintenance: Art des Eingriffs, Beginn und voraussichtliches Ende (nullbei einem Vorfall) -
kindstring -
started_atstring (date-time) -
expected_endstring (date-time)
429
Kontingent überschritten: rate_limited — stündliches Kontingent der Gruppe ausgeschöpft.
rate_limited — stündliches Kontingent der Gruppe ausgeschöpft.{
"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
}
Felder der Antwort 18
-
typestring (uri)erforderlich -
titlestringerforderlichKurztitel
-
statusinteger (int64)erforderlichHTTP-Status
-
codestringerforderlichStabiler Maschinencode (siehe „Fehler“ in Erste Schritte)
-
detailstringerforderlichAusführliche Meldung
-
request_idstringerforderlichBezeichner der Anfrage, an den Support weiterzugeben
-
errorsobjectvalidation_failed: Meldung je fehlerhaftem Parameter -
required_levelstringinsufficient_scope: vom Vorgang geforderte Stufe -
task_idstringtask_already_running: laufende Aufgabe auf diesem VPS -
familystringrate_limited: ausgeschöpfte Kontingentgruppe -
limitinteger (int64)rate_limited: stündliche Obergrenze der Gruppe -
retry_afterinteger (int64)rate_limited: Sekunden bis zum nächsten Versuch -
lockstringserver_locked: vom Hypervisor gesetzte Sperre (backup,snapshot,suspended…) -
reasonstringserver_locked:operation_in_progress– ein Vorgang läuft, versuchen Sie es nachRetry-Aftererneut;suspended– der VPS befindet sich im Ruhezustand, starten Sie ihn zuerst;support_notified– ungewöhnliche Sperre, das LWS-Team ist informiert und kümmert sich darum -
maintenanceobjectserver_maintenance: Art des Eingriffs, Beginn und voraussichtliches Ende (nullbei einem Vorfall) -
kindstring -
started_atstring (date-time) -
expected_endstring (date-time)
502
Abhängigkeit nicht erreichbar: hypervisor_unreachable — Datenbank des Hypervisors antwortet nicht, nichts wurde geändert; upstream_unavailable — VPS-Inventar vorübergehend nicht verfügbar.
hypervisor_unreachable — Datenbank des Hypervisors antwortet nicht, nichts wurde geändert; upstream_unavailable — VPS-Inventar vorübergehend nicht verfügbar.Datenbank des Hypervisors antwortet nicht, nichts wurde geändert
{
"type": "https://docs.lws.fr/kvm/errors/hypervisor-unreachable",
"title": "Hyperviseur injoignable",
"status": 502,
"code": "hypervisor_unreachable",
"detail": "La base de l'hyperviseur n'a pas répondu, le pare-feu n'a pas été modifié.",
"request_id": "3f9a1c07b2e45d18"
}
VPS-Inventar vorübergehend nicht verfügbar
{
"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"
}
Felder der Antwort 18
-
typestring (uri)erforderlich -
titlestringerforderlichKurztitel
-
statusinteger (int64)erforderlichHTTP-Status
-
codestringerforderlichStabiler Maschinencode (siehe „Fehler“ in Erste Schritte)
-
detailstringerforderlichAusführliche Meldung
-
request_idstringerforderlichBezeichner der Anfrage, an den Support weiterzugeben
-
errorsobjectvalidation_failed: Meldung je fehlerhaftem Parameter -
required_levelstringinsufficient_scope: vom Vorgang geforderte Stufe -
task_idstringtask_already_running: laufende Aufgabe auf diesem VPS -
familystringrate_limited: ausgeschöpfte Kontingentgruppe -
limitinteger (int64)rate_limited: stündliche Obergrenze der Gruppe -
retry_afterinteger (int64)rate_limited: Sekunden bis zum nächsten Versuch -
lockstringserver_locked: vom Hypervisor gesetzte Sperre (backup,snapshot,suspended…) -
reasonstringserver_locked:operation_in_progress– ein Vorgang läuft, versuchen Sie es nachRetry-Aftererneut;suspended– der VPS befindet sich im Ruhezustand, starten Sie ihn zuerst;support_notified– ungewöhnliche Sperre, das LWS-Team ist informiert und kümmert sich darum -
maintenanceobjectserver_maintenance: Art des Eingriffs, Beginn und voraussichtliches Ende (nullbei einem Vorfall) -
kindstring -
started_atstring (date-time) -
expected_endstring (date-time)
503
Hostserver im Wartungseingriff: server_maintenance — Hostserver in einem von LWS angekündigten Eingriff und nicht erreichbar; beachten Sie Retry-After.
server_maintenance — Hostserver in einem von LWS angekündigten Eingriff und nicht erreichbar; beachten Sie Retry-After.{
"type": "https://docs.lws.fr/kvm/errors/server-maintenance",
"title": "Intervention en cours sur le serveur hôte",
"status": 503,
"code": "server_maintenance",
"detail": "Le serveur hébergeant ce VPS fait l'objet d'une intervention programmée par LWS : il est momentanément inaccessible. Fin prévue : 2026-10-21T18:00:00+02:00.",
"request_id": "3f9a1c07b2e45d18",
"maintenance": {
"kind": "works",
"started_at": "2026-10-21T14:00:00+02:00",
"expected_end": "2026-10-21T18:00:00+02:00"
}
}
Felder der Antwort 18
-
typestring (uri)erforderlich -
titlestringerforderlichKurztitel
-
statusinteger (int64)erforderlichHTTP-Status
-
codestringerforderlichStabiler Maschinencode (siehe „Fehler“ in Erste Schritte)
-
detailstringerforderlichAusführliche Meldung
-
request_idstringerforderlichBezeichner der Anfrage, an den Support weiterzugeben
-
errorsobjectvalidation_failed: Meldung je fehlerhaftem Parameter -
required_levelstringinsufficient_scope: vom Vorgang geforderte Stufe -
task_idstringtask_already_running: laufende Aufgabe auf diesem VPS -
familystringrate_limited: ausgeschöpfte Kontingentgruppe -
limitinteger (int64)rate_limited: stündliche Obergrenze der Gruppe -
retry_afterinteger (int64)rate_limited: Sekunden bis zum nächsten Versuch -
lockstringserver_locked: vom Hypervisor gesetzte Sperre (backup,snapshot,suspended…) -
reasonstringserver_locked:operation_in_progress– ein Vorgang läuft, versuchen Sie es nachRetry-Aftererneut;suspended– der VPS befindet sich im Ruhezustand, starten Sie ihn zuerst;support_notified– ungewöhnliche Sperre, das LWS-Team ist informiert und kümmert sich darum -
maintenanceobjectserver_maintenance: Art des Eingriffs, Beginn und voraussichtliches Ende (nullbei einem Vorfall) -
kindstring -
started_atstring (date-time) -
expected_endstring (date-time)