Consultar una tarea

GET /api/v1/tasks/{id}

operationIdgetTask

Nivel requerido: Solo lectura
Cuota: lectura, 3600 llamadas por hora

Estado de una tarea: consultándola es como se sabe que una operación ha finalizado. finished_at sigue en null mientras la tarea está en ejecución.

El identificador es opaco: no intente fabricarlo ni incrementarlo. Una tarea desconocida y una tarea fuera del alcance de la clave responden con el mismo 404.

Basta con una consulta cada pocos segundos: consultar con más frecuencia consume la cuota de lectura sin acelerar nada.

Parámetros de ruta

id string obligatorio: Identificador de la tarea, tal como se devuelve en su creación o en GET /tasks.

Ejemplo: tsk_000002e1

Respuestas

200

La tarea

Terminada

{
  "data": {
    "id": "tsk_000002d4",
    "status": "succeeded",
    "action": "server.rebuild",
    "vmid": "107565",
    "description": "Réinstallation du serveur VPS-107565 avec le template Debian 13 (Trixie)",
    "created_at": "2026-08-07T14:56:31+02:00",
    "finished_at": "2026-08-07T15:02:02+02:00"
  }
}

En curso

{
  "data": {
    "id": "tsk_000002e8",
    "status": "pending",
    "action": "backup.create",
    "vmid": "116807",
    "description": "Création d'une backup du serveur VPS-116807",
    "created_at": "2026-08-18T13:04:11+02:00",
    "finished_at": null
  }
}

Campos de la respuesta 8

data object

Task

obligatorio
id string

Identificador opaco

Ejemplo: tsk_000002e1
status string

unknown indicaría un estado que la API no sabe nombrar

uno de: pending, succeeded, failed, unknown
action string

Tipo de tarea

uno de: server.start, server.stop, server.shutdown, server.reboot, server.reset, server.rebuild, server.enable_rescue, server.disable_rescue, server.reboot_rescue, snapshot.create, snapshot.delete, snapshot.rollback, backup.create, backup.restore, iso.mount, iso.unmount, firewall.sync, firewall.unblock_port_25 TaskAction
vmid string
description string
created_at string (date-time)
finished_at string (date-time)

null mientras la tarea está en ejecución

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)

404

Recurso no encontrado: task_not_found — tarea desconocida o fuera del alcance.

{
  "type": "https://docs.lws.fr/kvm/errors/task-not-found",
  "title": "Tâche introuvable",
  "status": 404,
  "code": "task_not_found",
  "detail": "Tâche introuvable.",
  "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)

Consultar una tarea

Parámetros de ruta

Respuestas

Informar de un error

Asistente IA