Elencare i sistemi disponibili

GET /api/v1/catalog/os-templates

operationIdgetOsTemplates

Livello richiesto: Sola lettura
Quota: lettura, 3.600 chiamate all'ora

Modelli di sistema utilizzabili per una reinstallazione: category: ssh (sistemi di base) e category: app (applicazione preinstallata). Elenco non paginato.

La coppia os / variant è esattamente ciò che si aspetta POST /servers/{vmid}/rebuild. min_memory_gb è in gigabyte (0: nessun minimo) e consente di verificare che un VPS sia idoneo prima di reinstallarlo.

Responses

200

Catalogo

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

Response fields 14

data object[]

required
os string

Da passare alla reinstallazione

Example: debian-12
variant string

Da passare alla reinstallazione

Example: default
distribution string
version string
commercial_name string
category string

ssh: sistema di base; app: applicazione preinstallata
min_memory_gb integer (int64)

Memoria minima, in GB; 0: nessun minimo
managed boolean

Template gestito
meta object

Paginazione. Gli elenchi non paginati restituiscono tutto e meta riflette il numero restituito.

PaginationMeta

required
page integer (int64)

Pagina restituita

Example: 1
per_page integer (int64)

Dimensione della pagina

Example: 25
total integer (int64)

Numero totale di elementi

Example: 887
total_pages integer (int64)

Numero totale di pagine

Example: 36

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

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 — catalogo momentaneamente non disponibile.

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

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)

Elencare i sistemi disponibili

Responses

Report an error

AI assistant