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

Añadir una clave SSH

POST /api/v1/ssh-keys

operationIdpostSshKey

Nivel requerido
Explotación
Cuota
mutación, 300 llamadas por hora

Registra una clave pública en la cuenta. Está activa desde su creación.

La clave se rechaza si su algoritmo no se reconoce o si se trata de una RSA de menos de 2048 bits. La respuesta contiene la ficha de la clave: anote su id, necesario para desactivarla o eliminarla. Si la ficha no ha podido releerse, la respuesta se limita a {"created": true}: en ese caso, localice la clave con GET /ssh-keys.

Cuerpo de la solicitud

application/json
  • key string

    Clave pública OpenSSH, tal como figura en el archivo .pub

    obligatorio
Ejemplo de solicitud 
{
  "key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAINK0AO80+x734if/v0cHQXq3DTEQDjY2M0t6Mm3lDOiC poste-admin"
}

Respuestas

201

Clave registrada

 
{
  "data": {
    "id": "47",
    "type": "ssh-ed25519",
    "comment": "poste-admin",
    "active": true,
    "fingerprint": "SHA256:lpEBpHL5EO65b9cDXg8YjfqlnovHfCn+3faPLPbfnZI",
    "fingerprint_md5": "ab:c7:15:6a:9a:4e:fb:02:1b:b8:ab:3f:e5:41:67:a2",
    "weak": false
  }
}
Campos de la respuesta 8
  • data object

    SshKey

    obligatorio
  • id string

    Ejemplo: 47

  • type string

    Ejemplo: ssh-ed25519

  • comment string

    Comentario incluido en la clave

  • fingerprint string

    Huella SHA-256, formato ssh-keygen -l

  • fingerprint_md5 string

    Huella MD5, la que muestra el panel

  • active boolean

    Se instala automáticamente al crear o reinstalar un VPS

  • weak boolean

    Clave heredada que hoy se rechazaría al añadirla (RSA de menos de 2048 bits): se lista para poder desactivarla o eliminarla, se rechaza en la reinstalación

400

Parámetros no válidos: validation_failed — clave ilegible, de un tipo desconocido o RSA de menos de 2048 bits.

 
{
  "type": "https://docs.lws.fr/kvm/errors/validation-failed",
  "title": "Paramètres invalides",
  "status": 400,
  "code": "validation_failed",
  "detail": "Clé SSH refusée. Attendu : une clé publique OpenSSH d'un type reconnu, les clés RSA devant faire au moins 2048 bits.",
  "request_id": "3f9a1c07b2e45d18",
  "errors": {
    "key": "Clé SSH refusée. Attendu : une clé publique OpenSSH d'un type reconnu, les clés RSA devant faire au moins 2048 bits."
  }
}
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: insufficient_scope — nivel de la clave insuficiente; ip_not_allowed — dirección de origen no autorizada.

nivel de la clave insuficiente

{
  "type": "https://docs.lws.fr/kvm/errors/insufficient-scope",
  "title": "Droits insuffisants",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "Niveau de permission « exploitation » requis.",
  "request_id": "3f9a1c07b2e45d18",
  "required_level": "exploitation"
}

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 « mutation » : 300 appels par heure. Réessayez dans 95 seconde(s).",
  "request_id": "3f9a1c07b2e45d18",
  "family": "mutation",
  "limit": 300,
  "retry_after": 95
}
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 — API de gestión de claves inaccesible.

 
{
  "type": "https://docs.lws.fr/kvm/errors/upstream-unavailable",
  "title": "Service momentanément indisponible",
  "status": 502,
  "code": "upstream_unavailable",
  "detail": "La liste des clés SSH n'a pas pu être obtenue. Réessayez dans quelques instants.",
  "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)
POST /ssh-keys 
LWS_API_KEY='…'curl -X POST \  "https://panelkvm.lwspanel.com/api/v1/ssh-keys" \  -H "Authorization: Bearer $LWS_API_KEY" \  -H "Content-Type: application/json" \  -d '{"key":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAINK0AO80+x734if/v0cHQXq3DTEQDjY2M0t6Mm3lDOiC poste-admin"}'
$lwsApiKey = '…';$ch = curl_init("https://panelkvm.lwspanel.com/api/v1/ssh-keys");curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);curl_setopt($ch, CURLOPT_HTTPHEADER, [    "Authorization: Bearer " . $lwsApiKey,    "Content-Type: application/json",]);curl_setopt($ch, CURLOPT_POSTFIELDS, '{"key":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAINK0AO80+x734if/v0cHQXq3DTEQDjY2M0t6Mm3lDOiC poste-admin"}');$res = json_decode(curl_exec($ch), true);
import requestsLWS_API_KEY = "…"res = requests.post(    "https://panelkvm.lwspanel.com/api/v1/ssh-keys",    headers={        "Authorization": "Bearer " + LWS_API_KEY,    },    json={"key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAINK0AO80+x734if/v0cHQXq3DTEQDjY2M0t6Mm3lDOiC poste-admin"},)print(res.json())
const LWS_API_KEY = "…";const res = await fetch("https://panelkvm.lwspanel.com/api/v1/ssh-keys", {  method: "POST",  headers: {    "Authorization": "Bearer " + LWS_API_KEY,    "Content-Type": "application/json",  },  body: JSON.stringify({"key":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAINK0AO80+x734if/v0cHQXq3DTEQDjY2M0t6Mm3lDOiC poste-admin"}),});const data = await res.json();
lwsApiKey := "…"body := strings.NewReader(`{"key":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAINK0AO80+x734if/v0cHQXq3DTEQDjY2M0t6Mm3lDOiC poste-admin"}`)req, _ := http.NewRequest("POST",    "https://panelkvm.lwspanel.com/api/v1/ssh-keys", body)req.Header.Set("Authorization", "Bearer "+lwsApiKey)req.Header.Set("Content-Type", "application/json")resp, err := http.DefaultClient.Do(req)