LiveConfig 3 - REST API

Category: LiveConfig
Created: 2022-06-28
Updated: 2026-04-28

Starting with version 3.0, LiveConfig provides a modern REST API. It is also possible to grant end customers API access (via the corresponding permission in their accounts or templates).

Authentication is performed via a so-called Bearer Token, which must be included as an HTTP header (Authorization: Bearer ...) with every request. The tokens can be generated and managed in the User Settings. The API documentation can also be viewed there - filtered to show only the functions for which the respective user is actually authorized.

To access objects in the context of customers/end users (e.g., to edit a domain’s webspace settings), you can specify via a corresponding HTTP header which customer or user the access should be performed as:

• X-Customer-ID: here you can specify the customer number of your own (direct) customer; the request is then executed in the context of that customer’s main user.
• X-User-Name: here you can specify the LiveConfig username of any user, regardless of how deeply nested, with which the access should be performed.

Please also note:

• For almost all requests, Accept: application/json must be included in the request header
• For almost all transmitted data (PATCH, POST), the data must be transmitted in JSON format with the header Content-Type: application/json

The API documentation is available in OpenAPI format (Source: lc3-api.json). The following list contains all currently available functions; you can also use it to test read access directly (these requests are sent to the LiveConfig demo server).