system
GET /sys/audit
ID операции: auditing-list-enabled-devices
Получить список включенных устройств аудита.
Требует sudo: да
Ответы
200: OK
POST /sys/audit-hash/{path}
ID операции: auditing-calculate-hash
Хеш указанной строки, вычисленный указанным бэкендом аудита
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Имя бэкенда. Не может содержать разделителей. Пример: “mysql” |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
input | string | нет |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
hash | string | нет |
GET /sys/audit-monitor/{path}
ID операции: auditing-monitor-device
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Имя бэкенда. Не может содержать разделителей. Пример: “mysql” |
Ответы
200: OK
POST /sys/audit/{path}
ID операции: auditing-enable-device
Включает новое устройство аудита по указанному пути.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Имя бэкенда. Не может содержать разделителей. Пример: “mysql” |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
description | string | нет | Понятное описание этого бэкенда аудита. |
local | boolean (default: False) | нет | Пометить точку монтирования как локальную: она не реплицируется и не затрагивается репликацией. |
options | object | нет | Параметры конфигурации бэкенда аудита. |
type | string | нет | Тип бэкенда. Пример: “mysql” |
Ответы
204: OK
DELETE /sys/audit/{path}
ID операции: auditing-disable-device
Отключить устройство аудита по указанному пути.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Имя бэкенда. Не может содержать разделителей. Пример: “mysql” |
Ответы
204: OK
GET /sys/auth
ID операции: auth-list-enabled-methods
Получить список включенных бэкендов учетных данных.
Ответы
200: OK
GET /sys/auth/{path}
ID операции: auth-read-configuration
Прочитать конфигурацию метода аутентификации по указанному пути.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Путь монтирования. Не может содержать разделителей. Пример: “user” |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
accessor | string | нет | |
config | object | нет | |
deprecation_status | string | нет | |
description | string | нет | |
external_entropy_access | boolean | нет | |
local | boolean | нет | |
options | object | нет | |
plugin_version | string | нет | |
running_plugin_version | string | нет | |
running_sha256 | string | нет | |
seal_wrap | boolean | нет | |
type | string | нет | |
uuid | string | нет |
POST /sys/auth/{path}
ID операции: auth-enable-method
Включает новый метод аутентификации.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Путь монтирования. Не может содержать разделителей. Пример: “user” |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
config | object | нет | Конфигурация этой точки монтирования, например plugin_name. |
description | string | нет | Понятное описание этого бэкенда учетных данных. |
external_entropy_access | boolean (default: False) | нет | Предоставить ли точке монтирования доступ к внешнему источнику энтропии Stronghold. |
local | boolean (default: False) | нет | Пометить точку монтирования как локальную: она не реплицируется и не затрагивается репликацией. |
options | object | нет | Параметры, передаваемые в бэкенд: JSON-объект со строковыми ключами и значениями. |
plugin_name | string | нет | Имя используемого плагина аутентификации из каталога плагинов. |
plugin_version | string | нет | Используемая семантическая версия плагина. |
seal_wrap | boolean (default: False) | нет | Включить ли для точки монтирования seal wrapping. |
type | string | нет | Тип бэкенда. Пример: “userpass” |
Ответы
204: OK
DELETE /sys/auth/{path}
ID операции: auth-disable-method
Отключить метод аутентификации по указанному пути
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Путь монтирования. Не может содержать разделителей. Пример: “user” |
Ответы
204: OK
GET /sys/auth/{path}/tune
ID операции: auth-read-tuning-information
Читает конфигурацию указанного пути аутентификации.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Настройка параметров пути аутентификации. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
allowed_managed_keys | array | нет | |
allowed_response_headers | array | нет | |
audit_non_hmac_request_keys | array | нет | |
audit_non_hmac_response_keys | array | нет | |
default_lease_ttl | integer | нет | |
description | string | нет | |
external_entropy_access | boolean | нет | |
force_no_cache | boolean | нет | |
listing_visibility | string | нет | |
max_lease_ttl | integer | нет | |
options | object | нет | |
passthrough_request_headers | array | нет | |
plugin_version | string | нет | |
token_type | string | нет | |
user_lockout_counter_reset_duration | integer | нет | |
user_lockout_disable | boolean | нет | |
user_lockout_duration | integer | нет | |
user_lockout_threshold | integer | нет |
POST /sys/auth/{path}/tune
ID операции: auth-tune-configuration-parameters
Настроить параметры указанного пути аутентификации.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Настройка параметров пути аутентификации. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
allowed_response_headers | array | нет | Список разрешенных заголовков, которые плагин может устанавливать в ответах. |
audit_non_hmac_request_keys | array | нет | Список ключей в объекте данных запроса, которые устройства аудита не будут хешировать с помощью HMAC. |
audit_non_hmac_response_keys | array | нет | Список ключей в объекте данных ответа, которые устройства аудита не будут хешировать с помощью HMAC. |
default_lease_ttl | string | нет | TTL аренды по умолчанию для этой точки монтирования. |
description | string | нет | Понятное описание этого бэкенда учетных данных. |
listing_visibility | string | нет | Видимость точки монтирования в конечной точке списка для UI. Допустимые значения: ‘unauth’ и ‘hidden’; пустое значение по умолчанию (’’) равнозначно ‘hidden’. |
max_lease_ttl | string | нет | Максимальный TTL аренды для этой точки монтирования. |
options | object | нет | Параметры, передаваемые в бэкенд: JSON-объект со строковыми ключами и значениями. |
passthrough_request_headers | array | нет | Список разрешенных заголовков, которые передаются из запроса в плагин. |
plugin_version | string | нет | Используемая семантическая версия плагина. |
token_type | string | нет | Тип выдаваемого токена (service или batch). |
user_lockout_config | object | нет | Конфигурация блокировки пользователей, передаваемая в бэкенд: JSON-объект со строковыми ключами и значениями. |
Ответы
204: OK
POST /sys/capabilities
ID операции: query-token-capabilities
Возвращает права (capabilities) указанного токена на указанном пути.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
path | array | нет | ⚠️ Устарело. Используйте вместо этого ‘paths’. |
paths | array | нет | Пути, для которых запрашиваются права. |
token | string | нет | Токен, для которого запрашиваются права. |
Ответы
200: OK
POST /sys/capabilities-accessor
ID операции: query-token-accessor-capabilities
Возвращает права токена, связанного с указанным аксессором, на указанном пути.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
accessor | string | нет | Аксессор токена, для которого запрашиваются права. |
path | array | нет | ⚠️ Устарело. Используйте вместо этого ‘paths’. |
paths | array | нет | Пути, для которых запрашиваются права. |
Ответы
200: OK
POST /sys/capabilities-self
ID операции: query-token-self-capabilities
Возвращает права (capabilities) указанного токена на указанном пути.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
path | array | нет | ⚠️ Устарело. Используйте вместо этого ‘paths’. |
paths | array | нет | Пути, для которых запрашиваются права. |
token | string | нет | Токен, для которого запрашиваются права. |
Ответы
200: OK
GET /sys/config/auditing/request-headers
ID операции: auditing-list-request-headers
Получить список заголовков запросов, для которых настроен аудит.
Требует sudo: да
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
headers | object | нет |
GET /sys/config/auditing/request-headers/{header}
ID операции: auditing-read-request-header-information
Получить информацию об указанном заголовке запроса.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
header | string | path | да |
Ответы
200: OK
POST /sys/config/auditing/request-headers/{header}
ID операции: auditing-enable-request-header
Включить аудит заголовка.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
header | string | path | да |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
hmac | boolean | нет |
Ответы
204: OK
DELETE /sys/config/auditing/request-headers/{header}
ID операции: auditing-disable-request-header
Отключить аудит указанного заголовка запроса.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
header | string | path | да |
Ответы
204: OK
GET /sys/config/control-group
ID операции: system-read-config-control-group
Настроить глобальные параметры согласования запросов.
Ответы
200: OK
POST /sys/config/control-group
ID операции: system-write-config-control-group
Настроить глобальные параметры согласования запросов.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
max_ttl | integer | нет | Максимальный TTL токена согласования запросов. |
Ответы
200: OK
DELETE /sys/config/control-group
ID операции: system-delete-config-control-group
Настроить глобальные параметры согласования запросов.
Ответы
204: пустое тело
GET /sys/config/cors
ID операции: cors-read-configuration
Возвращает текущие настройки CORS.
Требует sudo: да
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
allowed_headers | array | нет | |
allowed_origins | array | нет | |
enabled | boolean | нет |
POST /sys/config/cors
ID операции: cors-configure
Настроить параметры CORS.
Требует sudo: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
allowed_headers | array | нет | Строка через запятую или массив строк с заголовками, разрешенными в кросс-доменных запросах. |
allowed_origins | array | нет | Строка через запятую или массив строк с источниками, которым разрешены кросс-доменные запросы. |
enable | boolean | нет | Включает или отключает заголовки CORS в ответах на запросы. |
Ответы
204: OK
DELETE /sys/config/cors
ID операции: cors-delete-configuration
Удалить все настройки CORS.
Требует sudo: да
Ответы
204: OK
GET /sys/config/group-policy-application
ID операции: system-read-config-group-policy-application
Получает текущий режим применения политик в Stronghold.
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
group_policy_application_mode | string | нет | Текущее значение group_policy_application_mode: within_namespace_hierarchy или any. |
POST /sys/config/group-policy-application
ID операции: system-write-config-group-policy-application
Обновляет режим применения политик в Stronghold.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
group_policy_application_mode | string | нет | Определяет, как применяются политики в группах: принимает значения ‘within_namespace_hierarchy’ (по умолчанию) и ‘any’; последнее позволяет политикам предоставлять права в группах вне общей иерархии пространств имен. |
Ответы
200: OK
POST /sys/config/reload/{subsystem}
ID операции: reload-subsystem
Перезагрузить заданную подсистему
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
subsystem | string | path | да |
Ответы
204: OK
GET /sys/config/state/sanitized
ID операции: read-sanitized-configuration-state
Возвращает конфигурацию сервера Stronghold без конфиденциальных данных.
Ответы
200: OK
GET /sys/config/ui/headers
ID операции: ui-headers-list
Возвращает список настроенных заголовков UI.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
keys | array | нет | Список настроенных заголовков UI. Не возвращается, если список пуст |
GET /sys/config/ui/headers/{header}
ID операции: ui-headers-read-configuration
Возвращает конфигурацию указанного заголовка UI
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
header | string | path | да | Имя заголовка. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
value | string | нет | возвращает первое значение заголовка, когда параметр запроса multivalue равен false |
values | array | нет | возвращает все значения заголовков, когда параметр запроса multivalue равен true |
POST /sys/config/ui/headers/{header}
ID операции: ui-headers-configure
Настроить значения, возвращаемые для заголовка UI.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
header | string | path | да | Имя заголовка. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
multivalue | boolean | нет | Возвращает несколько значений, если true |
values | array | нет | Значения заголовка. |
Ответы
200: OK
DELETE /sys/config/ui/headers/{header}
ID операции: ui-headers-delete-configuration
Удалить заголовок UI.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
header | string | path | да | Имя заголовка. |
Ответы
204: OK
POST /sys/control-group/authorize
ID операции: system-write-control-group-authorize
Одобрить запрос на согласование
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
accessor | string | нет | Аксессор авторизуемого запроса. |
Ответы
200: OK
POST /sys/control-group/request
ID операции: system-write-control-group-request
Проверить статус запроса на согласование
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
accessor | string | нет | Аксессор запроса. |
Ответы
200: OK
POST /sys/decode-token
ID операции: decode
Декодирует закодированный токен с помощью OTP.
Доступен без аутентификации: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
encoded_token | string | нет | Закодированный токен (результат generate-root). |
otp | string | нет | OTP-код для декодирования. |
Ответы
200: OK
GET /sys/experiments
ID операции: list-experimental-features
Возвращает доступные и включенные экспериментальные функции
Ответы
200: OK
GET /sys/generate-root
ID операции: root-token-generation-read-progress2
Прочитать конфигурацию и ход текущей попытки генерации root-токена.
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
complete | boolean | нет | |
encoded_root_token | string | нет | |
encoded_token | string | нет | |
nonce | string | нет | |
otp | string | нет | |
otp_length | integer | нет | |
pgp_fingerprint | string | нет | |
progress | integer | нет | |
required | integer | нет | |
started | boolean | нет |
POST /sys/generate-root
ID операции: root-token-generation-initialize-2
Запускает новую попытку генерации root-токена.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
otp | string | нет | Одноразовый пароль для шифрования сгенерированного токена. |
pgp_key | string | нет | Открытый ключ PGP в кодировке base64. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
complete | boolean | нет | |
encoded_root_token | string | нет | |
encoded_token | string | нет | |
nonce | string | нет | |
otp | string | нет | |
otp_length | integer | нет | |
pgp_fingerprint | string | нет | |
progress | integer | нет | |
required | integer | нет | |
started | boolean | нет |
DELETE /sys/generate-root
ID операции: root-token-generation-cancel-2
Отменяет текущую попытку генерации root-токена.
Ответы
204: OK
GET /sys/generate-root/attempt
ID операции: root-token-generation-read-progress
Прочитать конфигурацию и ход текущей попытки генерации root-токена.
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
complete | boolean | нет | |
encoded_root_token | string | нет | |
encoded_token | string | нет | |
nonce | string | нет | |
otp | string | нет | |
otp_length | integer | нет | |
pgp_fingerprint | string | нет | |
progress | integer | нет | |
required | integer | нет | |
started | boolean | нет |
POST /sys/generate-root/attempt
ID операции: root-token-generation-initialize
Запускает новую попытку генерации root-токена.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
otp | string | нет | Одноразовый пароль для шифрования сгенерированного токена. |
pgp_key | string | нет | Открытый ключ PGP в кодировке base64. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
complete | boolean | нет | |
encoded_root_token | string | нет | |
encoded_token | string | нет | |
nonce | string | нет | |
otp | string | нет | |
otp_length | integer | нет | |
pgp_fingerprint | string | нет | |
progress | integer | нет | |
required | integer | нет | |
started | boolean | нет |
DELETE /sys/generate-root/attempt
ID операции: root-token-generation-cancel
Отменяет текущую попытку генерации root-токена.
Ответы
204: OK
POST /sys/generate-root/update
ID операции: root-token-generation-update
Ввести одну долю ключа распечатывания, чтобы продвинуть попытку генерации root-токена.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
key | string | нет | Одна доля ключа распечатывания. |
nonce | string | нет | Nonce попытки. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
complete | boolean | нет | |
encoded_root_token | string | нет | |
encoded_token | string | нет | |
nonce | string | нет | |
otp | string | нет | |
otp_length | integer | нет | |
pgp_fingerprint | string | нет | |
progress | integer | нет | |
required | integer | нет | |
started | boolean | нет |
GET /sys/ha-status
ID операции: ha-status
Проверить HA-статус кластера Stronghold
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
nodes | array | нет |
GET /sys/health
ID операции: read-health-status
Возвращает состояние работоспособности Stronghold.
Доступен без аутентификации: да
Ответы
200: инициализирован, распечатан, активен
423: задан isleaderreadyok, но локальный узел еще не является готовым HA-лидером (или не может связаться с ним)
425: задан raftautopilotok, но autopilot еще не включил локальный узел в кластер
429: распечатан, в режиме ожидания (standby)
472: режим восстановления данных (DR): вторичный кластер репликации, активный
501: не инициализирован
503: запечатан
GET /sys/host-info
ID операции: collect-host-information
Информация о хосте, на котором запущен этот сервер Stronghold.
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
cpu | array | нет | |
cpu_times | array | нет | |
disk | array | нет | |
host | object | нет | |
memory | object | нет | |
timestamp | string | нет |
GET /sys/in-flight-req
ID операции: collect-in-flight-request-information
сообщает о выполняющихся запросах
Ответы
200: OK
GET /sys/init
ID операции: read-initialization-status
Возвращает статус инициализации Stronghold.
Доступен без аутентификации: да
Ответы
200: OK
POST /sys/init
ID операции: initialize
Инициализировать новый Stronghold.
Доступен без аутентификации: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
pgp_keys | array | нет | Массив открытых ключей PGP для шифрования выдаваемых ключей распечатывания. Порядок сохраняется. Ключи должны быть представлены в base64 (из исходного двоичного вида). Размер массива должен совпадать с secret_shares. |
recovery_pgp_keys | array | нет | Массив открытых ключей PGP для шифрования выдаваемых ключей восстановления. Порядок сохраняется. Ключи должны быть представлены в base64 (из исходного двоичного вида). Размер массива должен совпадать с recovery_shares. |
recovery_shares | integer | нет | Количество долей, на которые делится ключ восстановления. |
recovery_threshold | integer | нет | Количество долей, необходимых для восстановления ключа восстановления. Должно быть меньше или равно recovery_shares. |
root_token_pgp_key | string | нет | Открытый ключ PGP для шифрования начального root-токена. Ключ должен быть представлен в base64 (из исходного двоичного вида). |
secret_shares | integer | нет | Количество долей, на которые делится ключ распечатывания. |
secret_threshold | integer | нет | Количество долей, необходимых для восстановления ключа распечатывания. Должно быть меньше или равно secret_shares. При использовании Stronghold HSM с автоматическим распечатыванием должно совпадать с secret_shares. |
stored_shares | integer | нет | Количество долей, которые шифруются HSM и сохраняются для автоматического распечатывания. Сейчас должно совпадать с secret_shares. |
Ответы
200: OK
GET /sys/internal/counters/activity
ID операции: internal-client-activity-report-counts
Возвращает метрики количества клиентов для этого пространства имен и всех дочерних.
Ответы
200: OK
GET /sys/internal/counters/activity/export
ID операции: internal-client-activity-export
Возвращает метрики количества клиентов для этого пространства имен и всех дочерних.
Ответы
200: OK
GET /sys/internal/counters/activity/monthly
ID операции: internal-client-activity-report-counts-this-month
Возвращает количество клиентов за текущий месяц для этого пространства имен и всех дочерних.
Ответы
200: OK
GET /sys/internal/counters/config
ID операции: internal-client-activity-read-configuration
Прочитать конфигурацию учета количества клиентов.
Ответы
200: OK
POST /sys/internal/counters/config
ID операции: internal-client-activity-configure
Включить или отключить сбор данных о количестве клиентов, задать срок хранения или период отчетности по умолчанию.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
default_report_months | integer (default: 12) | нет | Количество месяцев в отчете, если не указана дата начала. |
enabled | string (default: default) | нет | Включить или отключить сбор данных о количестве клиентов: enable, disable или default. |
retention_months | integer (default: 24) | нет | Сколько месяцев хранить данные о клиентах. Значение 0 удаляет все существующие данные. |
Ответы
200: OK
GET /sys/internal/counters/entities
ID операции: internal-count-entities
Обратная совместимость для этого API не гарантирована
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
counters | object | нет |
GET /sys/internal/counters/requests
ID операции: internal-count-requests
Обратная совместимость для этого API не гарантирована
Ответы
200: OK
GET /sys/internal/counters/tokens
ID операции: internal-count-tokens
Обратная совместимость для этого API не гарантирована
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
counters | object | нет |
GET /sys/internal/inspect/router/{tag}
ID операции: internal-inspect-router
Показать таблицы записей маршрутов и записей монтирования в маршрутизаторе
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
tag | string | path | да | Имя просматриваемого поддерева |
Ответы
200: OK
GET /sys/internal/specs/openapi
ID операции: internal-generate-open-api-document
Генерирует документ OpenAPI 3 со всеми смонтированными путями.
Доступен без аутентификации: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
generic_mount_paths | boolean | query | нет | Использовать обобщенные пути монтирования |
Ответы
200: OK
POST /sys/internal/specs/openapi
ID операции: internal-generate-open-api-document-with-parameters
Генерирует документ OpenAPI 3 со всеми смонтированными путями.
Доступен без аутентификации: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
generic_mount_paths | boolean | query | нет | Использовать обобщенные пути монтирования |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
context | string | нет | Строка контекста, добавляемая к каждому operationId |
Ответы
200: OK
GET /sys/internal/ui/feature-flags
ID операции: internal-ui-list-enabled-feature-flags
Выводит список включенных флагов функций.
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
feature_flags | array | нет |
GET /sys/internal/ui/mounts
ID операции: internal-ui-list-enabled-visible-mounts
Выводит список всех включенных и видимых точек монтирования методов аутентификации и механизмов секретов.
Доступен без аутентификации: да
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
auth | object | нет | точки монтирования методов аутентификации |
secret | object | нет | точки монтирования механизмов секретов |
GET /sys/internal/ui/mounts/{path}
ID операции: internal-ui-read-mount-information
Возвращает информацию об указанной точке монтирования.
Доступен без аутентификации: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Путь точки монтирования. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
accessor | string | нет | |
config | object | нет | |
description | string | нет | |
external_entropy_access | boolean | нет | |
local | boolean | нет | |
options | object | нет | |
path | string | нет | |
plugin_version | string | нет | |
running_plugin_version | string | нет | |
running_sha256 | string | нет | |
seal_wrap | boolean | нет | |
type | string | нет | |
uuid | string | нет |
GET /sys/internal/ui/namespaces
ID операции: internal-ui-list-namespaces
Обратная совместимость для этого API не гарантирована
Доступен без аутентификации: да
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
keys | array | нет | поле возвращается, только если есть одно или несколько пространств имен |
GET /sys/internal/ui/resultant-acl
ID операции: internal-ui-read-resultant-acl
Обратная совместимость для этого API не гарантирована
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
exact_paths | object | нет | |
glob_paths | object | нет | |
root | boolean | нет |
204: возвращается пустой ответ, если нет токена клиента
GET /sys/key-status
ID операции: encryption-key-status
Возвращает информацию о ключе шифрования бэкенда.
Ответы
200: OK
GET /sys/leader
ID операции: leader-status
Возвращает статус высокой доступности и текущий узел-лидер Stronghold.
Доступен без аутентификации: да
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
active_time | string | нет | |
ha_enabled | boolean | нет | |
is_self | boolean | нет | |
last_wal | integer | нет | |
leader_address | string | нет | |
leader_cluster_address | string | нет | |
performance_standby | boolean | нет | |
performance_standby_last_remote_wal | integer | нет | |
raft_applied_index | integer | нет | |
raft_committed_index | integer | нет |
GET /sys/leases
ID операции: leases-list
Получить список аренд в этом кластере Stronghold
Требует sudo: да
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
counts | integer | нет | Количество подходящих аренд по точкам монтирования |
lease_count | integer | нет | Количество подходящих аренд |
GET /sys/leases/count
ID операции: leases-count
Количество аренд в этом кластере Stronghold
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
counts | integer | нет | Количество подходящих аренд по точкам монтирования |
lease_count | integer | нет | Количество подходящих аренд |
POST /sys/leases/lookup
ID операции: leases-read-lease
Просмотр метаданных аренды или получение их списка.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
lease_id | string | нет | Идентификатор продлеваемой аренды. Возвращается вместе с арендой. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
expire_time | string | нет | Необязательное время истечения срока аренды |
id | string | нет | Идентификатор аренды |
issue_time | string | нет | Временная метка выдачи аренды |
last_renewal | string | нет | Необязательная временная метка последнего продления аренды |
renewable | boolean | нет | True, если аренду можно продлить |
ttl | integer | нет | TTL аренды; 0, если не задан |
GET /sys/leases/lookup/
ID операции: leases-look-up
Просмотр метаданных аренды или получение их списка.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
keys | array | нет | Список идентификаторов аренд |
GET /sys/leases/lookup/{prefix}
ID операции: leases-look-up-with-prefix
Просмотр метаданных аренды или получение их списка.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
prefix | string | path | да | Путь, по которому выводится список аренд. Пример: “aws/creds/deploy” |
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
keys | array | нет | Список идентификаторов аренд |
POST /sys/leases/renew
ID операции: leases-renew-lease
Продлевает аренду, запрашивая увеличение ее срока.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
increment | integer | нет | Желаемое увеличение срока аренды в секундах |
lease_id | string | нет | Идентификатор продлеваемой аренды. Возвращается вместе с арендой. |
url_lease_id | string | нет | Идентификатор продлеваемой аренды. Возвращается вместе с арендой. |
Ответы
204: OK
POST /sys/leases/renew/{url_lease_id}
ID операции: leases-renew-lease-with-id
Продлевает аренду, запрашивая увеличение ее срока.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
url_lease_id | string | path | да | Идентификатор продлеваемой аренды. Возвращается вместе с арендой. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
increment | integer | нет | Желаемое увеличение срока аренды в секундах |
lease_id | string | нет | Идентификатор продлеваемой аренды. Возвращается вместе с арендой. |
Ответы
204: OK
POST /sys/leases/revoke
ID операции: leases-revoke-lease
Немедленно отзывает аренду.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
lease_id | string | нет | Идентификатор продлеваемой аренды. Возвращается вместе с арендой. |
sync | boolean (default: True) | нет | Выполнять ли отзыв синхронно |
url_lease_id | string | нет | Идентификатор продлеваемой аренды. Возвращается вместе с арендой. |
Ответы
204: OK
POST /sys/leases/revoke-force/{prefix}
ID операции: leases-force-revoke-lease-with-prefix
Немедленно отзывает все секреты или токены, сгенерированные под указанным префиксом
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
prefix | string | path | да | Префикс пути, под которым отзываются ключи. Пример: “prod/aws/ops” |
Ответы
204: OK
POST /sys/leases/revoke-prefix/{prefix}
ID операции: leases-revoke-lease-with-prefix
Немедленно отзывает все секреты (по префиксу идентификатора аренды) или токены (по свойству path токенов), сгенерированные под указанным префиксом.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
prefix | string | path | да | Префикс пути, под которым отзываются ключи. Пример: “prod/aws/ops” |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
sync | boolean (default: True) | нет | Выполнять ли отзыв синхронно |
Ответы
204: OK
POST /sys/leases/revoke/{url_lease_id}
ID операции: leases-revoke-lease-with-id
Немедленно отзывает аренду.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
url_lease_id | string | path | да | Идентификатор продлеваемой аренды. Возвращается вместе с арендой. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
lease_id | string | нет | Идентификатор продлеваемой аренды. Возвращается вместе с арендой. |
sync | boolean (default: True) | нет | Выполнять ли отзыв синхронно |
Ответы
204: OK
POST /sys/leases/tidy
ID операции: leases-tidy
Выполняет задачи очистки, которые можно запустить при возникновении определенных ошибок.
Ответы
204: OK
GET /sys/license/status
ID операции: system-read-license-status
Путь поддерживает следующие HTTP-методы.
GET / Возвращает информацию об установленной лицензии
POST Устанавливает лицензию для сервера
Ответы
200: OK
GET /sys/locked-users
ID операции: locked-users-list
Возвращает метрики количества заблокированных пользователей для этого пространства имен и всех дочерних.
Ответы
200: OK
POST /sys/locked-users/{mount_accessor}/unlock/{alias_identifier}
ID операции: locked-users-unlock
Разблокирует пользователя по указанным mount_accessor и alias_identifier
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
alias_identifier | string | path | да | Имя псевдонима (пользователя). Например, если псевдоним относится к бэкенду userpass, это должно быть существующее имя пользователя в методе аутентификации userpass. Если псевдоним относится к методу аутентификации approle, это должен быть действительный RoleID |
mount_accessor | string | path | да | MountAccessor — идентификатор записи точки монтирования, к которой относится пользователь |
Ответы
200: OK
GET /sys/loggers
ID операции: loggers-read-verbosity-level
Прочитать уровень логирования всех существующих логгеров.
Ответы
200: OK
POST /sys/loggers
ID операции: loggers-update-verbosity-level
Изменить уровень логирования всех существующих логгеров.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
level | string | нет | Уровень детализации логов. Поддерживаемые значения (по убыванию детализации): “trace”, “debug”, “info”, “warn” и “error”. |
Ответы
204: OK
DELETE /sys/loggers
ID операции: loggers-revert-verbosity-level
Вернуть всем логгерам уровень логирования, заданный в конфигурации.
Ответы
204: OK
GET /sys/loggers/{name}
ID операции: loggers-read-verbosity-level-for
Прочитать уровень логирования отдельного логгера.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя изменяемого логгера. |
Ответы
200: OK
POST /sys/loggers/{name}
ID операции: loggers-update-verbosity-level-for
Изменить уровень логирования отдельного логгера.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя изменяемого логгера. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
level | string | нет | Уровень детализации логов. Поддерживаемые значения (по убыванию детализации): “trace”, “debug”, “info”, “warn” и “error”. |
Ответы
204: OK
DELETE /sys/loggers/{name}
ID операции: loggers-revert-verbosity-level-for
Вернуть отдельному логгеру уровень логирования, заданный в конфигурации.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя изменяемого логгера. |
Ответы
204: OK
GET /sys/managed-keys/{type}
ID операции: system-list-managed-keys-type
Получить список настроенных управляемых ключей.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
type | string | path | да | Тип управляемого ключа. |
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
GET /sys/managed-keys/{type}/{name}
ID операции: system-read-managed-keys-type-name
Создание, обновление и чтение конфигураций управляемых ключей.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя управляемого ключа. |
type | string | path | да | Тип управляемого ключа. |
Ответы
200: OK
POST /sys/managed-keys/{type}/{name}
ID операции: system-write-managed-keys-type-name
Создание, обновление и чтение конфигураций управляемых ключей.
Поддерживается создание: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя управляемого ключа. |
type | string | path | да | Тип управляемого ключа. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
access_key | string | нет | Ключ доступа для аутентификации в AWS |
algorithm | string | нет | Алгоритм подписи для использования с этим ключом |
allow_generate_key | boolean | нет | Если true, пользователи ключа могут запускать генерацию ключа. Если false, а генерация требуется, операция завершится ошибкой. |
allow_replace_key | boolean | нет | Если true, пользователи ключа могут передавать материал ключа, заменяющий ранее существовавшие ключи. Значение allow_store_key=false отменяет это поведение. |
allow_store_key | boolean | нет | Если true, разрешает пользователям ключа предоставлять материал ключа, если он ранее отсутствовал. |
any_mount | boolean | нет | Если true, этот ключ доступен любой точке монтирования без указания его в поле allowed_manage_keys точки монтирования. |
client_id | string | нет | Идентификатор клиента (client ID) для вызова API Azure. |
client_secret | string | нет | Секрет клиента (client secret) для вызова API Azure. |
credentials | string | нет | Путь к файлу учетных данных GCP |
crypto_key | string | нет | Имя ключа в GCP Cloud KMS |
crypto_key_version | integer | нет | Версия существующего ключа в GCP Cloud KMS |
curve | string | нет | Для ключей ECDSA — требуемая эллиптическая кривая, если ключ должен быть сгенерирован: P256, P384 или P521. |
endpoint | string | нет | Используемая конечная точка AWS |
environment | string | нет | Используемые конечные точки API облачного окружения Azure. |
force_rw_session | boolean (default: False) | нет | Если true, на HSM принудительно используются сессии чтения/записи — обходное решение для некоторых HSM с ошибками. |
key-bits | integer | нет | Требуемая длина ключа в битах, если ключ RSA должен быть сгенерирован: 2048, 3072 или 4096. |
key_bits | integer | нет | Для ключей RSA — требуемая длина ключа в битах, если ключ должен быть сгенерирован: 2048, 3072 или 4096. |
key_id | string | нет | Идентификатор используемого ключа PKCS#11. Поскольку идентификаторы ключей создает HSM, если ключ еще не существует, возникает ошибка. Нужно указать это значение или key_label. |
key_label | string | нет | Метка используемого ключа PKCS#11. Если ключ не существует и генерация разрешена, эта метка присваивается сгенерированному ключу. Нужно указать это значение или key_id. |
key_name | string | нет | Имя ключа Azure Key Vault. |
key_ring | string | нет | Имя связки ключей в GCP Cloud KMS |
key_type | string | нет | Тип ключа Azure Key Vault. В настоящее время поддерживается только RSA-HSM. |
kms_key | string | нет | Идентификатор ключа AWS KMS. Если ключ уже существует, это может быть сгенерированный AWS идентификатор ключа или псевдоним. Если ключ должен быть сгенерирован и поле не пустое, указанное значение будет использовано для создания псевдонима ключа. |
kms_key_id | string | нет | [yandexcloudkms] Идентификатор ключа в Yandex Cloud KMS (симметричного или асимметричного). |
library | string | нет | Имя библиотеки доступа к управляемому ключу, как определено в конфигурации сервера Stronghold. |
max_parallel | integer | нет | Максимальное количество операций, одновременно отправляемых в HSM. |
mechanism | string | нет | Механизм для указанного ключа в виде строки с десятичным или шестнадцатеричным (с префиксом 0x) значением. |
oauth_token | string | нет | [yandexcloudkms] OAuth-токен для аутентификации в Yandex Cloud. Взаимоисключающий с service_account_key_json. |
pin | string | нет | PIN доступа к слоту. |
project | string | нет | Имя проекта GCP |
region | string | нет | Регион GCP, используемый для связки ключей |
resource | string | нет | DNS-суффикс ресурса Azure Key Vault для подключения. Требуется изменить для подключения к экземпляру Azure Managed HSM KeyVault. |
secret_key | string | нет | Идентификатор секретного ключа для аутентификации в AWS |
service_account_key_json | string | нет | [yandexcloudkms] JSON авторизованного ключа сервисного аккаунта Yandex Cloud. Хранится в Stronghold, а не в файловой системе. Несовместим с oauth_token. |
slot | string | нет | Номер используемого слота в виде строки (например, “0”). |
tenant_id | string | нет | Идентификатор арендатора (tenant ID) организации Azure Active Directory. |
token_label | string | нет | Метка токена используемого слота. |
usages | string | нет | Список разрешенных назначений этого ключа, разделенный запятыми. Допустимые значения: encrypt, decrypt, sign, verify, wrap, unwrap, mac и random. |
vault_name | string | нет | Имя существующего экземпляра Azure Key Vault. |
Ответы
200: OK
DELETE /sys/managed-keys/{type}/{name}
ID операции: system-delete-managed-keys-type-name
Создание, обновление и чтение конфигураций управляемых ключей.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя управляемого ключа. |
type | string | path | да | Тип управляемого ключа. |
Ответы
204: пустое тело
POST /sys/managed-keys/{type}/{name}/test/sign
ID операции: system-write-managed-keys-type-name-test-sign
Проверить управляемый ключ, подписав и проверив случайные данные.
Поддерживается создание: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя управляемого ключа. |
type | string | path | да | Тип управляемого ключа. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
hash_algorithm | string (default: sha2-256) | нет | Алгоритм хеширования для подписи/проверки случайных данных. Если не указан, для ключей ГОСТ PKCS#11 используется streebog-256 / streebog-512 в зависимости от механизма; в остальных случаях — sha2-256. |
use_pss | boolean (default: False) | нет | Для управляемых ключей на основе RSA — пытаться подписывать с использованием PSS. По умолчанию true для RSA-ключей Yandex Cloud KMS, которые поддерживают только подпись PSS. |
Ответы
200: OK
GET /sys/metrics
ID операции: metrics
Экспортировать метрики, агрегированные для телеметрии.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
format | string | query | нет | Формат экспорта метрик. Сейчас поддерживается только “prometheus”. |
Ответы
200: OK
GET /sys/mfa/method
ID операции: system-list-mfa-method
Выводит список всех доступных методов MFA по их именам.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
GET /sys/mfa/method/duo/{name}
ID операции: system-read-mfa-method-duo-name
Определяет или обновляет метод MFA Duo.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя метода MFA. |
Ответы
200: OK
POST /sys/mfa/method/duo/{name}
ID операции: system-write-mfa-method-duo-name
Определяет или обновляет метод MFA Duo.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя метода MFA. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
api_hostname | string | нет | Имя хоста API Duo. |
integration_key | string | нет | Ключ интеграции Duo. |
mount_accessor | string | нет | Точка монтирования, к которой привязывается этот метод для автоматических сопоставлений. В качестве имени пользователя в сопоставлении используется поле Name псевдонимов, связанных с этой точкой монтирования. |
push_info | string | нет | Информация для push-уведомления Duo. |
secret_key | string | нет | Секретный ключ Duo. |
use_passcode | boolean | нет | Если true, при проверке MFA пользователю напоминается о возможности использовать код доступа (passcode). Использование кода доступа не становится обязательным. По умолчанию false. |
username_format | string | нет | Строка формата для сопоставления имен Identity с именами методов MFA. Значения для подстановки следует помещать в {{}}. Например, “{{alias.name}}@example.com”. Поддерживаемые в настоящее время сопоставления: alias.name: имя, возвращаемое точкой монтирования, настроенным через параметр mount_accessor. Если пусто, поле name псевдонима будет использоваться как есть. |
Ответы
200: OK
DELETE /sys/mfa/method/duo/{name}
ID операции: system-delete-mfa-method-duo-name
Определяет или обновляет метод MFA Duo.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя метода MFA. |
Ответы
204: пустое тело
GET /sys/mfa/method/multifactor/{name}
ID операции: system-read-mfa-method-multifactor-name
Определяет или обновляет метод MFA Multifactor.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя метода MFA. |
Ответы
200: OK
POST /sys/mfa/method/multifactor/{name}
ID операции: system-write-mfa-method-multifactor-name
Определяет или обновляет метод MFA Multifactor.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя метода MFA. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
api_url | string | нет | Базовый URL API Multifactor. По умолчанию “https://api.multifactor.ru”. |
mount_accessor | string | нет | Точка монтирования, к которой привязывается этот метод для автоматических сопоставлений. В качестве имени пользователя в сопоставлении используется поле Name псевдонимов, связанных с этой точкой монтирования. |
nas_identifier | string | нет | NAS Identifier Multifactor из настроек ресурса. |
shared_secret | string | нет | Shared Secret Multifactor из настроек ресурса. |
timeout_seconds | integer | нет | Максимальное время ожидания подтверждения push-уведомления Multifactor в секундах. По умолчанию 90, минимум 65. |
username_format | string | нет | Строка формата для сопоставления имен Identity с идентификаторами пользователей Multifactor. Значения для подстановки следует помещать в {{}}. Например, “{{alias.name}}@example.com”. Поддерживаемые в настоящее время сопоставления: alias.name: имя, возвращаемое точкой монтирования, настроенным через параметр mount_accessor. Если пусто, поле name псевдонима будет использоваться как есть. |
Ответы
200: OK
DELETE /sys/mfa/method/multifactor/{name}
ID операции: system-delete-mfa-method-multifactor-name
Определяет или обновляет метод MFA Multifactor.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя метода MFA. |
Ответы
204: пустое тело
GET /sys/mfa/method/okta/{name}
ID операции: system-read-mfa-method-okta-name
Определяет или обновляет метод MFA Okta.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя метода MFA. |
Ответы
200: OK
POST /sys/mfa/method/okta/{name}
ID операции: system-write-mfa-method-okta-name
Определяет или обновляет метод MFA Okta.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя метода MFA. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
api_token | string | нет | Ключ API Okta. |
base_url | string | нет | Базовый домен API Okta. Если не указан в конфигурации, используется “okta.com”. |
mount_accessor | string | нет | Точка монтирования, к которой привязывается этот метод для автоматических сопоставлений. В качестве имени пользователя в сопоставлении используется поле Name псевдонимов, связанных с этой точкой монтирования. |
org_name | string | нет | Имя организации, используемое в API Okta. |
primary_email | boolean | нет | Если true, имя пользователя сопоставляется только с основным адресом электронной почты учетной записи. По умолчанию false. |
production | boolean | нет | (Устарело) Используйте вместо этого base_url. |
username_format | string | нет | Строка формата для сопоставления имен Identity с именами методов MFA. Значения для подстановки следует помещать в {{}}. Например, “{{alias.name}}@example.com”. Поддерживаемые в настоящее время сопоставления: alias.name: имя, возвращаемое точкой монтирования, настроенным через параметр mount_accessor. Если пусто, поле name псевдонима будет использоваться как есть. |
Ответы
200: OK
DELETE /sys/mfa/method/okta/{name}
ID операции: system-delete-mfa-method-okta-name
Определяет или обновляет метод MFA Okta.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя метода MFA. |
Ответы
204: пустое тело
GET /sys/mfa/method/pingid/{name}
ID операции: system-read-mfa-method-pingid-name
Определяет или обновляет метод MFA PingID.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя метода MFA. |
Ответы
200: OK
POST /sys/mfa/method/pingid/{name}
ID операции: system-write-mfa-method-pingid-name
Определяет или обновляет метод MFA PingID.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя метода MFA. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
mount_accessor | string | нет | Точка монтирования, к которой привязывается этот метод для автоматических сопоставлений. В качестве имени пользователя в сопоставлении используется поле Name псевдонимов, связанных с этой точкой монтирования. |
settings_file_base64 | string | нет | Файл настроек от Ping в кодировке Base64. Должен быть файлом настроек для сторонних клиентов, а не для PingID SDK или PingFederate. |
username_format | string | нет | Строка формата для сопоставления имен Identity с именами методов MFA. Значения для подстановки следует помещать в {{}}. Например, “{{alias.name}}@example.com”. Поддерживаемые в настоящее время сопоставления: alias.name: имя, возвращаемое точкой монтирования, настроенным через параметр mount_accessor. Если пусто, поле name псевдонима будет использоваться как есть. |
Ответы
200: OK
DELETE /sys/mfa/method/pingid/{name}
ID операции: system-delete-mfa-method-pingid-name
Определяет или обновляет метод MFA PingID.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя метода MFA. |
Ответы
204: пустое тело
GET /sys/mfa/method/totp/{name}
ID операции: system-read-mfa-method-totp-name
Определяет или обновляет метод MFA TOTP.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя метода MFA. |
Ответы
200: OK
POST /sys/mfa/method/totp/{name}
ID операции: system-write-mfa-method-totp-name
Определяет или обновляет метод MFA TOTP.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя метода MFA. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
algorithm | string (default: SHA1) | нет | Алгоритм хеширования для генерации TOTP-кода. Возможные значения: SHA1, SHA256 и SHA512. |
digits | integer (default: 6) | нет | Количество цифр в генерируемом TOTP-коде: 6 или 8. |
issuer | string | нет | Название организации, выдавшей ключ. |
key_size | integer (default: 20) | нет | Размер генерируемого ключа в байтах. |
max_validation_attempts | integer | нет | Максимальное количество допустимых попыток проверки. |
period | integer (default: 30) | нет | Длительность интервала, используемого для вычисления счетчика при расчете TOTP-кода. |
qr_size | integer (default: 200) | нет | Размер генерируемого квадратного QR-кода в пикселях. |
skew | integer (default: 1) | нет | Количество периодов задержки, допустимых при проверке TOTP-кода: 0 или 1. |
Ответы
200: OK
DELETE /sys/mfa/method/totp/{name}
ID операции: system-delete-mfa-method-totp-name
Определяет или обновляет метод MFA TOTP.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя метода MFA. |
Ответы
204: пустое тело
POST /sys/mfa/method/totp/{name}/admin-destroy
ID операции: system-write-mfa-method-totp-name-admin-destroy
Удаляет TOTP-секрет для указанного имени метода у указанной сущности.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя метода MFA. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
entity_id | string | нет | Идентификатор сущности, у которой нужно удалить секрет метода MFA. |
Ответы
200: OK
POST /sys/mfa/method/totp/{name}/admin-generate
ID операции: system-write-mfa-method-totp-name-admin-generate
Генерирует TOTP-секрет для указанного имени метода у указанной сущности.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя метода MFA. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
entity_id | string | нет | Идентификатор сущности, для которой сохраняется сгенерированный секрет. |
Ответы
200: OK
GET /sys/mfa/method/totp/{name}/generate
ID операции: system-read-mfa-method-totp-name-generate
Генерирует TOTP-секрет для указанного имени метода у сущности вызывающего токена.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя метода MFA. |
Ответы
200: OK
POST /sys/mfa/validate
ID операции: mfa-validate
Проверяет вход по указанным методам MFA. При успешной проверке возвращает ответ аутентификации с клиентским токеном
Доступен без аутентификации: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
mfa_payload | object | да | Карта, сопоставляющая идентификатору метода MFA массив кодов доступа (passcodes), или пустой массив, если метод не использует коды доступа |
mfa_request_id | string | да | Идентификатор этого запроса MFA |
Ответы
200: OK
GET /sys/monitor
ID операции: monitor
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
log_format | string | query | нет | Формат вывода логов. Поддерживаемые значения: “standard” и “json”. По умолчанию “standard”. |
log_level | string | query | нет | Уровень логирования для просмотра системных логов. Поддерживаемые значения: “trace”, “debug”, “info”, “warn”, “error”. |
Ответы
200: OK
GET /sys/mounts
ID операции: mounts-list-secrets-engines
Выводит список смонтированных бэкендов.
Ответы
200: OK
GET /sys/mounts/{path}
ID операции: mounts-read-configuration
Прочитать конфигурацию механизма секретов по указанному пути.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Путь монтирования. Пример: “aws/east” |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
accessor | string | нет | |
config | object | нет | Конфигурация этой точки монтирования, например default_lease_ttl и max_lease_ttl. |
deprecation_status | string | нет | |
description | string | нет | Понятное описание этой точки монтирования. |
external_entropy_access | boolean | нет | |
local | boolean (default: False) | нет | Пометить точку монтирования как локальную: она не реплицируется и не затрагивается репликацией. |
options | object | нет | Параметры, передаваемые в бэкенд: JSON-объект со строковыми ключами и значениями. |
plugin_version | string | нет | Используемая семантическая версия плагина. |
running_plugin_version | string | нет | |
running_sha256 | string | нет | |
seal_wrap | boolean (default: False) | нет | Включить ли для точки монтирования seal wrapping. |
type | string | нет | Тип бэкенда. Пример: “passthrough” |
uuid | string | нет |
POST /sys/mounts/{path}
ID операции: mounts-enable-secrets-engine
Включить новый механизм секретов по указанному пути.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Путь монтирования. Пример: “aws/east” |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
config | object | нет | Конфигурация этой точки монтирования, например default_lease_ttl и max_lease_ttl. |
description | string | нет | Понятное описание этой точки монтирования. |
external_entropy_access | boolean (default: False) | нет | Предоставить ли точке монтирования доступ к внешнему источнику энтропии Stronghold. |
local | boolean (default: False) | нет | Пометить точку монтирования как локальную: она не реплицируется и не затрагивается репликацией. |
options | object | нет | Параметры, передаваемые в бэкенд: JSON-объект со строковыми ключами и значениями. |
plugin_name | string | нет | Имя монтируемого плагина, зарегистрированное в каталоге плагинов. |
plugin_version | string | нет | Используемая семантическая версия плагина. |
seal_wrap | boolean (default: False) | нет | Включить ли для точки монтирования seal wrapping. |
type | string | нет | Тип бэкенда. Пример: “passthrough” |
Ответы
204: OK
DELETE /sys/mounts/{path}
ID операции: mounts-disable-secrets-engine
Отключить точку монтирования по указанному пути.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Путь монтирования. Пример: “aws/east” |
Ответы
200: OK
GET /sys/mounts/{path}/tune
ID операции: mounts-read-tuning-information
Настраивает параметры бэкенда для этой точки монтирования.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Путь монтирования. Пример: “aws/east” |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
allowed_managed_keys | array | нет | |
allowed_response_headers | array | нет | Список разрешенных заголовков, которые плагин может устанавливать в ответах. |
audit_non_hmac_request_keys | array | нет | |
audit_non_hmac_response_keys | array | нет | |
default_lease_ttl | integer | нет | TTL аренды по умолчанию для этой точки монтирования. |
description | string | нет | Понятное описание этого бэкенда учетных данных. |
external_entropy_access | boolean | нет | |
force_no_cache | boolean | нет | |
listing_visibility | string | нет | |
max_lease_ttl | integer | нет | Максимальный TTL аренды для этой точки монтирования. |
options | object | нет | Параметры, передаваемые в бэкенд: JSON-объект со строковыми ключами и значениями. |
passthrough_request_headers | array | нет | |
plugin_version | string | нет | Используемая семантическая версия плагина. |
replication_config | object | нет | Конфигурация репликации KV. |
token_type | string | нет | Тип выдаваемого токена (service или batch). |
user_lockout_counter_reset_duration | integer | нет | |
user_lockout_disable | boolean | нет | |
user_lockout_duration | integer | нет | |
user_lockout_threshold | integer | нет |
POST /sys/mounts/{path}/tune
ID операции: mounts-tune-configuration-parameters
Настраивает параметры бэкенда для этой точки монтирования.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Путь монтирования. Пример: “aws/east” |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
allowed_managed_keys | array | нет | |
allowed_response_headers | array | нет | Список разрешенных заголовков, которые плагин может устанавливать в ответах. |
audit_non_hmac_request_keys | array | нет | Список ключей в объекте данных запроса, которые устройства аудита не будут хешировать с помощью HMAC. |
audit_non_hmac_response_keys | array | нет | Список ключей в объекте данных ответа, которые устройства аудита не будут хешировать с помощью HMAC. |
cmd_enable_repl | boolean | нет | Включить или отключить репликацию для этой точки монтирования. |
default_lease_ttl | string | нет | TTL аренды по умолчанию для этой точки монтирования. |
description | string | нет | Понятное описание этого бэкенда учетных данных. |
listing_visibility | string | нет | Видимость точки монтирования в конечной точке списка для UI. Допустимые значения: ‘unauth’ и ‘hidden’; пустое значение по умолчанию (’’) равнозначно ‘hidden’. |
max_lease_ttl | string | нет | Максимальный TTL аренды для этой точки монтирования. |
options | object | нет | Параметры, передаваемые в бэкенд: JSON-объект со строковыми ключами и значениями. |
passthrough_request_headers | array | нет | Список разрешенных заголовков, которые передаются из запроса в плагин. |
plugin_version | string | нет | Используемая семантическая версия плагина. |
src_address | string | нет | Адрес исходного кластера Stronghold для репликации. |
src_ca_cert | string | нет | Сертификат CA для TLS-соединения с исходным кластером. |
src_mount_path | string | нет | Путь монтирования механизма KV в исходном кластере. |
src_secret_path | array | нет | Список путей секретов для репликации из исходного кластера. |
src_token | string | нет | Токен для доступа к API удаленного сервера. Несовместим с src_wrapping_token. |
src_wrapping_token | string | нет | Оборачивающий токен (wrapping token), который разворачивается на удаленном сервере для получения токена репликации. Несовместим с src_token. |
sync_period_min | integer | нет | Период синхронизации репликации в минутах. |
token_type | string | нет | Тип выдаваемого токена (service или batch). |
user_lockout_config | object | нет | Конфигурация блокировки пользователей, передаваемая в бэкенд: JSON-объект со строковыми ключами и значениями. |
Ответы
200: OK
GET /sys/namespaces
ID операции: system-list-namespaces
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
POST /sys/namespaces/api-lock/lock
ID операции: system-write-namespaces-api-lock-lock
Заблокировать API для пространства имен и его потомков
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
path | string | нет | Необязательный относительный путь для блокировки потомков текущего пространства имен. |
Ответы
200: OK
POST /sys/namespaces/api-lock/lock/{path}
ID операции: system-write-namespaces-api-lock-lock-path
Заблокировать API для пространства имен и его потомков
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Необязательный относительный путь для блокировки потомков текущего пространства имен. |
Ответы
200: OK
POST /sys/namespaces/api-lock/unlock
ID операции: system-write-namespaces-api-lock-unlock
Разблокировать API для пространства имен и его потомков
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
path | string | нет | Необязательный относительный путь для разблокировки потомков текущего пространства имен. |
unlock_key | string | нет | Ключ для разблокировки пространства имен. |
Ответы
200: OK
POST /sys/namespaces/api-lock/unlock/{path}
ID операции: system-write-namespaces-api-lock-unlock-path
Разблокировать API для пространства имен и его потомков
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Необязательный относительный путь для разблокировки потомков текущего пространства имен. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
unlock_key | string | нет | Ключ для разблокировки пространства имен. |
Ответы
200: OK
GET /sys/namespaces/{path}
ID операции: system-read-namespaces-path
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Путь пространства имен. |
Ответы
200: OK
POST /sys/namespaces/{path}
ID операции: system-write-namespaces-path
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Путь пространства имен. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
custom_metadata | object | нет | Пользовательские пары ключ-значение для описания произвольной информации о пространстве имен. |
Ответы
200: OK
DELETE /sys/namespaces/{path}
ID операции: system-delete-namespaces-path
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Путь пространства имен. |
Ответы
204: пустое тело
GET /sys/plugins/catalog
ID операции: plugins-catalog-list-plugins
Выводит список всех плагинов, известных Stronghold
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
detailed | object | нет |
GET /sys/plugins/catalog/{name}
ID операции: plugins-catalog-read-plugin-configuration
Возвращает конфигурацию плагина с указанным именем.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя плагина |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
args | array | нет | Аргументы, передаваемые команде плагина. |
builtin | boolean | нет | |
command | string | нет | Команда запуска плагина. Исполняемый файл, указанный в этой команде, должен находиться в каталоге плагинов Stronghold. |
deprecation_status | string | нет | |
name | string | нет | Имя плагина |
sha256 | string | нет | Контрольная сумма SHA256 исполняемого файла из поля command в шестнадцатеричном (HEX) виде. |
version | string | нет | Используемая семантическая версия плагина. |
POST /sys/plugins/catalog/{name}
ID операции: plugins-catalog-register-plugin
Регистрирует новый плагин или обновляет существующий с указанным именем.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя плагина |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
args | array | нет | Аргументы, передаваемые команде плагина. |
command | string | нет | Команда запуска плагина. Исполняемый файл, указанный в этой команде, должен находиться в каталоге плагинов Stronghold. |
env | array | нет | Переменные окружения, передаваемые команде плагина. Каждый элемент имеет вид “key=value”. |
sha256 | string | нет | Контрольная сумма SHA256 исполняемого файла из поля command в шестнадцатеричном (HEX) виде. |
type | string | нет | Тип плагина: auth, secret или database |
version | string | нет | Используемая семантическая версия плагина. |
Ответы
200: OK
DELETE /sys/plugins/catalog/{name}
ID операции: plugins-catalog-remove-plugin
Удалить плагин с указанным именем.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя плагина |
Ответы
200: OK
GET /sys/plugins/catalog/{type}
ID операции: plugins-catalog-list-plugins-with-type
Получить список плагинов в каталоге.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
type | string | path | да | Тип плагина: auth, secret или database |
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
keys | array | нет | Список имен плагинов в каталоге |
GET /sys/plugins/catalog/{type}/{name}
ID операции: plugins-catalog-read-plugin-configuration-with-type
Возвращает конфигурацию плагина с указанным именем.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя плагина |
type | string | path | да | Тип плагина: auth, secret или database |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
args | array | нет | Аргументы, передаваемые команде плагина. |
builtin | boolean | нет | |
command | string | нет | Команда запуска плагина. Исполняемый файл, указанный в этой команде, должен находиться в каталоге плагинов Stronghold. |
deprecation_status | string | нет | |
name | string | нет | Имя плагина |
sha256 | string | нет | Контрольная сумма SHA256 исполняемого файла из поля command в шестнадцатеричном (HEX) виде. |
version | string | нет | Используемая семантическая версия плагина. |
POST /sys/plugins/catalog/{type}/{name}
ID операции: plugins-catalog-register-plugin-with-type
Регистрирует новый плагин или обновляет существующий с указанным именем.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя плагина |
type | string | path | да | Тип плагина: auth, secret или database |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
args | array | нет | Аргументы, передаваемые команде плагина. |
command | string | нет | Команда запуска плагина. Исполняемый файл, указанный в этой команде, должен находиться в каталоге плагинов Stronghold. |
env | array | нет | Переменные окружения, передаваемые команде плагина. Каждый элемент имеет вид “key=value”. |
sha256 | string | нет | Контрольная сумма SHA256 исполняемого файла из поля command в шестнадцатеричном (HEX) виде. |
version | string | нет | Используемая семантическая версия плагина. |
Ответы
200: OK
DELETE /sys/plugins/catalog/{type}/{name}
ID операции: plugins-catalog-remove-plugin-with-type
Удалить плагин с указанным именем.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя плагина |
type | string | path | да | Тип плагина: auth, secret или database |
Ответы
200: OK
POST /sys/plugins/reload/backend
ID операции: plugins-reload-backends
Перезагрузить смонтированные бэкенды плагинов.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
mounts | array | нет | Пути монтирования бэкендов плагинов, которые нужно перезагрузить. |
plugin | string | нет | Имя перезагружаемого плагина, зарегистрированное в каталоге плагинов. |
scope | string | нет |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
reload_id | string | нет |
202: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
reload_id | string | нет |
GET /sys/plugins/reload/backend/status
ID операции: system-read-plugins-reload-backend-status
Получить статус перезагрузки в масштабе кластера.
Ответы
200: OK
GET /sys/policies/acl
ID операции: policies-list-acl-policies
Получить список настроенных политик управления доступом.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
keys | array | нет | |
policies | array | нет |
GET /sys/policies/acl/{name}
ID операции: policies-read-acl-policy
Получить информацию об именованной ACL-политике.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя политики. Пример: “ops” |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
name | string | нет | |
policy | string | нет | |
rules | string | нет |
POST /sys/policies/acl/{name}
ID операции: policies-write-acl-policy
Создать новую или обновить существующую ACL-политику.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя политики. Пример: “ops” |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
policy | string | нет | Правила политики. |
Ответы
204: OK
DELETE /sys/policies/acl/{name}
ID операции: policies-delete-acl-policy
Удалить ACL-политику с указанным именем.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя политики. Пример: “ops” |
Ответы
204: OK
GET /sys/policies/egp
ID операции: system-list-policies-egp
Получить список настроенных политик управления доступом.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
GET /sys/policies/egp/{name}
ID операции: system-read-policies-egp-name
Прочитать, изменить или удалить политику управления доступом.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя политики. Пример: “ops” |
Ответы
200: OK
POST /sys/policies/egp/{name}
ID операции: system-write-policies-egp-name
Прочитать, изменить или удалить политику управления доступом.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя политики. Пример: “ops” |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
enforcement_level | string | нет | Уровень применения, устанавливаемый для политики. |
paths | array | нет | Пути, к которым должна применяться политика. |
policy | string | нет | Правила политики. |
Ответы
200: OK
DELETE /sys/policies/egp/{name}
ID операции: system-delete-policies-egp-name
Прочитать, изменить или удалить политику управления доступом.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя политики. Пример: “ops” |
Ответы
204: пустое тело
GET /sys/policies/password
ID операции: policies-list-password-policies
Получить список существующих политик паролей.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
keys | array | нет |
GET /sys/policies/password/{name}
ID операции: policies-read-password-policy
Получить существующую политику паролей.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя политики паролей. |
Ответы
204: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
policy | string | нет |
POST /sys/policies/password/{name}
ID операции: policies-write-password-policy
Создать новую или обновить существующую политику паролей.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя политики паролей. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
policy | string | нет | Политика паролей |
Ответы
204: OK
DELETE /sys/policies/password/{name}
ID операции: policies-delete-password-policy
Удалить политику паролей.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя политики паролей. |
Ответы
204: OK
GET /sys/policies/password/{name}/generate
ID операции: policies-generate-password-from-password-policy
Сгенерировать пароль по существующей политике паролей.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя политики паролей. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
password | string | нет |
GET /sys/policies/rgp
ID операции: system-list-policies-rgp
Получить список настроенных политик управления доступом.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
GET /sys/policies/rgp/{name}
ID операции: system-read-policies-rgp-name
Прочитать, изменить или удалить политику управления доступом.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя политики. Пример: “ops” |
Ответы
200: OK
POST /sys/policies/rgp/{name}
ID операции: system-write-policies-rgp-name
Прочитать, изменить или удалить политику управления доступом.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя политики. Пример: “ops” |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
enforcement_level | string | нет | Уровень применения, устанавливаемый для политики. |
policy | string | нет | Правила политики. |
Ответы
200: OK
DELETE /sys/policies/rgp/{name}
ID операции: system-delete-policies-rgp-name
Прочитать, изменить или удалить политику управления доступом.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя политики. Пример: “ops” |
Ответы
204: пустое тело
GET /sys/policy
ID операции: policies-list
Получить список настроенных политик управления доступом.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
list | string | query | нет | Вернуть список, если true |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
keys | array | нет | |
policies | array | нет |
GET /sys/policy/{name}
ID операции: policies-read-acl-policy2
Получить тело именованной политики.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя политики. Пример: “ops” |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
name | string | нет | |
policy | string | нет | |
rules | string | нет |
POST /sys/policy/{name}
ID операции: policies-write-acl-policy2
Создать новую или обновить существующую политику.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя политики. Пример: “ops” |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
policy | string | нет | Правила политики. |
rules | string | нет | ⚠️ Устарело. Правила политики. |
Ответы
204: OK
DELETE /sys/policy/{name}
ID операции: policies-delete-acl-policy2
Удалить политику с указанным именем.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя политики. Пример: “ops” |
Ответы
204: OK
GET /sys/pprof
ID операции: pprof-index
Возвращает HTML-страницу со списком доступных профилей.
Ответы
200: OK
GET /sys/pprof/allocs
ID операции: pprof-memory-allocations
Возвращает выборку всех выделений памяти за время работы.
Ответы
200: OK
GET /sys/pprof/block
ID операции: pprof-blocking
Возвращает трассировки стека, которые привели к блокировке на примитивах синхронизации
Ответы
200: OK
GET /sys/pprof/cmdline
ID операции: pprof-command-line
Возвращает командную строку запущенной программы.
Ответы
200: OK
GET /sys/pprof/goroutine
ID операции: pprof-goroutines
Возвращает трассировки стека всех текущих горутин.
Ответы
200: OK
GET /sys/pprof/heap
ID операции: pprof-memory-allocations-live
Возвращает выборку выделений памяти для живых объектов.
Ответы
200: OK
GET /sys/pprof/mutex
ID операции: pprof-mutexes
Возвращает трассировки стека владельцев мьютексов, за которые идет конкуренция
Ответы
200: OK
GET /sys/pprof/profile
ID операции: pprof-cpu-profile
Возвращает CPU-профиль в формате pprof.
Ответы
200: OK
GET /sys/pprof/symbol
ID операции: pprof-symbols
Возвращает значения программных счетчиков, указанных в запросе.
Ответы
200: OK
GET /sys/pprof/threadcreate
ID операции: pprof-thread-creations
Возвращает трассировки стека, которые привели к созданию новых потоков ОС
Ответы
200: OK
GET /sys/pprof/trace
ID операции: pprof-execution-trace
Возвращает трассировку выполнения в двоичном виде.
Ответы
200: OK
GET /sys/quotas/config
ID операции: rate-limit-quotas-read-configuration
Создание, обновление и чтение конфигурации квот.
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
enable_rate_limit_audit_logging | boolean | нет | |
enable_rate_limit_response_headers | boolean | нет | |
rate_limit_exempt_paths | array | нет |
POST /sys/quotas/config
ID операции: rate-limit-quotas-configure
Создание, обновление и чтение конфигурации квот.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
enable_rate_limit_audit_logging | boolean | нет | Если задан, включает запись в журнал аудита запросов, отклоненных из-за нарушения правил квот на ограничение частоты запросов. |
enable_rate_limit_response_headers | boolean | нет | Если задан, в ответы добавляются дополнительные HTTP-заголовки квот на ограничение частоты запросов. |
rate_limit_exempt_paths | array | нет | Список путей, на которые не распространяются квоты на ограничение частоты запросов. Если пусто, исключений нет. |
Ответы
204: OK
GET /sys/quotas/lease-count
ID операции: system-list-quotas-lease-count
Выводит имена всех квот на количество аренд.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
GET /sys/quotas/lease-count/{name}
ID операции: system-read-quotas-lease-count-name
Получить, создать или обновить квоту на количество аренд для пространства имен или точки монтирования (необязательно).
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя правила квоты. |
Ответы
200: OK
POST /sys/quotas/lease-count/{name}
ID операции: system-write-quotas-lease-count-name
Получить, создать или обновить квоту на количество аренд для пространства имен или точки монтирования (необязательно).
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя правила квоты. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
max_leases | integer | нет | Максимальное количество аренд, разрешенное правилом квоты. |
path | string | нет | Путь, включая соответствующий префикс пространства имен. |
role | string | нет | Роль входа, к которой применяется эта квота. Если задана, path должен указывать на метод аутентификации, поддерживающий роли. |
type | string | нет | Тип правила квоты. |
Ответы
200: OK
DELETE /sys/quotas/lease-count/{name}
ID операции: system-delete-quotas-lease-count-name
Получить, создать или обновить квоту на количество аренд для пространства имен или точки монтирования (необязательно).
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя правила квоты. |
Ответы
204: пустое тело
GET /sys/quotas/rate-limit
ID операции: rate-limit-quotas-list
Выводит имена всех квот на ограничение частоты запросов.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
keys | array | нет |
GET /sys/quotas/rate-limit/{name}
ID операции: rate-limit-quotas-read
Получить, создать или обновить квоту на ограничение частоты запросов для пространства имен или точки монтирования (необязательно).
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя правила квоты. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
block_interval | integer | нет | |
interval | integer | нет | |
name | string | нет | |
path | string | нет | |
rate | number | нет | |
role | string | нет | |
type | string | нет |
POST /sys/quotas/rate-limit/{name}
ID операции: rate-limit-quotas-write
Получить, создать или обновить квоту на ограничение частоты запросов для пространства имен или точки монтирования (необязательно).
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя правила квоты. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
block_interval | integer | нет | Если задан, клиент, достигший порога ограничения частоты, не сможет выполнять запросы, пока не истечет ‘block_interval’. |
interval | integer | нет | Интервал, в рамках которого действует ограничение частоты (по умолчанию ‘1s’). |
path | string | нет | Путь точки монтирования или пространства имен, к которому применяется квота. Пустой путь задает глобальную квоту. Например, namespace1/ добавляет квоту на все пространство имен, namespace1/auth/userpass — на userpass в namespace1. |
rate | number | нет | Максимальное количество запросов за интервал, разрешенное правилом квоты. Значение ‘rate’ должно быть положительным. |
role | string | нет | Роль входа, к которой применяется эта квота. Если задана, path должен указывать на метод аутентификации, поддерживающий роли. |
type | string | нет | Тип правила квоты. |
Ответы
204: No Content
DELETE /sys/quotas/rate-limit/{name}
ID операции: rate-limit-quotas-delete
Получить, создать или обновить квоту на ограничение частоты запросов для пространства имен или точки монтирования (необязательно).
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя правила квоты. |
Ответы
204: OK
GET /sys/rekey-recovery-key/init
ID операции: rekey-recovery-key-attempt-read-progress
Читает конфигурацию и ход текущей попытки смены ключей восстановления.
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
backup | boolean | нет | |
n | integer | нет | |
nonce | string | нет | |
pgp_fingerprints | array | нет | |
progress | integer | нет | |
required | integer | нет | |
started | boolean | нет | |
t | integer | нет | |
verification_nonce | string | нет | |
verification_required | boolean | нет |
POST /sys/rekey-recovery-key/init
ID операции: rekey-recovery-key-attempt-initialize
Запускает новую попытку смены ключей восстановления.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
backup | boolean | нет | При использовании ключей, зашифрованных PGP, определяет, должен ли Stronghold дополнительно сохранять резервную копию этих зашифрованных ключей. |
pgp_keys | array | нет | Массив открытых ключей PGP для шифрования выдаваемых ключей восстановления. |
require_verification | boolean | нет | Включает проверку новых ключей |
secret_shares | integer | нет | Количество долей, на которые делится ключ восстановления. |
secret_threshold | integer | нет | Количество долей, необходимых для восстановления ключа восстановления. |
stored_shares | integer | нет | Количество долей, которые шифруются HSM и сохраняются для автоматического распечатывания. Сейчас должно совпадать с secret_shares. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
backup | boolean | нет | |
n | integer | нет | |
nonce | string | нет | |
pgp_fingerprints | array | нет | |
progress | integer | нет | |
required | integer | нет | |
started | boolean | нет | |
t | integer | нет | |
verification_nonce | string | нет | |
verification_required | boolean | нет |
DELETE /sys/rekey-recovery-key/init
ID операции: rekey-recovery-key-attempt-cancel
Отменяет текущую смену ключей восстановления.
Ответы
200: OK
POST /sys/rekey-recovery-key/update
ID операции: rekey-recovery-key-attempt-update
Ввести одну долю ключа восстановления, чтобы продвинуть смену ключей Stronghold.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
key | string | нет | Одна доля ключа восстановления. |
nonce | string | нет | Nonce попытки смены ключей. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
backup | boolean | нет | |
complete | boolean | нет | |
keys | array | нет | |
keys_base64 | array | нет | |
nonce | string | нет | |
pgp_fingerprints | array | нет | |
verification_nonce | string | нет | |
verification_required | boolean | нет |
GET /sys/rekey-recovery-key/verify
ID операции: rekey-recovery-key-verification-read-progress
Прочитать конфигурацию и ход текущей проверки смены ключей восстановления.
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
n | integer | нет | |
nonce | string | нет | |
progress | integer | нет | |
started | boolean | нет | |
t | integer | нет |
POST /sys/rekey-recovery-key/verify
ID операции: rekey-recovery-key-verification-update
Ввести одну долю нового ключа восстановления, чтобы продвинуть проверку смены ключей.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
key | string | нет | Одна доля ключа восстановления из нового набора долей. |
nonce | string | нет | Nonce операции проверки смены ключей. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
complete | boolean | нет | |
nonce | string | нет |
DELETE /sys/rekey-recovery-key/verify
ID операции: rekey-recovery-key-verification-cancel
Отменить текущую проверку смены ключей восстановления.
Ответы
200: OK
GET /sys/rekey/backup
ID операции: rekey-read-backup-key
Возвращает резервную копию ключей распечатывания, зашифрованных PGP.
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
keys | object | нет | |
keys_base64 | object | нет | |
nonce | string | нет |
DELETE /sys/rekey/backup
ID операции: rekey-delete-backup-key
Удалить резервную копию ключей распечатывания, зашифрованных PGP.
Ответы
204: OK
GET /sys/rekey/init
ID операции: rekey-attempt-read-progress
Читает конфигурацию и ход текущей попытки смены ключей (rekey).
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
backup | boolean | нет | |
n | integer | нет | |
nonce | string | нет | |
pgp_fingerprints | array | нет | |
progress | integer | нет | |
required | integer | нет | |
started | boolean | нет | |
t | integer | нет | |
verification_nonce | string | нет | |
verification_required | boolean | нет |
POST /sys/rekey/init
ID операции: rekey-attempt-initialize
Запускает новую попытку смены ключей (rekey).
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
backup | boolean | нет | При использовании ключей, зашифрованных PGP, определяет, должен ли Stronghold дополнительно сохранять резервную копию этих зашифрованных ключей. |
nonce | string | нет | Nonce операции смены ключей. Если смена ключей была запущена в течение последних 10 минут, для отмены операции необходимо указать nonce. |
pgp_keys | array | нет | Массив открытых ключей PGP для шифрования выдаваемых ключей распечатывания. Порядок сохраняется. Ключи должны быть представлены в base64 (из исходного двоичного вида). Размер массива должен совпадать с secret_shares. |
require_verification | boolean | нет | Включает проверку новых ключей |
secret_shares | integer | нет | Количество долей, на которые делится ключ распечатывания. |
secret_threshold | integer | нет | Количество долей, необходимых для восстановления ключа распечатывания. Должно быть меньше или равно secret_shares. При использовании Stronghold HSM с автоматическим распечатыванием должно совпадать с secret_shares. |
stored_shares | integer | нет | Количество долей, которые шифруются HSM и сохраняются для автоматического распечатывания. Сейчас должно совпадать с secret_shares. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
backup | boolean | нет | |
n | integer | нет | |
nonce | string | нет | |
pgp_fingerprints | array | нет | |
progress | integer | нет | |
required | integer | нет | |
started | boolean | нет | |
t | integer | нет | |
verification_nonce | string | нет | |
verification_required | boolean | нет |
DELETE /sys/rekey/init
ID операции: rekey-attempt-cancel
Отменяет текущую смену ключей (rekey).
Ответы
200: OK
GET /sys/rekey/recovery-key-backup
ID операции: rekey-read-backup-recovery-key
Позволяет получить или удалить резервную копию ключей распечатывания после смены.
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
keys | object | нет | |
keys_base64 | object | нет | |
nonce | string | нет |
DELETE /sys/rekey/recovery-key-backup
ID операции: rekey-delete-backup-recovery-key
Позволяет получить или удалить резервную копию ключей распечатывания после смены.
Ответы
204: OK
POST /sys/rekey/update
ID операции: rekey-attempt-update
Ввести одну долю ключа распечатывания, чтобы продвинуть смену ключей Stronghold.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
key | string | нет | Одна доля ключа распечатывания. |
nonce | string | нет | Nonce попытки смены ключей. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
backup | boolean | нет | |
complete | boolean | нет | |
keys | array | нет | |
keys_base64 | array | нет | |
n | integer | нет | |
nounce | string | нет | |
pgp_fingerprints | array | нет | |
progress | integer | нет | |
required | integer | нет | |
started | string | нет | |
t | integer | нет | |
verification_nonce | string | нет | |
verification_required | boolean | нет |
GET /sys/rekey/verify
ID операции: rekey-verification-read-progress
Прочитать конфигурацию и ход текущей проверки смены ключей.
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
n | integer | нет | |
nounce | string | нет | |
progress | integer | нет | |
started | string | нет | |
t | integer | нет |
POST /sys/rekey/verify
ID операции: rekey-verification-update
Ввести одну долю нового ключа, чтобы продвинуть проверку смены ключей.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
key | string | нет | Одна доля ключа распечатывания из нового набора долей. |
nonce | string | нет | Nonce операции проверки смены ключей. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
complete | boolean | нет | |
nounce | string | нет |
DELETE /sys/rekey/verify
ID операции: rekey-verification-cancel
Отменить текущую проверку смены ключей.
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
n | integer | нет | |
nounce | string | нет | |
progress | integer | нет | |
started | string | нет | |
t | integer | нет |
POST /sys/remount
ID операции: remount
Запустить перенос точки монтирования
Требует sudo: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
from | string | нет | Предыдущая точка монтирования. |
to | string | нет | Новая точка монтирования. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
migration_id | string | нет |
GET /sys/remount/status/{migration_id}
ID операции: remount-status
Проверить статус переноса точки монтирования
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
migration_id | string | path | да | Идентификатор операции переноса |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
migration_id | string | нет | |
migration_info | object | нет |
POST /sys/renew
ID операции: leases-renew-lease2
Продлевает аренду, запрашивая увеличение ее срока.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
increment | integer | нет | Желаемое увеличение срока аренды в секундах |
lease_id | string | нет | Идентификатор продлеваемой аренды. Возвращается вместе с арендой. |
url_lease_id | string | нет | Идентификатор продлеваемой аренды. Возвращается вместе с арендой. |
Ответы
204: OK
POST /sys/renew/{url_lease_id}
ID операции: leases-renew-lease-with-id2
Продлевает аренду, запрашивая увеличение ее срока.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
url_lease_id | string | path | да | Идентификатор продлеваемой аренды. Возвращается вместе с арендой. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
increment | integer | нет | Желаемое увеличение срока аренды в секундах |
lease_id | string | нет | Идентификатор продлеваемой аренды. Возвращается вместе с арендой. |
Ответы
204: OK
POST /sys/replication/dr/primary/demote
ID операции: system-write-replication-dr-primary-demote
Ответы
200: OK
POST /sys/replication/dr/primary/disable
ID операции: system-write-replication-dr-primary-disable
Ответы
200: OK
POST /sys/replication/dr/primary/enable
ID операции: system-write-replication-dr-primary-enable
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
primary_cluster_addr | string | нет | Адрес, к которому должен подключаться вторичный кластер. По умолчанию — кластерный адрес основного кластера. |
Ответы
200: OK
POST /sys/replication/dr/primary/revoke-secondary
ID операции: system-write-replication-dr-primary-revoke-secondary
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
id | string | нет | Идентификатор отзываемого вторичного кластера |
Ответы
200: OK
POST /sys/replication/dr/primary/secondary-token
ID операции: system-write-replication-dr-primary-secondary-token
Требует sudo: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
id | string | нет | Непрозрачный идентификатор, который можно использовать для идентификации и последующего отзыва доступа вторичного кластера. |
secondary_public_key | string | нет | Открытый ключ в кодировке base64, сгенерированный вторичным кластером. |
ttl | integer (default: 30m) | нет | TTL токена активации вторичного кластера. По умолчанию 30 минут. |
Ответы
200: OK
POST /sys/replication/dr/secondary/config/reload/{subsystem}
ID операции: system-write-replication-dr-secondary-config-reload-subsystem
Перезагрузить заданную подсистему
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
subsystem | string | path | да |
Ответы
200: OK
POST /sys/replication/dr/secondary/disable
ID операции: system-write-replication-dr-secondary-disable
Доступен без аутентификации: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
dr_operation_token | string | нет | Токен операции DR, используемый для авторизации этого запроса. |
Ответы
200: OK
POST /sys/replication/dr/secondary/enable
ID операции: system-write-replication-dr-secondary-enable
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
ca_file | string | нет | Путь к файлу с CA-сертификатом в формате PEM для проверки вызова по API-адресу основного кластера |
ca_path | string | нет | Путь к каталогу с CA-сертификатами в формате PEM для проверки вызова по API-адресу основного кластера |
client_cert_pem | string | нет | Клиентский сертификат для аутентификации в формате PEM. Примечание: клиентская аутентификация для этой операции всегда использует TLS 1.2 или выше. |
client_key_pem | string | нет | Клиентский ключ для аутентификации в формате PEM. |
primary_api_addr | string | нет | API-адрес основного кластера. Если не задан, будет использовано значение, переданное основным кластером в токене, — адрес перенаправления основного кластера. |
token | string | нет | Токен, выданный основным кластером для активации статуса вторичного кластера. |
Ответы
200: OK
GET /sys/replication/dr/secondary/generate-operation-token/attempt
ID операции: system-read-replication-dr-secondary-generate-operation-token-attempt
Ответы
200: OK
POST /sys/replication/dr/secondary/generate-operation-token/attempt
ID операции: system-write-replication-dr-secondary-generate-operation-token-attempt
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
otp | string | нет | Одноразовый пароль для шифрования сгенерированного токена. |
pgp_key | string | нет | Открытый ключ PGP в кодировке base64. |
Ответы
200: OK
DELETE /sys/replication/dr/secondary/generate-operation-token/attempt
ID операции: system-delete-replication-dr-secondary-generate-operation-token-attempt
Ответы
204: пустое тело
POST /sys/replication/dr/secondary/generate-operation-token/update
ID операции: system-write-replication-dr-secondary-generate-operation-token-update
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
key | string | нет | Одна доля ключа распечатывания. |
nonce | string | нет | Nonce попытки. |
Ответы
200: OK
POST /sys/replication/dr/secondary/generate-public-key
ID операции: system-write-replication-dr-secondary-generate-public-key
Ответы
200: OK
GET /sys/replication/dr/secondary/license/status
ID операции: system-read-replication-dr-secondary-license-status
Путь поддерживает следующие HTTP-методы. GET / Возвращает информацию об установленной лицензии POST Устанавливает лицензию для сервера
Доступен без аутентификации: да
Ответы
200: OK
POST /sys/replication/dr/secondary/merkle-check
ID операции: system-write-replication-dr-secondary-merkle-check
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
dr_operation_token | string | нет | Токен операции DR, используемый для авторизации этого запроса. |
Ответы
200: OK
POST /sys/replication/dr/secondary/operation-token/delete
ID операции: system-write-replication-dr-secondary-operation-token-delete
Доступен без аутентификации: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
dr_operation_token | string | нет | Токен операции DR, используемый для авторизации этого запроса. |
Ответы
200: OK
POST /sys/replication/dr/secondary/promote
ID операции: system-write-replication-dr-secondary-promote
Доступен без аутентификации: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
dr_operation_token | string | нет | Токен операции DR, используемый для авторизации этого запроса. |
force | boolean | нет | Если true, кластер повышается, даже если репликация находится в состоянии ошибки. Это может означать, что часть данных не была реплицирована на вторичный кластер |
primary_cluster_addr | string | нет | Адрес, к которому должен подключаться вторичный кластер. По умолчанию — кластерный адрес основного кластера. |
Ответы
200: OK
POST /sys/replication/dr/secondary/recover
ID операции: system-write-replication-dr-secondary-recover
Доступен без аутентификации: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
dr_operation_token | string | нет | Токен операции DR, используемый для авторизации этого запроса. |
Ответы
200: OK
POST /sys/replication/dr/secondary/reindex
ID операции: system-write-replication-dr-secondary-reindex
Доступен без аутентификации: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
diff | boolean | нет | Включает более медленную переиндексацию с проверкой на уровне ключей для диагностики проблем. По умолчанию false. |
dr_operation_token | string | нет | Токен операции DR, используемый для авторизации этого запроса. |
force | boolean | нет | Принудительно выполняет полную переиндексацию, при которой сканируются только данные, доступные в хранилище. По умолчанию false. |
skip_flush | boolean | нет | Пропускает этап сброса дерева в процессе переиндексации. Этот параметр позволяет сократить время блокировки дерева во время переиндексации. Если этот узел будет остановлен до завершения асинхронного сброса всего дерева, переиндексация может быть применена не полностью и потребуется выполнить ее заново. При корректной остановке узла дерево будет сброшено до завершения работы. По умолчанию false. |
Ответы
200: OK
POST /sys/replication/dr/secondary/update-primary
ID операции: system-write-replication-dr-secondary-update-primary
Доступен без аутентификации: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
ca_file | string | нет | Путь к файлу с CA-сертификатом в формате PEM для проверки вызова по API-адресу основного кластера |
ca_path | string | нет | Путь к каталогу с CA-сертификатами в формате PEM для проверки вызова по API-адресу основного кластера |
client_cert_pem | string | нет | Клиентский сертификат для аутентификации в формате PEM. Примечание: клиентская аутентификация для этой операции всегда использует TLS 1.2 или выше. |
client_key_pem | string | нет | Клиентский ключ для аутентификации в формате PEM. |
dr_operation_token | string | нет | Токен операции DR, используемый для авторизации этого запроса. |
primary_api_addr | string | нет | API-адрес основного кластера. Если не задан, будет использовано значение, переданное основным кластером в токене, — адрес перенаправления основного кластера. |
token | string | нет | Токен, выданный основным кластером для активации статуса вторичного кластера. |
update_primary_addrs | array | нет | Список строк host:port через запятую, которые будут использоваться как новые адреса основного кластера |
Ответы
200: OK
GET /sys/replication/dr/status
ID операции: system-read-replication-dr-status
Доступен без аутентификации: да
Ответы
200: OK
POST /sys/replication/merkle-check
ID операции: system-write-replication-merkle-check
Ответы
200: OK
POST /sys/replication/performance/primary/demote
ID операции: system-write-replication-performance-primary-demote
Ответы
200: OK
POST /sys/replication/performance/primary/disable
ID операции: system-write-replication-performance-primary-disable
Ответы
200: OK
GET /sys/replication/performance/primary/dynamic-filter/{id}
ID операции: system-read-replication-performance-primary-dynamic-filter-id
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
id | string | path | да | Непрозрачный идентификатор, используемый для идентификации вторичного кластера. |
Ответы
200: OK
POST /sys/replication/performance/primary/enable
ID операции: system-write-replication-performance-primary-enable
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
primary_cluster_addr | string | нет | Адрес, к которому должен подключаться вторичный кластер. По умолчанию — кластерный адрес основного кластера. |
Ответы
200: OK
GET /sys/replication/performance/primary/paths-filter/{id}
ID операции: system-read-replication-performance-primary-paths-filter-id
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
id | string | path | да | Непрозрачный идентификатор, используемый для идентификации вторичного кластера. |
Ответы
200: OK
POST /sys/replication/performance/primary/paths-filter/{id}
ID операции: system-write-replication-performance-primary-paths-filter-id
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
id | string | path | да | Непрозрачный идентификатор, используемый для идентификации вторичного кластера. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
mode | string (default: allow) | нет | Режим фильтрации путей (allow или deny). По умолчанию allow. |
paths | array | нет | Пути для фильтрации при репликации. Должны быть точкой монтирования или пространством имен. |
Ответы
200: OK
DELETE /sys/replication/performance/primary/paths-filter/{id}
ID операции: system-delete-replication-performance-primary-paths-filter-id
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
id | string | path | да | Непрозрачный идентификатор, используемый для идентификации вторичного кластера. |
Ответы
204: пустое тело
POST /sys/replication/performance/primary/revoke-secondary
ID операции: system-write-replication-performance-primary-revoke-secondary
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
id | string | нет | Идентификатор отзываемого вторичного кластера |
Ответы
200: OK
POST /sys/replication/performance/primary/secondary-token
ID операции: system-write-replication-performance-primary-secondary-token
Требует sudo: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
id | string | нет | Непрозрачный идентификатор, который можно использовать для идентификации и последующего отзыва доступа вторичного кластера. |
secondary_public_key | string | нет | Открытый ключ в кодировке base64, сгенерированный вторичным кластером. |
ttl | integer (default: 30m) | нет | TTL токена активации вторичного кластера. По умолчанию 30 минут. |
Ответы
200: OK
POST /sys/replication/performance/secondary/disable
ID операции: system-write-replication-performance-secondary-disable
Ответы
200: OK
GET /sys/replication/performance/secondary/dynamic-filter/{id}
ID операции: system-read-replication-performance-secondary-dynamic-filter-id
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
id | string | path | да | Непрозрачный идентификатор, используемый для идентификации вторичного кластера. |
Ответы
200: OK
POST /sys/replication/performance/secondary/enable
ID операции: system-write-replication-performance-secondary-enable
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
ca_file | string | нет | Путь к файлу с CA-сертификатом в формате PEM для проверки вызова по API-адресу основного кластера |
ca_path | string | нет | Путь к каталогу с CA-сертификатами в формате PEM для проверки вызова по API-адресу основного кластера |
client_cert_pem | string | нет | Клиентский сертификат для аутентификации в формате PEM. Примечание: клиентская аутентификация для этой операции всегда использует TLS 1.2 или выше. |
client_key_pem | string | нет | Клиентский ключ для аутентификации в формате PEM. |
primary_api_addr | string | нет | API-адрес основного кластера. Если не задан, будет использовано значение, переданное основным кластером в токене, — адрес перенаправления основного кластера. |
token | string | нет | Токен, выданный основным кластером для активации статуса вторичного кластера. |
Ответы
200: OK
POST /sys/replication/performance/secondary/generate-public-key
ID операции: system-write-replication-performance-secondary-generate-public-key
Ответы
200: OK
POST /sys/replication/performance/secondary/promote
ID операции: system-write-replication-performance-secondary-promote
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
force | boolean | нет | Если true, кластер повышается, даже если репликация находится в состоянии ошибки. Это может означать, что часть данных не была реплицирована на вторичный кластер |
primary_cluster_addr | string | нет | Адрес, к которому должен подключаться вторичный кластер. По умолчанию — кластерный адрес основного кластера. |
Ответы
200: OK
POST /sys/replication/performance/secondary/update-primary
ID операции: system-write-replication-performance-secondary-update-primary
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
ca_file | string | нет | Путь к файлу с CA-сертификатом в формате PEM для проверки вызова по API-адресу основного кластера |
ca_path | string | нет | Путь к каталогу с CA-сертификатами в формате PEM для проверки вызова по API-адресу основного кластера |
client_cert_pem | string | нет | Клиентский сертификат для аутентификации в формате PEM. Примечание: клиентская аутентификация для этой операции всегда использует TLS 1.2 или выше. |
client_key_pem | string | нет | Клиентский ключ для аутентификации в формате PEM. |
primary_api_addr | string | нет | API-адрес основного кластера. Если не задан, будет использовано значение, переданное основным кластером в токене, — адрес перенаправления основного кластера. |
token | string | нет | Токен, выданный основным кластером для активации статуса вторичного кластера. |
update_primary_addrs | array | нет | Список строк host:port через запятую, которые будут использоваться как новые адреса основного кластера |
Ответы
200: OK
GET /sys/replication/performance/status
ID операции: system-read-replication-performance-status
Доступен без аутентификации: да
Ответы
200: OK
POST /sys/replication/primary/demote
ID операции: system-write-replication-primary-demote
Ответы
200: OK
POST /sys/replication/primary/disable
ID операции: system-write-replication-primary-disable
Ответы
200: OK
POST /sys/replication/primary/enable
ID операции: system-write-replication-primary-enable
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
primary_cluster_addr | string | нет | Адрес, к которому должен подключаться вторичный кластер. По умолчанию — кластерный адрес основного кластера. |
Ответы
200: OK
POST /sys/replication/primary/revoke-secondary
ID операции: system-write-replication-primary-revoke-secondary
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
id | string | нет | Идентификатор отзываемого вторичного кластера |
Ответы
200: OK
POST /sys/replication/primary/secondary-token
ID операции: system-write-replication-primary-secondary-token
Требует sudo: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
id | string | нет | Непрозрачный идентификатор, который можно использовать для идентификации и последующего отзыва доступа вторичного кластера. |
secondary_public_key | string | нет | Открытый ключ в кодировке base64, сгенерированный вторичным кластером. |
ttl | integer (default: 30m) | нет | TTL токена активации вторичного кластера. По умолчанию 30 минут. |
Ответы
200: OK
POST /sys/replication/recover
ID операции: system-write-replication-recover
Ответы
200: OK
POST /sys/replication/reindex
ID операции: system-write-replication-reindex
Требует sudo: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
diff | boolean | нет | Включает более медленную переиндексацию с проверкой на уровне ключей для диагностики проблем. По умолчанию false. |
force | boolean | нет | Принудительно выполняет полную переиндексацию, при которой сканируются только данные, доступные в хранилище. По умолчанию false. |
skip_flush | boolean | нет | Пропускает этап сброса дерева в процессе переиндексации. Этот параметр позволяет сократить время блокировки дерева во время переиндексации. Если этот узел будет остановлен до завершения асинхронного сброса всего дерева, переиндексация может быть применена не полностью и потребуется выполнить ее заново. При корректной остановке узла дерево будет сброшено до завершения работы. По умолчанию false. |
Ответы
200: OK
POST /sys/replication/secondary/disable
ID операции: system-write-replication-secondary-disable
Ответы
200: OK
POST /sys/replication/secondary/enable
ID операции: system-write-replication-secondary-enable
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
ca_file | string | нет | Путь к файлу с CA-сертификатом в формате PEM для проверки вызова по API-адресу основного кластера |
ca_path | string | нет | Путь к каталогу с CA-сертификатами в формате PEM для проверки вызова по API-адресу основного кластера |
client_cert_pem | string | нет | Клиентский сертификат для аутентификации в формате PEM. Примечание: клиентская аутентификация для этой операции всегда использует TLS 1.2 или выше. |
client_key_pem | string | нет | Клиентский ключ для аутентификации в формате PEM. |
primary_api_addr | string | нет | API-адрес основного кластера. Если не задан, будет использовано значение, переданное основным кластером в токене, — адрес перенаправления основного кластера. |
token | string | нет | Токен, выданный основным кластером для активации статуса вторичного кластера. |
Ответы
200: OK
POST /sys/replication/secondary/promote
ID операции: system-write-replication-secondary-promote
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
force | boolean | нет | Если true, кластер повышается, даже если репликация находится в состоянии ошибки. Это может означать, что часть данных не была реплицирована на вторичный кластер |
primary_cluster_addr | string | нет | Адрес, к которому должен подключаться вторичный кластер. По умолчанию — кластерный адрес основного кластера. |
Ответы
200: OK
POST /sys/replication/secondary/update-primary
ID операции: system-write-replication-secondary-update-primary
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
ca_file | string | нет | Путь к файлу с CA-сертификатом в формате PEM для проверки вызова по API-адресу основного кластера |
ca_path | string | нет | Путь к каталогу с CA-сертификатами в формате PEM для проверки вызова по API-адресу основного кластера |
client_cert_pem | string | нет | Клиентский сертификат для аутентификации в формате PEM. Примечание: клиентская аутентификация для этой операции всегда использует TLS 1.2 или выше. |
client_key_pem | string | нет | Клиентский ключ для аутентификации в формате PEM. |
primary_api_addr | string | нет | API-адрес основного кластера. Если не задан, будет использовано значение, переданное основным кластером в токене, — адрес перенаправления основного кластера. |
token | string | нет | Токен, выданный основным кластером для активации статуса вторичного кластера. |
Ответы
200: OK
GET /sys/replication/status
ID операции: system-read-replication-status
Доступен без аутентификации: да
Ответы
200: OK
POST /sys/revoke
ID операции: leases-revoke-lease2
Немедленно отзывает аренду.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
lease_id | string | нет | Идентификатор продлеваемой аренды. Возвращается вместе с арендой. |
sync | boolean (default: True) | нет | Выполнять ли отзыв синхронно |
url_lease_id | string | нет | Идентификатор продлеваемой аренды. Возвращается вместе с арендой. |
Ответы
204: OK
POST /sys/revoke-force/{prefix}
ID операции: leases-force-revoke-lease-with-prefix2
Немедленно отзывает все секреты или токены, сгенерированные под указанным префиксом
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
prefix | string | path | да | Префикс пути, под которым отзываются ключи. Пример: “prod/aws/ops” |
Ответы
204: OK
POST /sys/revoke-prefix/{prefix}
ID операции: leases-revoke-lease-with-prefix2
Немедленно отзывает все секреты (по префиксу идентификатора аренды) или токены (по свойству path токенов), сгенерированные под указанным префиксом.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
prefix | string | path | да | Префикс пути, под которым отзываются ключи. Пример: “prod/aws/ops” |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
sync | boolean (default: True) | нет | Выполнять ли отзыв синхронно |
Ответы
204: OK
POST /sys/revoke/{url_lease_id}
ID операции: leases-revoke-lease-with-id2
Немедленно отзывает аренду.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
url_lease_id | string | path | да | Идентификатор продлеваемой аренды. Возвращается вместе с арендой. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
lease_id | string | нет | Идентификатор продлеваемой аренды. Возвращается вместе с арендой. |
sync | boolean (default: True) | нет | Выполнять ли отзыв синхронно |
Ответы
204: OK
POST /sys/rotate
ID операции: encryption-key-rotate
Выполняет ротацию ключа шифрования бэкенда, используемого для хранения данных.
Требует sudo: да
Ответы
204: OK
GET /sys/rotate/config
ID операции: encryption-key-read-rotation-configuration
Настраивает параметры управления ключом шифрования бэкенда.
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
enabled | boolean | нет | |
interval | integer | нет | |
max_operations | integer | нет |
POST /sys/rotate/config
ID операции: encryption-key-configure-rotation
Настраивает параметры управления ключом шифрования бэкенда.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
enabled | boolean | нет | Включена ли автоматическая ротация. |
interval | integer | нет | Через какое время после установки активного ключа выполняется его автоматическая ротация. |
max_operations | integer | нет | Количество операций шифрования, после которого выполняется автоматическая ротация ключа барьера. |
Ответы
204: OK
POST /sys/seal
ID операции: seal
Запечатать Stronghold.
Ответы
204: OK
GET /sys/seal-status
ID операции: seal-status
Проверить статус запечатывания Stronghold.
Доступен без аутентификации: да
Ответы
200:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
build_date | string | нет | |
cluster_id | string | нет | |
cluster_name | string | нет | |
hcp_link_resource_ID | string | нет | |
hcp_link_status | string | нет | |
initialized | boolean | нет | |
migration | boolean | нет | |
n | integer | нет | |
nonce | string | нет | |
progress | integer | нет | |
recovery_seal | boolean | нет | |
sealed | boolean | нет | |
storage_type | string | нет | |
t | integer | нет | |
type | string | нет | |
version | string | нет |
GET /sys/sealwrap/rewrap
ID операции: system-read-sealwrap-rewrap
Получить состояние текущего процесса перешифрования seal
Ответы
200: OK
POST /sys/sealwrap/rewrap
ID операции: system-write-sealwrap-rewrap
Запустить процесс перешифрования seal
Ответы
200: OK
POST /sys/step-down
ID операции: step-down-leader
Заставить узел отказаться от активного статуса.
Ответы
204: пустое тело
GET /sys/storage/raft/autopilot/configuration
ID операции: system-read-storage-raft-autopilot-configuration
Возвращает конфигурацию autopilot.
Ответы
200: OK
POST /sys/storage/raft/autopilot/configuration
ID операции: system-write-storage-raft-autopilot-configuration
Возвращает конфигурацию autopilot.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
cleanup_dead_servers | boolean | нет | Удалять ли неработающие серверы из списка узлов Raft — периодически или при подключении нового сервера. |
dead_server_last_contact_threshold | integer | нет | Максимальное время, в течение которого сервер может не связываться с лидером, прежде чем будет признан вышедшим из строя. Действует, только если задан cleanup_dead_servers. |
disable_upgrade_migration | boolean | нет | Выполнять ли автоматические обновления версий. |
dr_operation_token | string | нет | Токен операции DR для авторизации этого запроса (если это узел вторичного кластера DR). |
last_contact_threshold | integer | нет | Максимальное время, в течение которого сервер может не связываться с лидером, прежде чем будет признан неработоспособным. |
max_trailing_logs | integer | нет | На сколько записей журнала Raft сервер может отставать, прежде чем будет признан неработоспособным. |
min_quorum | integer | нет | Минимальное количество серверов в кластере, при котором autopilot может удалять неработающие серверы. Должно быть не меньше 3. |
server_stabilization_time | integer | нет | Минимальное время, в течение которого сервер должен находиться в стабильном работоспособном состоянии, прежде чем его можно добавить в кластер. |
Ответы
200: OK
GET /sys/storage/raft/autopilot/state
ID операции: system-read-storage-raft-autopilot-state
Возвращает состояние кластера Raft с интегрированным хранилищем с точки зрения autopilot.
Ответы
200: OK
POST /sys/storage/raft/bootstrap/answer
ID операции: system-write-storage-raft-bootstrap-answer
Принимает ответ от узла, присоединяемого к кластеру Raft.
Доступен без аутентификации: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
answer | string | нет | |
cluster_addr | string | нет | |
non_voter | boolean | нет | |
server_id | string | нет |
Ответы
200: OK
POST /sys/storage/raft/bootstrap/challenge
ID операции: system-write-storage-raft-bootstrap-challenge
Создает challenge для нового узла, присоединяемого к кластеру Raft.
Доступен без аутентификации: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
server_id | string | нет |
Ответы
200: OK
GET /sys/storage/raft/configuration
ID операции: system-read-storage-raft-configuration
Возвращает конфигурацию кластера Raft.
Ответы
200: OK
POST /sys/storage/raft/configuration
ID операции: system-write-storage-raft-configuration
Возвращает конфигурацию кластера Raft во вторичном кластере DR.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
dr_operation_token | string | нет | Токен операции DR для авторизации этого запроса (если это узел вторичного кластера DR). |
Ответы
200: OK
POST /sys/storage/raft/demote
ID операции: system-write-storage-raft-demote
Переводит голосующий узел в неголосующий.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
force | boolean | нет | Понизить сервер, даже если оставшихся голосующих узлов будет меньше min_quorum или кластер не сможет пережить отказ голосующего узла. |
server_id | string | нет |
Ответы
200: OK
POST /sys/storage/raft/promote
ID операции: system-write-storage-raft-promote
Переводит неголосующий узел в голосующий.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
server_id | string | нет |
Ответы
200: OK
POST /sys/storage/raft/remove-peer
ID операции: system-write-storage-raft-remove-peer
Удалить узел из кластера Raft.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
dr_operation_token | string | нет | Токен операции DR для авторизации этого запроса (если это узел вторичного кластера DR). |
server_id | string | нет |
Ответы
200: OK
GET /sys/storage/raft/snapshot
ID операции: system-read-storage-raft-snapshot
Возвращает снимок текущего состояния Stronghold.
Ответы
200: OK
POST /sys/storage/raft/snapshot
ID операции: system-write-storage-raft-snapshot
Устанавливает переданный снимок и возвращает кластер в зафиксированное в нем состояние.
Ответы
200: OK
GET /sys/storage/raft/snapshot-auto/config/
ID операции: system-list-storage-raft-snapshot-auto-config
Получить список конфигураций автоматических снимков raft
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
GET /sys/storage/raft/snapshot-auto/config/{name}
ID операции: system-read-storage-raft-snapshot-auto-config-name
Прочитать конфигурацию автоматических снимков raft
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя обновляемой конфигурации |
Ответы
200: OK
POST /sys/storage/raft/snapshot-auto/config/{name}
ID операции: system-write-storage-raft-snapshot-auto-config-name
Обновить конфигурацию автоматических снимков raft
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя обновляемой конфигурации |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
aws_access_key_id | string | нет | Идентификатор ключа доступа AWS |
aws_s3_bucket | string | нет | Бакет AWS |
aws_s3_ca_certificate | string | нет | CA-сертификат в формате PEM для проверки TLS-сертификата конечной точки S3 |
aws_s3_disable_tls | boolean | нет | Отключить TLS для конечной точки AWS; предназначено только для тестирования |
aws_s3_enable_kms | boolean | нет | Использовать KMS для шифрования содержимого бакета |
aws_s3_endpoint | string | нет | Конечная точка AWS; обычно задается только при использовании S3-совместимого хранилища, отличного от AWS, например Minio |
aws_s3_kms_key | string | нет | Использовать именованный ключ KMS |
aws_s3_region | string | нет | Регион AWS |
aws_s3_server_side_encryption | boolean | нет | Использовать AES256 для шифрования содержимого бакета |
aws_secret_access_key | string | нет | Секретный ключ доступа AWS |
aws_session_token | string | нет | Сессионный токен AWS |
azure_account_key | string | нет | Ключ учетной записи Azure |
azure_account_name | string | нет | Имя учетной записи Azure |
azure_blob_environment | string (default: AZUREPUBLICCLOUD) | нет | Окружение Azure Blob |
azure_container_name | string | нет | Имя контейнера Azure |
azure_endpoint | string | нет | Конечная точка хранилища Azure Blob |
file_prefix | string (default: vault-snapshot) | нет | Префикс файла/объекта, добавляемый к идентификатору снимка |
google_disable_tls | boolean | нет | Отключить TLS; обычно только для тестирования |
google_endpoint | string | нет | Конечная точка GCS |
google_gcs_bucket | string | нет | Бакет GCS |
google_service_account_key | string | нет | Ключ сервисного аккаунта в формате JSON |
interval | integer (default: 3600000000000) | нет | Расписание создания снимков |
local_max_space | integer | нет | Максимальный объем дискового пространства для снимков |
path_prefix | string | нет | Каталог (локально) или префикс бакета (в облаке) для снимков |
retain | integer (default: 1) | нет | Количество хранимых снимков |
storage_type | string (local, aws-s3) | нет | Тип хранилища для снимков |
Ответы
200: OK
DELETE /sys/storage/raft/snapshot-auto/config/{name}
ID операции: system-delete-storage-raft-snapshot-auto-config-name
Удалить конфигурацию автоматических снимков raft
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя обновляемой конфигурации |
Ответы
204: пустое тело
GET /sys/storage/raft/snapshot-auto/status/{name}
ID операции: system-read-storage-raft-snapshot-auto-status-name
Прочитать статус автоматических снимков raft
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя обновляемой конфигурации |
Ответы
200: OK
POST /sys/storage/raft/snapshot-force
ID операции: system-write-storage-raft-snapshot-force
Устанавливает переданный снимок и возвращает кластер в зафиксированное в нем состояние. При этом пропускаются проверки соответствия текущих ключей автоматического распечатывания или ключей Шамира данным снимка.
Ответы
200: OK
POST /sys/tools/hash
ID операции: generate-hash
Сгенерировать хеш-сумму входных данных
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
algorithm | string (default: sha2-256) | нет | Используемый алгоритм (параметр тела POST-запроса). Допустимые значения: * sha2-224 * sha2-256 * sha2-384 * sha2-512 * streebog-256 * streebog-512. По умолчанию “sha2-256”. |
format | string (default: hex) | нет | Используемая кодировка: “hex” или “base64”. По умолчанию “hex”. |
input | string | нет | Входные данные в кодировке base64 |
urlalgorithm | string | нет | Используемый алгоритм (параметр URL POST-запроса) |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
sum | string | нет |
POST /sys/tools/hash/{urlalgorithm}
ID операции: generate-hash-with-algorithm
Сгенерировать хеш-сумму входных данных
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
urlalgorithm | string | path | да | Используемый алгоритм (параметр URL POST-запроса) |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
algorithm | string (default: sha2-256) | нет | Используемый алгоритм (параметр тела POST-запроса). Допустимые значения: * sha2-224 * sha2-256 * sha2-384 * sha2-512 * streebog-256 * streebog-512. По умолчанию “sha2-256”. |
format | string (default: hex) | нет | Используемая кодировка: “hex” или “base64”. По умолчанию “hex”. |
input | string | нет | Входные данные в кодировке base64 |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
sum | string | нет |
POST /sys/tools/random
ID операции: generate-random
Сгенерировать случайные байты
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
bytes | integer (default: 32) | нет | Количество генерируемых байтов (параметр тела POST-запроса). По умолчанию 32 (256 бит). |
format | string (default: base64) | нет | Используемая кодировка: “hex” или “base64”. По умолчанию “base64”. |
source | string (default: platform) | нет | Источник случайных данных: “platform”, “seal” или “all”. |
urlbytes | string | нет | Количество генерируемых байтов (параметр URL POST-запроса) |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
random_bytes | string | нет |
POST /sys/tools/random/{source}
ID операции: generate-random-with-source
Сгенерировать случайные байты
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
source | string | path | да | Источник случайных данных: “platform”, “seal” или “all”. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
bytes | integer (default: 32) | нет | Количество генерируемых байтов (параметр тела POST-запроса). По умолчанию 32 (256 бит). |
format | string (default: base64) | нет | Используемая кодировка: “hex” или “base64”. По умолчанию “base64”. |
urlbytes | string | нет | Количество генерируемых байтов (параметр URL POST-запроса) |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
random_bytes | string | нет |
POST /sys/tools/random/{source}/{urlbytes}
ID операции: generate-random-with-source-and-bytes
Сгенерировать случайные байты
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
source | string | path | да | Источник случайных данных: “platform”, “seal” или “all”. |
urlbytes | string | path | да | Количество генерируемых байтов (параметр URL POST-запроса) |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
bytes | integer (default: 32) | нет | Количество генерируемых байтов (параметр тела POST-запроса). По умолчанию 32 (256 бит). |
format | string (default: base64) | нет | Используемая кодировка: “hex” или “base64”. По умолчанию “base64”. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
random_bytes | string | нет |
POST /sys/tools/random/{urlbytes}
ID операции: generate-random-with-bytes
Сгенерировать случайные байты
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
urlbytes | string | path | да | Количество генерируемых байтов (параметр URL POST-запроса) |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
bytes | integer (default: 32) | нет | Количество генерируемых байтов (параметр тела POST-запроса). По умолчанию 32 (256 бит). |
format | string (default: base64) | нет | Используемая кодировка: “hex” или “base64”. По умолчанию “base64”. |
source | string (default: platform) | нет | Источник случайных данных: “platform”, “seal” или “all”. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
random_bytes | string | нет |
POST /sys/unseal
ID операции: unseal
Распечатать Stronghold.
Доступен без аутентификации: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
key | string | нет | Одна доля ключа распечатывания. Обязательна, если reset не равен true. |
reset | boolean | нет | Сбросить ли ранее введенные доли ключа распечатывания и начать процесс распечатывания заново. |
Ответы
200:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
build_date | string | нет | |
cluster_id | string | нет | |
cluster_name | string | нет | |
hcp_link_resource_ID | string | нет | |
hcp_link_status | string | нет | |
initialized | boolean | нет | |
migration | boolean | нет | |
n | integer | нет | |
nonce | string | нет | |
progress | integer | нет | |
recovery_seal | boolean | нет | |
sealed | boolean | нет | |
storage_type | string | нет | |
t | integer | нет | |
type | string | нет | |
version | string | нет |
GET /sys/version-history
ID операции: version-history
Возвращает карту записей истории смены версий
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
key_info | object | нет | |
keys | array | нет |
GET /sys/wrapping/lookup
ID операции: read-wrapping-properties2
Получить свойства обертки для токена, которым выполнен запрос.
Доступен без аутентификации: да
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
creation_path | string | нет | |
creation_time | string | нет | |
creation_ttl | integer | нет |
POST /sys/wrapping/lookup
ID операции: read-wrapping-properties
Получить свойства обертки для указанного токена.
Доступен без аутентификации: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
token | string | нет |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
creation_path | string | нет | |
creation_time | string | нет | |
creation_ttl | integer | нет |
POST /sys/wrapping/rewrap
ID операции: rewrap
Выполняет ротацию токена, обернутого в ответ (response-wrapped).
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
token | string | нет |
Ответы
200: OK
POST /sys/wrapping/unwrap
ID операции: unwrap
Разворачивает токен, обернутый в ответ (response-wrapped).
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
token | string | нет |
Ответы
200: OK
204: No content
POST /sys/wrapping/wrap
ID операции: wrap
Оборачивает в ответ (response-wrap) произвольный JSON-объект.
Ответы
200: OK