Return Leika configuration

This function returns Leika configuration data. Leika is an internal module that cPanel & WHM uses to track access to features.

Note:

If you do not provide an item parameter, this returns the entire configuration.

SecurityBasicAuth

Request

query Parameters

item

string

The feature(s) for which to return configuration keys.

Note:

Pass multiple item parameters to return multiple features' configuration keys.
If an item parameter returns an undefined key value, the configuration value does not exist or is set to null.

Examples:

cpanel.key1

Return the `key1` configuration key for the `cpanel` feature.

item=cpanel.key1

webmail.key3.subkey1

Return the nested `key3.subkey1` configuration key for the `webmail` feature.

item=webmail.key3.subkey1

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/Leika/leika_get_config

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi Leika leika_get_config item='key1' item='key3'
uapi --output=jsonpretty \
--user=username \
Leika \
leika_get_config \
item=cpanel.key1 \
item=webmail.key3

Response samples

application/json

{"apiversion": 3,
"func": "leika_get_config",
"module": "Leika",
"result": {"data": {"cpanel.key1": "enabled",
"webmail.key3": {"subkey1": "active",
"subkey2": "inactive"
}
},
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}