Изменение параметров работы с событиями по объектам

Метод и конечная точка

PUT /tenants/{tenant_name}/history_settings

Описание

Отправляет обновление значений параметров работы с событиями по объектам.

Параметры

Перечень параметров представлен в таблице.

Название	Обязательный	Тип данных	Описание
history_settings	нет	string	Параметр для настройки работы с событиями по объектам
tenant_name	да	string	Имя тенанта

Запрос

curl -X 'PUT' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/tenants/<TENANT_NAME>" \
-d history_settings='{"history_enabled": false, "history_events_max_count": 100, \
"history_expiration_period": 31536000}'
-H 'accept: application/json'

где:

• <TENANT_NAME> — имя настраиваемого тенанта;

• $LOGIN_TOKEN — токен авторизации полученный в разделе Настройка токена авторизации.

• history_settings — настройки для работы с событиями по объектам в тенанте, например:

Ответ

Возможные варианты ответов:

• 200 — Success — Успешно. Пример вывода:

{
"history_settings": {
"has_history_events": true,
"history_enabled": true,
"history_events_max_count": 0,
"history_expiration_period": 0,
"history_strategy": "string"
 },
"id": "string",
"name": "string"
}

• 401 — Auth header is not provided or token is invalid — Не указан параметр авторизации или некорректный токен. Пример вывода:

{
"message": "string"
}

• 404 — Tenant not found — Тенант не найден. Пример вывода:

{
"message": "string"
}