API documentation Web hosting accessible to everyone Visit LWS

OpenAPI 3.0 · v1.0 https://api.lws.net/v1

Domain Names & Email API

Register and manage your domain names, their DNS zones, contacts and the email addresses that go with them.

29 operations Test mode available

API interface for managing your LWS accounts and services.

Overview

LWS Client API provides an interface for managing your LWS accounts and services, including domain management, hosting, account handling, and prepaid transactions.

What the API can do

Domain Management

  • Buy, renew, and transfer domains
  • Modify DNS settings (A, AAAA, CNAME, MX, etc...)
  • Check domain availability
  • Manage domain redirections (301/302)
  • Update nameservers and transfer protection

Hosting Management

  • Buy new hosting plans
  • Retrieve hosting information
  • Get all hostings and domains
  • Get hosting package pricing
  • Retrieve renewal prices
  • Enable or disable auto-renewal
  • Renew hosting and associated domain

Account & Contact Management

  • Create and manage contacts
  • Fetch and update contact details
  • Retrieve prepaid account balance
  • Fetch purchase history

WHMCS Integration

  • Connect to WHMCS via a module to buy and resell LWS domains

Pricing

The API is free to use, with no subscribtion fees or paid tokens. However, chargeable actions (e.g., domain purchase, hosting renewal) follow standard LWS pricing. These actions are clearly marked in the documentation.

Payment Methods

  • Only prepaid credit is accepted for API payments.
  • The API does not support other payment methods.
  • All prices are in EUR unless otherwise specified.

💳 To top up your prepaid credit, visit the Compte Prépayé page.

Authentication

To make API requests, you must include authentication headers:

  • X-Auth-Login: The LWS ID of your account (e.g., 123456)
  • X-Auth-Pass: A key to access the API.

🔒 Security Scheme Type: apiKey (Header authentication)

To learn how to use the API and get your API Key, you can follow our documentation.

🔹 Note: You must have a valid LWS account to use the API. If you don't have one, get started here.

How to Use the API

  • Include the authentication headers in your API requests.
  • Requests must be formatted in JSON unless otherwise specified.
  • Some requests (marked [Differed]) are processed in the background, and their status can be checked via the /database endpoints.

Domain Name Services

LWS also provides domain management via the API:

Test environment

For safe API testing without affecting your services, include the X-Test-Mode (such as: X-Test-Mode: true) header in your requests. Actions performed in this mode will be executed in a test environment.

About WHMCS

LWS provides a WHMCS module for resellers to manage domains and services. This module allows you to integrate LWS services into your WHMCS installation, enabling domain registration, management and more. Find out more on the WHMCS Marketplace.

API Documentation Notes

  • LWS reserves the right to restrict or block access in case of API misuse.
  • The API is subject to change without notice. Refer to this documentation for the latest updates.
  • JSON format is used for request/response payloads unless specified otherwise.

Authentication

X-Auth-Login The LWS ID of the account (e.g., 123456) $LWS_AUTH_LOGIN required
X-Auth-Pass A key to access the API. Unique to each account, it can be found in the LWS Panel $LWS_AUTH_PASS required

A test environment is available: send X-Test-Mode: true and nothing real is created, changed or charged.