Documentación de la API El alojamiento web accesible para todos
ES

Idioma

Français English Deutsch Español Português Italiano
Visitar LWS
API VPS KVM

Documentación

API Dominios y Correo API VPS KVM
Inicio de la documentación

Listar los VPS

GET /api/v1/servers

operationIdgetServers

Nivel requerido
Solo lectura
Cuota
lectura, 3600 llamadas por hora

Inventario de los VPS cubiertos por la clave. El estado de alimentación se lee en el hipervisor; si este está momentáneamente inaccesible, status vale unavailable y el resto de la ficha sigue siendo utilizable.

Durante una intervención anunciada por LWS en el servidor anfitrión (actualización, reinicio…), maintenance indica su naturaleza y sus horarios, tanto si está programada como en curso. Si el servidor anfitrión deja de responder durante esa intervención, status vale maintenance: una indisponibilidad prevista y pasajera, no una avería.

El filtro status se aplica a la página solicitada: meta describe el inventario completo, sin filtrar, por lo que una página filtrada puede contener menos entradas que per_page.

El estado leído en el hipervisor se almacena en caché durante 15 segundos: una llamada más seguida devuelve el mismo valor. Cualquier escritura realizada a través de la API en un VPS actualiza su estado de inmediato.

Parámetros de consulta

page integer opcional

Página solicitada. Un valor inferior a 1 se convierte en 1.

como mínimo 1

per_page integer opcional

Tamaño de página. Un valor superior a 100 se convierte en 100; un valor nulo, negativo o no numérico, en 25.

como máximo 100 como mínimo 1

status string opcional

Conservar solo los VPS en este estado (se aplica a la página devuelta).

uno de: running, stopped, unavailable, maintenance

Respuestas

200

Una página del inventario

 
{
  "data": [
    {
      "vmid": "116807",
      "name": "vps116807",
      "node": "shp-40",
      "status": "running",
      "maintenance": null,
      "os_template": "debian12_64",
      "commercial_name": "Debian 12",
      "ipv4": "31.207.34.214",
      "ipv6": "2a00:7ee0:9:1:11:6807:1:1",
      "additional_ips": [
        "51.83.12.98"
      ],
      "datacenter": {
        "code": "SJ1",
        "city": "Nancy",
        "country": "France",
        "zone": "eu-france-est"
      },
      "purchased_at": "2025-03-14T00:00:00+01:00",
      "expires_at": "2027-03-14T00:00:00+01:00",
      "enabled": true,
      "expired": false,
      "comment": null
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 1,
    "total_pages": 1
  }
}
Campos de la respuesta 30
  • data object[]
    obligatorio
  • vmid string

    Identificador del VPS

    Ejemplo: 116807

  • name string

    Nombre de la máquina en el hipervisor

  • node string

    Hipervisor que aloja el VPS, a título informativo. Nunca se solicita como entrada y puede cambiar en una migración.

  • status string

    Estado de alimentación; unavailable si el hipervisor no ha respondido; maintenance si no responde durante una intervención anunciada por LWS

    uno de: running, stopped, unavailable, maintenance Ejemplo: running

  • maintenance object

    Intervención anunciada por LWS en el servidor anfitrión (estado de los servicios), programada o en curso, responda o no el servidor; null si no la hay

  • status string

    scheduled: programada; in_progress: en curso

    uno de: scheduled, in_progress

  • kind string

    works: mantenimiento, mejora o reinicio; incident: incidencia, perturbación, ralentización o ataque

    uno de: works, incident

  • starts_at string (date-time)
  • expected_end string (date-time)

    Fin previsto; siempre null para una incidencia

  • os_template string
  • commercial_name string
  • ipv4 string
  • ipv6 string
  • additional_ips string[]
  • datacenter object

    Datacenter

  • code string

    Ejemplo: SJ1

  • city string

    Ejemplo: Nancy

  • country string

    Ejemplo: France

  • zone string

    Ejemplo: eu-france-est

  • purchased_at string (date-time)
  • expires_at string (date-time)
  • enabled boolean

    false: servicio desactivado

  • expired boolean

    true: servicio caducado

  • comment string

    Comentario introducido en el panel

  • meta object

    Paginación. Las listas no paginadas lo devuelven todo y meta refleja el número devuelto.

    PaginationMeta

    obligatorio
  • page integer (int64)

    Página devuelta

    Ejemplo: 1

  • per_page integer (int64)

    Tamaño de página

    Ejemplo: 25

  • total integer (int64)

    Número total de elementos

    Ejemplo: 887

  • total_pages integer (int64)

    Número total de páginas

    Ejemplo: 36

400

Parámetros no válidos: validation_failed — status fuera de la lista.

 
{
  "type": "https://docs.lws.fr/kvm/errors/validation-failed",
  "title": "Paramètres invalides",
  "status": 400,
  "code": "validation_failed",
  "detail": "Paramètre « status » invalide.",
  "request_id": "3f9a1c07b2e45d18",
  "errors": {
    "status": "Valeurs acceptées : running, stopped, unavailable, maintenance."
  }
}
Campos de la respuesta 18
  • type string (uri)

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

    obligatorio
  • title string

    Título breve

    Ejemplo: VPS introuvable

    obligatorio
  • status integer (int64)

    Estado HTTP

    Ejemplo: 404

    obligatorio
  • code string

    Código de máquina estable (véase «Errores» en Primeros pasos)

    Ejemplo: vm_not_found

    obligatorio
  • detail string

    Mensaje detallado

    Ejemplo: Aucun VPS 999999 sur ce compte.

    obligatorio
  • request_id string

    Identificador de la petición, que debe facilitarse al soporte

    Ejemplo: 3f9a1c07b2e45d18

    obligatorio
  • errors object

    validation_failed: mensaje por parámetro erróneo

  • required_level string

    insufficient_scope: nivel exigido por la operación

    uno de: read, exploitation, full

  • task_id string

    task_already_running: tarea en curso en este VPS

    Ejemplo: tsk_000002d5

  • family string

    rate_limited: familia de cuota agotada

    uno de: read, mutation, heavy

  • limit integer (int64)

    rate_limited: límite por hora de la familia

  • retry_after integer (int64)

    rate_limited: segundos de espera

  • lock string

    server_locked: bloqueo establecido por el hipervisor (backup, snapshot, suspended…)

    Ejemplo: snapshot

  • reason string

    server_locked: operation_in_progress, hay una operación en curso, vuelva a intentarlo tras Retry-After; suspended, el VPS está en hibernación, arránquelo primero; support_notified, bloqueo anómalo, el equipo de LWS ha sido avisado y está interviniendo

    uno de: operation_in_progress, suspended, support_notified

  • maintenance object

    server_maintenance: naturaleza de la intervención, inicio y fin previsto (null para una incidencia)

  • kind string

    uno de: works, incident

  • started_at string (date-time)
  • expected_end string (date-time)
401

Autenticación rechazada: invalid_token — encabezado Authorization ausente o mal formado, o clave desconocida; access_disabled — acceso a la API cortado para esta cuenta, o servicio de API cortado momentáneamente por LWS.

encabezado Authorization ausente o mal formado, o clave desconocida

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

acceso a la API cortado para esta cuenta, o servicio de API cortado momentáneamente por 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"
}
Campos de la respuesta 18
  • type string (uri)

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

    obligatorio
  • title string

    Título breve

    Ejemplo: VPS introuvable

    obligatorio
  • status integer (int64)

    Estado HTTP

    Ejemplo: 404

    obligatorio
  • code string

    Código de máquina estable (véase «Errores» en Primeros pasos)

    Ejemplo: vm_not_found

    obligatorio
  • detail string

    Mensaje detallado

    Ejemplo: Aucun VPS 999999 sur ce compte.

    obligatorio
  • request_id string

    Identificador de la petición, que debe facilitarse al soporte

    Ejemplo: 3f9a1c07b2e45d18

    obligatorio
  • errors object

    validation_failed: mensaje por parámetro erróneo

  • required_level string

    insufficient_scope: nivel exigido por la operación

    uno de: read, exploitation, full

  • task_id string

    task_already_running: tarea en curso en este VPS

    Ejemplo: tsk_000002d5

  • family string

    rate_limited: familia de cuota agotada

    uno de: read, mutation, heavy

  • limit integer (int64)

    rate_limited: límite por hora de la familia

  • retry_after integer (int64)

    rate_limited: segundos de espera

  • lock string

    server_locked: bloqueo establecido por el hipervisor (backup, snapshot, suspended…)

    Ejemplo: snapshot

  • reason string

    server_locked: operation_in_progress, hay una operación en curso, vuelva a intentarlo tras Retry-After; suspended, el VPS está en hibernación, arránquelo primero; support_notified, bloqueo anómalo, el equipo de LWS ha sido avisado y está interviniendo

    uno de: operation_in_progress, suspended, support_notified

  • maintenance object

    server_maintenance: naturaleza de la intervención, inicio y fin previsto (null para una incidencia)

  • kind string

    uno de: works, incident

  • started_at string (date-time)
  • expected_end string (date-time)
403

Acceso denegado: ip_not_allowed — dirección de origen no autorizada.

 
{
  "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"
}
Campos de la respuesta 18
  • type string (uri)

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

    obligatorio
  • title string

    Título breve

    Ejemplo: VPS introuvable

    obligatorio
  • status integer (int64)

    Estado HTTP

    Ejemplo: 404

    obligatorio
  • code string

    Código de máquina estable (véase «Errores» en Primeros pasos)

    Ejemplo: vm_not_found

    obligatorio
  • detail string

    Mensaje detallado

    Ejemplo: Aucun VPS 999999 sur ce compte.

    obligatorio
  • request_id string

    Identificador de la petición, que debe facilitarse al soporte

    Ejemplo: 3f9a1c07b2e45d18

    obligatorio
  • errors object

    validation_failed: mensaje por parámetro erróneo

  • required_level string

    insufficient_scope: nivel exigido por la operación

    uno de: read, exploitation, full

  • task_id string

    task_already_running: tarea en curso en este VPS

    Ejemplo: tsk_000002d5

  • family string

    rate_limited: familia de cuota agotada

    uno de: read, mutation, heavy

  • limit integer (int64)

    rate_limited: límite por hora de la familia

  • retry_after integer (int64)

    rate_limited: segundos de espera

  • lock string

    server_locked: bloqueo establecido por el hipervisor (backup, snapshot, suspended…)

    Ejemplo: snapshot

  • reason string

    server_locked: operation_in_progress, hay una operación en curso, vuelva a intentarlo tras Retry-After; suspended, el VPS está en hibernación, arránquelo primero; support_notified, bloqueo anómalo, el equipo de LWS ha sido avisado y está interviniendo

    uno de: operation_in_progress, suspended, support_notified

  • maintenance object

    server_maintenance: naturaleza de la intervención, inicio y fin previsto (null para una incidencia)

  • kind string

    uno de: works, incident

  • started_at string (date-time)
  • expected_end string (date-time)
429

Cuota superada: rate_limited — cuota por hora de la familia agotada.

 
{
  "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
}
Campos de la respuesta 18
  • type string (uri)

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

    obligatorio
  • title string

    Título breve

    Ejemplo: VPS introuvable

    obligatorio
  • status integer (int64)

    Estado HTTP

    Ejemplo: 404

    obligatorio
  • code string

    Código de máquina estable (véase «Errores» en Primeros pasos)

    Ejemplo: vm_not_found

    obligatorio
  • detail string

    Mensaje detallado

    Ejemplo: Aucun VPS 999999 sur ce compte.

    obligatorio
  • request_id string

    Identificador de la petición, que debe facilitarse al soporte

    Ejemplo: 3f9a1c07b2e45d18

    obligatorio
  • errors object

    validation_failed: mensaje por parámetro erróneo

  • required_level string

    insufficient_scope: nivel exigido por la operación

    uno de: read, exploitation, full

  • task_id string

    task_already_running: tarea en curso en este VPS

    Ejemplo: tsk_000002d5

  • family string

    rate_limited: familia de cuota agotada

    uno de: read, mutation, heavy

  • limit integer (int64)

    rate_limited: límite por hora de la familia

  • retry_after integer (int64)

    rate_limited: segundos de espera

  • lock string

    server_locked: bloqueo establecido por el hipervisor (backup, snapshot, suspended…)

    Ejemplo: snapshot

  • reason string

    server_locked: operation_in_progress, hay una operación en curso, vuelva a intentarlo tras Retry-After; suspended, el VPS está en hibernación, arránquelo primero; support_notified, bloqueo anómalo, el equipo de LWS ha sido avisado y está interviniendo

    uno de: operation_in_progress, suspended, support_notified

  • maintenance object

    server_maintenance: naturaleza de la intervención, inicio y fin previsto (null para una incidencia)

  • kind string

    uno de: works, incident

  • started_at string (date-time)
  • expected_end string (date-time)
502

Dependencia inaccesible: upstream_unavailable — inventario de VPS momentáneamente no disponible.

 
{
  "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"
}
Campos de la respuesta 18
  • type string (uri)

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

    obligatorio
  • title string

    Título breve

    Ejemplo: VPS introuvable

    obligatorio
  • status integer (int64)

    Estado HTTP

    Ejemplo: 404

    obligatorio
  • code string

    Código de máquina estable (véase «Errores» en Primeros pasos)

    Ejemplo: vm_not_found

    obligatorio
  • detail string

    Mensaje detallado

    Ejemplo: Aucun VPS 999999 sur ce compte.

    obligatorio
  • request_id string

    Identificador de la petición, que debe facilitarse al soporte

    Ejemplo: 3f9a1c07b2e45d18

    obligatorio
  • errors object

    validation_failed: mensaje por parámetro erróneo

  • required_level string

    insufficient_scope: nivel exigido por la operación

    uno de: read, exploitation, full

  • task_id string

    task_already_running: tarea en curso en este VPS

    Ejemplo: tsk_000002d5

  • family string

    rate_limited: familia de cuota agotada

    uno de: read, mutation, heavy

  • limit integer (int64)

    rate_limited: límite por hora de la familia

  • retry_after integer (int64)

    rate_limited: segundos de espera

  • lock string

    server_locked: bloqueo establecido por el hipervisor (backup, snapshot, suspended…)

    Ejemplo: snapshot

  • reason string

    server_locked: operation_in_progress, hay una operación en curso, vuelva a intentarlo tras Retry-After; suspended, el VPS está en hibernación, arránquelo primero; support_notified, bloqueo anómalo, el equipo de LWS ha sido avisado y está interviniendo

    uno de: operation_in_progress, suspended, support_notified

  • maintenance object

    server_maintenance: naturaleza de la intervención, inicio y fin previsto (null para una incidencia)

  • kind string

    uno de: works, incident

  • started_at string (date-time)
  • expected_end string (date-time)
GET /servers 
LWS_API_KEY='…'curl -X GET \  "https://panelkvm.lwspanel.com/api/v1/servers" \  -H "Authorization: Bearer $LWS_API_KEY"
$lwsApiKey = '…';$ch = curl_init("https://panelkvm.lwspanel.com/api/v1/servers");curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);curl_setopt($ch, CURLOPT_HTTPHEADER, [    "Authorization: Bearer " . $lwsApiKey,]);$res = json_decode(curl_exec($ch), true);
import requestsLWS_API_KEY = "…"res = requests.get(    "https://panelkvm.lwspanel.com/api/v1/servers",    headers={        "Authorization": "Bearer " + LWS_API_KEY,    },)print(res.json())
const LWS_API_KEY = "…";const res = await fetch("https://panelkvm.lwspanel.com/api/v1/servers", {  method: "GET",  headers: {    "Authorization": "Bearer " + LWS_API_KEY,  },});const data = await res.json();
lwsApiKey := "…"req, _ := http.NewRequest("GET",    "https://panelkvm.lwspanel.com/api/v1/servers", nil)req.Header.Set("Authorization", "Bearer "+lwsApiKey)resp, err := http.DefaultClient.Do(req)