List of system settings

Getting a list of system settings

Each group of system settings has its own permission.

CODE

access-rights - system-settings-access-rights-index
links - system-settings-links-index

GET /api/admin/v1/system-settings

Method parameters

string group, system settings group

200 OK

List of all possible settings (the example provides a certain number)

JSON

[
    {
        "id": 3,
        "name": "subuser_session_limit",
        "description": "Limit of sessions for sub-users",
        "value": 1,
        "created_at": "2022-12-06T17:20:36.000000Z",
        "updated_at": "2022-12-06T17:20:36.000000Z",
        "type": null,
        "min": 1,
        "max": 100,
        "cast_type": "integer",
        "is_enabled": null
    },
    {
        "id": 4,
        "name": "special_session_limit",
        "description": "Limit of sessions for temporary users",
        "value": 1,
        "created_at": "2022-12-06T17:20:36.000000Z",
        "updated_at": "2022-12-06T17:20:36.000000Z",
        "type": null,
        "min": 1,
        "max": 100,
        "cast_type": "integer",
        "is_enabled": null
    }
]

401 Unauthorized

Authorization token is not provided or is invalid. Obtaining a token

403 Forbidden

If there are no access rights to get a group of settings

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/system-settings' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "group": "string"
}'

PHP

$data = array (
  'group' => 'string',
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/admin/v1/system-settings', false, $context);