Sign in
Server

List server configuration variables

Retrieve all visible server configuration variables. Requires SERVER_CONFIG access right. Hidden variables (is_visible = 0) are never returned.

get/v1/server-config

Response

Configuration variables retrieved successfully

namestring

Variable name (up to 63 characters)

valuestring

Current value

defaultValuestring

Default value, empty if not defined

dataType'STRING' | 'BOOLEAN' | 'INTEGER' | 'CHOICE' | 'COLOR' | 'PASSWORD'

Type of the value. BOOLEAN values are stored as "0" and "1", COLOR values as CSS color strings, and CHOICE values must be one of possibleValues.

descriptionstring

Human readable description, empty if not defined

unitsstring

Units of the value (for INTEGER variables), empty if not defined

needServerRestartboolean

True if server restart is required for a change to take effect

Changes

Changed in 1 of the 115 revisions of this API.1