Verfügbare Systeme auflisten

GET /api/v1/catalog/os-templates

operationIdgetOsTemplates

Erforderliche Stufe: Nur Lesen
Kontingent: Lesen, 3.600 Aufrufe pro Stunde

Für eine Neuinstallation verwendbare Systemvorlagen: category: ssh (Basissysteme) und category: app (vorinstallierte Anwendung). Nicht paginierte Liste.

Das Paar os / variant ist genau das, was POST /servers/{vmid}/rebuild erwartet. min_memory_gb ist in Gigabyte angegeben (0: kein Minimum) und ermöglicht es, vor einer Neuinstallation zu prüfen, ob ein VPS geeignet ist.

Antworten

200

Katalog

{
  "data": [
    {
      "os": "almalinux-10",
      "variant": "default",
      "distribution": "almalinux",
      "version": "10",
      "commercial_name": "AlmaLinux 10",
      "category": "ssh",
      "min_memory_gb": 0,
      "managed": false
    },
    {
      "os": "debian-12",
      "variant": "forgejo",
      "distribution": "debian",
      "version": "12",
      "commercial_name": "Forgejo",
      "category": "app",
      "min_memory_gb": 2,
      "managed": false
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 41,
    "total": 41,
    "total_pages": 1
  }
}

Felder der Antwort 14

data object[]

erforderlich
os string

Bei der Neuinstallation zu übergeben

Beispiel: debian-12
variant string

Bei der Neuinstallation zu übergeben

Beispiel: default
distribution string
version string
commercial_name string
category string

ssh: Basissystem; app: vorinstallierte Anwendung
min_memory_gb integer (int64)

Mindestarbeitsspeicher, in GB; 0: kein Minimum
managed boolean

Verwaltetes Template
meta object

Paginierung. Nicht paginierte Listen geben alles zurück, und meta gibt die zurückgegebene Anzahl wieder.

PaginationMeta

erforderlich
page integer (int64)

Zurückgegebene Seite

Beispiel: 1
per_page integer (int64)

Seitengröße

Beispiel: 25
total integer (int64)

Gesamtzahl der Elemente

Beispiel: 887
total_pages integer (int64)

Gesamtzahl der Seiten

Beispiel: 36

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.

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

type string (uri)

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

erforderlich
title string

Kurztitel

Beispiel: VPS introuvable

erforderlich
status integer (int64)

HTTP-Status

Beispiel: 404

erforderlich
code string

Stabiler Maschinencode (siehe „Fehler“ in Erste Schritte)

Beispiel: vm_not_found

erforderlich
detail string

Ausführliche Meldung

Beispiel: Aucun VPS 999999 sur ce compte.

erforderlich
request_id string

Bezeichner der Anfrage, an den Support weiterzugeben

Beispiel: 3f9a1c07b2e45d18

erforderlich
errors object

validation_failed: Meldung je fehlerhaftem Parameter
required_level string

insufficient_scope: vom Vorgang geforderte Stufe

eines von: read, exploitation, full
task_id string

task_already_running: laufende Aufgabe auf diesem VPS

Beispiel: tsk_000002d5
family string

rate_limited: ausgeschöpfte Kontingentgruppe

eines von: read, mutation, heavy
limit integer (int64)

rate_limited: stündliche Obergrenze der Gruppe
retry_after integer (int64)

rate_limited: Sekunden bis zum nächsten Versuch
lock string

server_locked: vom Hypervisor gesetzte Sperre (backup, snapshot, suspended …)

Beispiel: snapshot
reason string

server_locked: operation_in_progress – ein Vorgang läuft, versuchen Sie es nach Retry-After erneut; 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

eines von: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: Art des Eingriffs, Beginn und voraussichtliches Ende (null bei einem Vorfall)
kind string

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

403

Zugriff verweigert: ip_not_allowed — 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

type string (uri)

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

erforderlich
title string

Kurztitel

Beispiel: VPS introuvable

erforderlich
status integer (int64)

HTTP-Status

Beispiel: 404

erforderlich
code string

Stabiler Maschinencode (siehe „Fehler“ in Erste Schritte)

Beispiel: vm_not_found

erforderlich
detail string

Ausführliche Meldung

Beispiel: Aucun VPS 999999 sur ce compte.

erforderlich
request_id string

Bezeichner der Anfrage, an den Support weiterzugeben

Beispiel: 3f9a1c07b2e45d18

erforderlich
errors object

validation_failed: Meldung je fehlerhaftem Parameter
required_level string

insufficient_scope: vom Vorgang geforderte Stufe

eines von: read, exploitation, full
task_id string

task_already_running: laufende Aufgabe auf diesem VPS

Beispiel: tsk_000002d5
family string

rate_limited: ausgeschöpfte Kontingentgruppe

eines von: read, mutation, heavy
limit integer (int64)

rate_limited: stündliche Obergrenze der Gruppe
retry_after integer (int64)

rate_limited: Sekunden bis zum nächsten Versuch
lock string

server_locked: vom Hypervisor gesetzte Sperre (backup, snapshot, suspended …)

Beispiel: snapshot
reason string

server_locked: operation_in_progress – ein Vorgang läuft, versuchen Sie es nach Retry-After erneut; 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

eines von: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: Art des Eingriffs, Beginn und voraussichtliches Ende (null bei einem Vorfall)
kind string

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

429

Kontingent überschritten: 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 « read » : 3600 appels par heure. Réessayez dans 37 seconde(s).",
  "request_id": "3f9a1c07b2e45d18",
  "family": "read",
  "limit": 3600,
  "retry_after": 37
}

Felder der Antwort 18

type string (uri)

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

erforderlich
title string

Kurztitel

Beispiel: VPS introuvable

erforderlich
status integer (int64)

HTTP-Status

Beispiel: 404

erforderlich
code string

Stabiler Maschinencode (siehe „Fehler“ in Erste Schritte)

Beispiel: vm_not_found

erforderlich
detail string

Ausführliche Meldung

Beispiel: Aucun VPS 999999 sur ce compte.

erforderlich
request_id string

Bezeichner der Anfrage, an den Support weiterzugeben

Beispiel: 3f9a1c07b2e45d18

erforderlich
errors object

validation_failed: Meldung je fehlerhaftem Parameter
required_level string

insufficient_scope: vom Vorgang geforderte Stufe

eines von: read, exploitation, full
task_id string

task_already_running: laufende Aufgabe auf diesem VPS

Beispiel: tsk_000002d5
family string

rate_limited: ausgeschöpfte Kontingentgruppe

eines von: read, mutation, heavy
limit integer (int64)

rate_limited: stündliche Obergrenze der Gruppe
retry_after integer (int64)

rate_limited: Sekunden bis zum nächsten Versuch
lock string

server_locked: vom Hypervisor gesetzte Sperre (backup, snapshot, suspended …)

Beispiel: snapshot
reason string

server_locked: operation_in_progress – ein Vorgang läuft, versuchen Sie es nach Retry-After erneut; 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

eines von: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: Art des Eingriffs, Beginn und voraussichtliches Ende (null bei einem Vorfall)
kind string

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

502

Abhängigkeit nicht erreichbar: upstream_unavailable — Katalog 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": "Le catalogue des systèmes n'a pas pu être obtenu. Réessayez dans quelques instants.",
  "request_id": "3f9a1c07b2e45d18"
}

Felder der Antwort 18

type string (uri)

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

erforderlich
title string

Kurztitel

Beispiel: VPS introuvable

erforderlich
status integer (int64)

HTTP-Status

Beispiel: 404

erforderlich
code string

Stabiler Maschinencode (siehe „Fehler“ in Erste Schritte)

Beispiel: vm_not_found

erforderlich
detail string

Ausführliche Meldung

Beispiel: Aucun VPS 999999 sur ce compte.

erforderlich
request_id string

Bezeichner der Anfrage, an den Support weiterzugeben

Beispiel: 3f9a1c07b2e45d18

erforderlich
errors object

validation_failed: Meldung je fehlerhaftem Parameter
required_level string

insufficient_scope: vom Vorgang geforderte Stufe

eines von: read, exploitation, full
task_id string

task_already_running: laufende Aufgabe auf diesem VPS

Beispiel: tsk_000002d5
family string

rate_limited: ausgeschöpfte Kontingentgruppe

eines von: read, mutation, heavy
limit integer (int64)

rate_limited: stündliche Obergrenze der Gruppe
retry_after integer (int64)

rate_limited: Sekunden bis zum nächsten Versuch
lock string

server_locked: vom Hypervisor gesetzte Sperre (backup, snapshot, suspended …)

Beispiel: snapshot
reason string

server_locked: operation_in_progress – ein Vorgang läuft, versuchen Sie es nach Retry-After erneut; 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

eines von: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: Art des Eingriffs, Beginn und voraussichtliches Ende (null bei einem Vorfall)
kind string

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

Verfügbare Systeme auflisten

Antworten

Fehler melden

KI-Assistent