API documentation Web hosting accessible to everyone Visit LWS

Schema

Server

  • vmid string

    Identifier of the VPS

    Example: 116807

  • name string

    Name of the machine on the hypervisor

  • node string

    Hypervisor hosting the VPS, for information only. Never requested as input, and may change during a migration.

  • status string

    Power status; unavailable if the hypervisor did not respond; maintenance if it does not respond during an intervention announced by LWS

    one of: running, stopped, unavailable, maintenance Example: running

  • maintenance object

    Intervention announced by LWS on the host server (service status), scheduled or in progress, whether the server responds or not; null if there is none

  • status string

    scheduled: scheduled; in_progress: in progress

    one of: scheduled, in_progress

  • kind string

    works: maintenance, improvement or reboot; incident: incident, disruption, slowdown or attack

    one of: works, incident

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

    Expected end; always null for an incident

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

    Example: SJ1

  • city string

    Example: Nancy

  • country string

    Example: France

  • zone string

    Example: eu-france-est

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

    false: service disabled

  • expired boolean

    true: service expired

  • comment string

    Comment entered in the panel

Example
{
  "vmid": "116807",
  "name": "string",
  "node": "string",
  "status": "running",
  "maintenance": {
    "status": "scheduled",
    "kind": "works",
    "starts_at": "2026-01-15T10:30:00Z",
    "expected_end": "2026-01-15T10:30:00Z"
  },
  "os_template": "string",
  "commercial_name": "string",
  "ipv4": "string",
  "ipv6": "string",
  "additional_ips": [
    "string"
  ],
  "datacenter": {
    "code": "SJ1",
    "city": "Nancy",
    "country": "France",
    "zone": "eu-france-est"
  },
  "purchased_at": "2026-01-15T10:30:00Z",
  "expires_at": "2026-01-15T10:30:00Z",
  "enabled": false,
  "expired": false,
  "comment": "string"
}