Skip to content

system_config

Query and set system configuration

Index

Path
GET /v7.0/system_configs
Description
List configuration variables
Authentication required
no
Scope
system_config#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
system_config
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
category
Category
 String no

Default: null

Validation rules
RuleDetails
Format

Must match this regular expression:

\A[a-zA-Z0-9_]{1,75}\z

null

Validation error message: bad format

Output parameters

Layout
object_list
Namespace
system_configs
ParameterTypeDescription
category
Category
 String
name
Name
 String
type
Type
 String node, storage or mailer
localized
Localized
 Boolean
value
Value
 Custom
localized_value
Localized value
 Custom
label
Label
 String
description
Description
 String
min_user_level
Min_user_level
 Integer

Show

Path
GET /v7.0/system_configs/{category}/{name}
Description
Show configuration variable
Authentication required
no
Scope
system_config#show
Aliases
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
system_config
ParameterTypeDescription
category
Category
 String
name
Name
 String
type
Type
 String node, storage or mailer
localized
Localized
 Boolean
value
Value
 Custom
localized_value
Localized value
 Custom
label
Label
 String
description
Description
 String
min_user_level
Min_user_level
 Integer

Update

Path
PUT /v7.0/system_configs/{category}/{name}
Description
Update configuration variable
Authentication required
yes
Scope
system_config#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
system_config
ParameterTypeRequiredDetails
value
Value
 Custom no

Default: null

Output parameters

Layout
object
Namespace
system_config
ParameterTypeDescription
category
Category
 String
name
Name
 String
type
Type
 String node, storage or mailer
localized
Localized
 Boolean
value
Value
 Custom
localized_value
Localized value
 Custom
label
Label
 String
description
Description
 String
min_user_level
Min_user_level
 Integer