settings.getglobal

This method has been removed in Zabbix 5.2.3.

Description

object settings.getglobal(object **parameters**)

The method allows to retrieve the global parameters of settings object according to the given parameters.

PropertyTypeDescription
default_themestring​Default theme.
default_timezonestringSystem time zone by default.
show_technical_errorsintegerShow technical errors (PHP/SQL) to non-Super admin users and to users that are not part of user groups with debug mode enabled.
severity_color_0string​Color for “Not classified” severity as a hexadecimal color code.
severity_color_1stringColor for “Information” severity as a hexadecimal color code.
severity_color_2stringColor for “Warning” severity as a hexadecimal color code.
severity_color_3string​Color for “Average” severity as a hexadecimal color code.
severity_color_4string​Color for “High” severity as a hexadecimal color code.
severity_color_5string​Color for “Disaster” severity as a hexadecimal color code.
custom_colorintegerUse custom event status colors.
problem_unack_colorstringColor for unacknowledged PROBLEM events as a hexadecimal color code.
problem_ack_colorstringColor for acknowledged PROBLEM events as a hexadecimal color code.
ok_unack_colorstringColor for unacknowledged RESOLVED events as a hexadecimal color code.
ok_ack_colorstringColor for acknowledged RESOLVED events as a hexadecimal color code.
default_langstringSystem language by default.
x_frame_optionsstringX-Frame-Options HTTP header.
session_keystringSecret key to sign session data.

This method is available to unauthenticated users and must be called without the auth parameter in the JSON-RPC request.

Parameters

(object) Parameters defining the desired output.

The method supports only one parameter.

ParameterTypeDescription
outputqueryThis parameter being common for all get methods described in the reference commentary.

Return values

(object) Returns settings object contained only global parameters.

Examples

Request:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "settings.getglobal",
  4.     "params": {
  5.         "output": "extend"
  6.     },
  7.     "id": 1
  8. }

Response:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": {
  4.         "default_theme": "blue-theme",
  5.         "show_technical_errors": "0",
  6.         "severity_color_0": "97AAB3",
  7.         "severity_color_1": "7499FF",
  8.         "severity_color_2": "FFC859",
  9.         "severity_color_3": "FFA059",
  10.         "severity_color_4": "E97659",
  11.         "severity_color_5": "E45959",
  12.         "custom_color": "0",
  13.         "problem_unack_color": "CC0000",
  14.         "problem_ack_color": "CC0000",
  15.         "ok_unack_color": "009900",
  16.         "ok_ack_color": "009900",
  17.         "default_lang": "en_GB",
  18.         "x_frame_options": "SAMEORIGIN",
  19.         "session_key": "7c1f57f581c75116f358a5a6becf0f5f"
  20.     },
  21.     "id": 1
  22. }

Source

CSettings::getGlobal() in ui/include/classes/api/services/CSettings.php.