Check your API key

GET /api/v1/me

operationIdgetMe

Required level: Read only
Rate limit: read, 3,600 calls per hour

Holder of the key, granted permission level and number of VPS covered. Recommended first call: it checks that a key works without risking any action.

access.key_prefix contains only the beginning of the key, never enough to rebuild it.

Responses

200

Identity and permissions of the key

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

Response fields 13

data object

Me

required
account_id integer (int64)

LWS identifier of the account

Example: 12723
source string

Channel of the call

one of: api, mcp
access object
key_prefix string

Beginning of the key, to recognize it

Example: lws_live_sk_7Yc2Kp9R
permission_level string

one of: read, exploitation, full
vm_scope string

all: all VPS, including future ones; selected: chosen VPS

one of: all, selected
vm_count integer (int64)

Number of VPS covered by the key
last_used_at string (date-time)
mcp object

MCP access of the account, configured separately
enabled boolean
client_id string
permission_level string

one of: read, exploitation, full

401

Authentication refused: invalid_token — Authorization header missing or malformed, or unknown key; access_disabled — API access turned off for this account, or API service temporarily turned off by LWS.

Authorization header missing or malformed, or unknown key

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

API access turned off for this account, or API service temporarily turned off by 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

Short title, in French

Example: VPS introuvable

required
status integer (int64)

HTTP status

Example: 404

required
code string

Stable machine-readable code (see "Errors" in Getting started)

Example: vm_not_found

required
detail string

Detailed message, in French

Example: Aucun VPS 999999 sur ce compte.

required
request_id string

Identifier of the request, to give to support

Example: 3f9a1c07b2e45d18

required
errors object

validation_failed: message per faulty parameter
required_level string

insufficient_scope: level required by the operation

one of: read, exploitation, full
task_id string

task_already_running: task running on this VPS

Example: tsk_000002d5
family string

rate_limited: exhausted rate limit family

one of: read, mutation, heavy
limit integer (int64)

rate_limited: hourly limit of the family
retry_after integer (int64)

rate_limited: seconds to wait
lock string

server_locked: lock set by the hypervisor (backup, snapshot, suspended…)

Example: snapshot
reason string

server_locked: operation_in_progress, an operation is running, retry after Retry-After; suspended, the VPS is hibernating, start it first; support_notified, abnormal lock, the LWS team has been notified and is taking care of it

one of: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: nature of the intervention, start and expected end (null for an incident)
kind string

one of: works, incident
started_at string (date-time)
expected_end string (date-time)

403

Access denied: ip_not_allowed — calling address not authorized.

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

Short title, in French

Example: VPS introuvable

required
status integer (int64)

HTTP status

Example: 404

required
code string

Stable machine-readable code (see "Errors" in Getting started)

Example: vm_not_found

required
detail string

Detailed message, in French

Example: Aucun VPS 999999 sur ce compte.

required
request_id string

Identifier of the request, to give to support

Example: 3f9a1c07b2e45d18

required
errors object

validation_failed: message per faulty parameter
required_level string

insufficient_scope: level required by the operation

one of: read, exploitation, full
task_id string

task_already_running: task running on this VPS

Example: tsk_000002d5
family string

rate_limited: exhausted rate limit family

one of: read, mutation, heavy
limit integer (int64)

rate_limited: hourly limit of the family
retry_after integer (int64)

rate_limited: seconds to wait
lock string

server_locked: lock set by the hypervisor (backup, snapshot, suspended…)

Example: snapshot
reason string

server_locked: operation_in_progress, an operation is running, retry after Retry-After; suspended, the VPS is hibernating, start it first; support_notified, abnormal lock, the LWS team has been notified and is taking care of it

one of: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: nature of the intervention, start and expected end (null for an incident)
kind string

one of: works, incident
started_at string (date-time)
expected_end string (date-time)

429

Rate limit exceeded: rate_limited — hourly limit of the family exhausted.

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

Short title, in French

Example: VPS introuvable

required
status integer (int64)

HTTP status

Example: 404

required
code string

Stable machine-readable code (see "Errors" in Getting started)

Example: vm_not_found

required
detail string

Detailed message, in French

Example: Aucun VPS 999999 sur ce compte.

required
request_id string

Identifier of the request, to give to support

Example: 3f9a1c07b2e45d18

required
errors object

validation_failed: message per faulty parameter
required_level string

insufficient_scope: level required by the operation

one of: read, exploitation, full
task_id string

task_already_running: task running on this VPS

Example: tsk_000002d5
family string

rate_limited: exhausted rate limit family

one of: read, mutation, heavy
limit integer (int64)

rate_limited: hourly limit of the family
retry_after integer (int64)

rate_limited: seconds to wait
lock string

server_locked: lock set by the hypervisor (backup, snapshot, suspended…)

Example: snapshot
reason string

server_locked: operation_in_progress, an operation is running, retry after Retry-After; suspended, the VPS is hibernating, start it first; support_notified, abnormal lock, the LWS team has been notified and is taking care of it

one of: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: nature of the intervention, start and expected end (null for an incident)
kind string

one of: works, incident
started_at string (date-time)
expected_end string (date-time)

502

Dependency unreachable: upstream_unavailable — VPS inventory temporarily unavailable.

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

Response fields 18

type string (uri)

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

required
title string

Short title, in French

Example: VPS introuvable

required
status integer (int64)

HTTP status

Example: 404

required
code string

Stable machine-readable code (see "Errors" in Getting started)

Example: vm_not_found

required
detail string

Detailed message, in French

Example: Aucun VPS 999999 sur ce compte.

required
request_id string

Identifier of the request, to give to support

Example: 3f9a1c07b2e45d18

required
errors object

validation_failed: message per faulty parameter
required_level string

insufficient_scope: level required by the operation

one of: read, exploitation, full
task_id string

task_already_running: task running on this VPS

Example: tsk_000002d5
family string

rate_limited: exhausted rate limit family

one of: read, mutation, heavy
limit integer (int64)

rate_limited: hourly limit of the family
retry_after integer (int64)

rate_limited: seconds to wait
lock string

server_locked: lock set by the hypervisor (backup, snapshot, suspended…)

Example: snapshot
reason string

server_locked: operation_in_progress, an operation is running, retry after Retry-After; suspended, the VPS is hibernating, start it first; support_notified, abnormal lock, the LWS team has been notified and is taking care of it

one of: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: nature of the intervention, start and expected end (null for an incident)
kind string

one of: works, incident
started_at string (date-time)
expected_end string (date-time)

Check your API key

Responses

Report an error

AI assistant