Sign in
Server

Set server configuration variable

Set value of server configuration variable, creating it if it does not exist. Requires SERVER_CONFIG access right. New variables are created as visible string variables without description, units, or default value. Hidden variables cannot be set. Change takes effect immediately unless the variable is marked as requiring server restart.

put/v1/server-config/{name}

Request body

valuestring required

New value, up to 1999 characters

Response

Configuration variable updated 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