Lister les systèmes disponibles

GET /api/v1/catalog/os-templates

operationIdgetOsTemplates

Niveau requis: Lecture seule
Quota: lecture, 3 600 appels par heure

Modèles de système utilisables pour une réinstallation : category: ssh (systèmes nus) et category: app (application préinstallée). Liste non paginée.

Le couple os / variant est exactement ce qu'attend POST /servers/{vmid}/rebuild. min_memory_gb est en gigaoctets (0 : aucun minimum) et permet de vérifier qu'un VPS est éligible avant de réinstaller.

Réponses

200

Catalogue

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

Champs de la réponse 14

data object[]

requis
os string

À passer à la réinstallation

Exemple: debian-12
variant string

À passer à la réinstallation

Exemple: default
distribution string
version string
commercial_name string
category string

ssh : système nu ; app : application préinstallée
min_memory_gb integer (int64)

Mémoire minimale, en Go ; 0 : aucun minimum
managed boolean

Template infogéré
meta object

Pagination. Les listes non paginées renvoient tout et meta reflète le nombre renvoyé.

PaginationMeta

requis
page integer (int64)

Page renvoyée

Exemple: 1
per_page integer (int64)

Taille de page

Exemple: 25
total integer (int64)

Nombre total d'éléments

Exemple: 887
total_pages integer (int64)

Nombre total de pages

Exemple: 36

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é : ip_not_allowed — 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)

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

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 — catalogue momentanément indisponible.

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

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)

Lister les systèmes disponibles

Réponses

Signaler une erreur

Assistant IA