Documentação da API Alojamento web acessível a todos
PT

Idioma

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

Documentação

API de Domínios e E-mail API VPS KVM
Início da documentação

Verificar a sua chave de API

GET /api/v1/me

operationIdgetMe

Nível exigido
Apenas leitura
Quota
leitura, 3600 chamadas por hora

Titular da chave, nível de permissão concedido e número de VPS abrangidos. Primeira chamada aconselhada: verifica se uma chave funciona sem arriscar qualquer ação.

access.key_prefix contém apenas o início da chave, nunca o suficiente para a reconstituir.

Respostas

200

Identidade e permissões da chave

 
{
  "data": {
    "account_id": 12723,
    "source": "api",
    "access": {
      "key_prefix": "lws_live_sk_7Yc2Kp9R",
      "permission_level": "exploitation",
      "vm_scope": "selected",
      "vm_count": 2,
      "last_used_at": "2026-08-06T09:04:12+02:00"
    },
    "mcp": {
      "enabled": false,
      "client_id": "lws-mcp-12723",
      "permission_level": "read"
    }
  }
}
Campos da resposta 13
  • data object

    Me

    obrigatório
  • account_id integer (int64)

    Identificador LWS da conta

    Exemplo: 12723

  • source string

    Canal da chamada

    um de: api, mcp

  • access object
  • key_prefix string

    Início da chave, para a reconhecer

    Exemplo: lws_live_sk_7Yc2Kp9R

  • permission_level string

    um de: read, exploitation, full

  • vm_scope string

    all: todos os VPS, incluindo os futuros; selected: VPS escolhidos

    um de: all, selected

  • vm_count integer (int64)

    Número de VPS abrangidos pela chave

  • last_used_at string (date-time)
  • mcp object

    Acesso MCP da conta, configurado separadamente

  • enabled boolean
  • client_id string
  • permission_level string

    um de: read, exploitation, full

401

Autenticação recusada: invalid_token — cabeçalho Authorization ausente ou mal formado, ou chave desconhecida; access_disabled — acesso à API cortado para esta conta, ou serviço de API momentaneamente suspenso pela LWS.

cabeçalho Authorization ausente ou mal formado, ou chave desconhecida

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

acesso à API cortado para esta conta, ou serviço de API momentaneamente suspenso pela 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 da resposta 18
  • type string (uri)

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

    obrigatório
  • title string

    Título curto

    Exemplo: VPS introuvable

    obrigatório
  • status integer (int64)

    Estado HTTP

    Exemplo: 404

    obrigatório
  • code string

    Código de máquina estável (ver «Erros» em Primeiros passos)

    Exemplo: vm_not_found

    obrigatório
  • detail string

    Mensagem detalhada

    Exemplo: Aucun VPS 999999 sur ce compte.

    obrigatório
  • request_id string

    Identificador do pedido, a comunicar ao suporte

    Exemplo: 3f9a1c07b2e45d18

    obrigatório
  • errors object

    validation_failed: mensagem por parâmetro incorreto

  • required_level string

    insufficient_scope: nível exigido pela operação

    um de: read, exploitation, full

  • task_id string

    task_already_running: tarefa em curso neste VPS

    Exemplo: tsk_000002d5

  • family string

    rate_limited: família de quota esgotada

    um de: read, mutation, heavy

  • limit integer (int64)

    rate_limited: limite horário da família

  • retry_after integer (int64)

    rate_limited: segundos a aguardar

  • lock string

    server_locked: bloqueio aplicado pelo hipervisor (backup, snapshot, suspended…)

    Exemplo: snapshot

  • reason string

    server_locked: operation_in_progress, há uma operação em curso, tente novamente após Retry-After; suspended, o VPS está em hibernação, inicie-o primeiro; support_notified, bloqueio anómalo, a equipa LWS foi avisada e está a intervir

    um de: operation_in_progress, suspended, support_notified

  • maintenance object

    server_maintenance: natureza da intervenção, início e fim previsto (null para um incidente)

  • kind string

    um de: works, incident

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

Acesso recusado: ip_not_allowed — endereço de chamada não autorizado.

 
{
  "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 da resposta 18
  • type string (uri)

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

    obrigatório
  • title string

    Título curto

    Exemplo: VPS introuvable

    obrigatório
  • status integer (int64)

    Estado HTTP

    Exemplo: 404

    obrigatório
  • code string

    Código de máquina estável (ver «Erros» em Primeiros passos)

    Exemplo: vm_not_found

    obrigatório
  • detail string

    Mensagem detalhada

    Exemplo: Aucun VPS 999999 sur ce compte.

    obrigatório
  • request_id string

    Identificador do pedido, a comunicar ao suporte

    Exemplo: 3f9a1c07b2e45d18

    obrigatório
  • errors object

    validation_failed: mensagem por parâmetro incorreto

  • required_level string

    insufficient_scope: nível exigido pela operação

    um de: read, exploitation, full

  • task_id string

    task_already_running: tarefa em curso neste VPS

    Exemplo: tsk_000002d5

  • family string

    rate_limited: família de quota esgotada

    um de: read, mutation, heavy

  • limit integer (int64)

    rate_limited: limite horário da família

  • retry_after integer (int64)

    rate_limited: segundos a aguardar

  • lock string

    server_locked: bloqueio aplicado pelo hipervisor (backup, snapshot, suspended…)

    Exemplo: snapshot

  • reason string

    server_locked: operation_in_progress, há uma operação em curso, tente novamente após Retry-After; suspended, o VPS está em hibernação, inicie-o primeiro; support_notified, bloqueio anómalo, a equipa LWS foi avisada e está a intervir

    um de: operation_in_progress, suspended, support_notified

  • maintenance object

    server_maintenance: natureza da intervenção, início e fim previsto (null para um incidente)

  • kind string

    um de: works, incident

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

Quota excedida: rate_limited — quota horária da família esgotada.

 
{
  "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 da resposta 18
  • type string (uri)

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

    obrigatório
  • title string

    Título curto

    Exemplo: VPS introuvable

    obrigatório
  • status integer (int64)

    Estado HTTP

    Exemplo: 404

    obrigatório
  • code string

    Código de máquina estável (ver «Erros» em Primeiros passos)

    Exemplo: vm_not_found

    obrigatório
  • detail string

    Mensagem detalhada

    Exemplo: Aucun VPS 999999 sur ce compte.

    obrigatório
  • request_id string

    Identificador do pedido, a comunicar ao suporte

    Exemplo: 3f9a1c07b2e45d18

    obrigatório
  • errors object

    validation_failed: mensagem por parâmetro incorreto

  • required_level string

    insufficient_scope: nível exigido pela operação

    um de: read, exploitation, full

  • task_id string

    task_already_running: tarefa em curso neste VPS

    Exemplo: tsk_000002d5

  • family string

    rate_limited: família de quota esgotada

    um de: read, mutation, heavy

  • limit integer (int64)

    rate_limited: limite horário da família

  • retry_after integer (int64)

    rate_limited: segundos a aguardar

  • lock string

    server_locked: bloqueio aplicado pelo hipervisor (backup, snapshot, suspended…)

    Exemplo: snapshot

  • reason string

    server_locked: operation_in_progress, há uma operação em curso, tente novamente após Retry-After; suspended, o VPS está em hibernação, inicie-o primeiro; support_notified, bloqueio anómalo, a equipa LWS foi avisada e está a intervir

    um de: operation_in_progress, suspended, support_notified

  • maintenance object

    server_maintenance: natureza da intervenção, início e fim previsto (null para um incidente)

  • kind string

    um de: works, incident

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

Dependência inacessível: upstream_unavailable — inventário dos VPS momentaneamente indisponível.

 
{
  "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 da resposta 18
  • type string (uri)

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

    obrigatório
  • title string

    Título curto

    Exemplo: VPS introuvable

    obrigatório
  • status integer (int64)

    Estado HTTP

    Exemplo: 404

    obrigatório
  • code string

    Código de máquina estável (ver «Erros» em Primeiros passos)

    Exemplo: vm_not_found

    obrigatório
  • detail string

    Mensagem detalhada

    Exemplo: Aucun VPS 999999 sur ce compte.

    obrigatório
  • request_id string

    Identificador do pedido, a comunicar ao suporte

    Exemplo: 3f9a1c07b2e45d18

    obrigatório
  • errors object

    validation_failed: mensagem por parâmetro incorreto

  • required_level string

    insufficient_scope: nível exigido pela operação

    um de: read, exploitation, full

  • task_id string

    task_already_running: tarefa em curso neste VPS

    Exemplo: tsk_000002d5

  • family string

    rate_limited: família de quota esgotada

    um de: read, mutation, heavy

  • limit integer (int64)

    rate_limited: limite horário da família

  • retry_after integer (int64)

    rate_limited: segundos a aguardar

  • lock string

    server_locked: bloqueio aplicado pelo hipervisor (backup, snapshot, suspended…)

    Exemplo: snapshot

  • reason string

    server_locked: operation_in_progress, há uma operação em curso, tente novamente após Retry-After; suspended, o VPS está em hibernação, inicie-o primeiro; support_notified, bloqueio anómalo, a equipa LWS foi avisada e está a intervir

    um de: operation_in_progress, suspended, support_notified

  • maintenance object

    server_maintenance: natureza da intervenção, início e fim previsto (null para um incidente)

  • kind string

    um de: works, incident

  • started_at string (date-time)
  • expected_end string (date-time)
GET /me 
LWS_API_KEY='…'curl -X GET \  "https://panelkvm.lwspanel.com/api/v1/me" \  -H "Authorization: Bearer $LWS_API_KEY"
$lwsApiKey = '…';$ch = curl_init("https://panelkvm.lwspanel.com/api/v1/me");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/me",    headers={        "Authorization": "Bearer " + LWS_API_KEY,    },)print(res.json())
const LWS_API_KEY = "…";const res = await fetch("https://panelkvm.lwspanel.com/api/v1/me", {  method: "GET",  headers: {    "Authorization": "Bearer " + LWS_API_KEY,  },});const data = await res.json();
lwsApiKey := "…"req, _ := http.NewRequest("GET",    "https://panelkvm.lwspanel.com/api/v1/me", nil)req.Header.Set("Authorization", "Bearer "+lwsApiKey)resp, err := http.DefaultClient.Do(req)