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 | нет |
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 | нет | Конфигурация для этого монтирования, например, имя_плагина. |
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) | нет | Включать ли оборачивающее шифрование для монтирования. |
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 | нет | Определяет видимость монтирования в конечной точке листинга, специфичной для пользовательского интерфейса. Принимаются значения ‘unauth’ и ‘hidden’, при этом пустое значение по умолчанию (’’) ведет себя как ‘hidden’. |
max_lease_ttl | string | нет | Максимальное значение TTL аренды для данного монтирования. |
options | object | нет | Параметры для передачи в бэкенд. Это должен быть json-объект со строковыми ключами и значениями. |
passthrough_request_headers | array | нет | Список заголовков, которые необходимо включить в белый список и передать из запроса в плагин. |
plugin_version | string | нет | Семантическая версия плагина для использования. |
token_type | string | нет | Тип выпускаемого токена (сервисный или пакетный). |
user_lockout_config | object | нет | Конфигурация блокировки пользователя для передачи в бэкэнд. Это должен быть json-объект со строковыми ключами и значениями. |
Ответы
204: OK
POST /sys/capabilities
ID операции: query-token-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
Получает возможности заданного токена по заданному пути.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
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 операции: enterprise-stub-read-config-control-group
Ответы
200: OK
POST /sys/config/control-group
ID операции: enterprise-stub-write-config-control-group
Ответы
200: OK
DELETE /sys/config/control-group
ID операции: enterprise-stub-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 операции: enterprise-stub-read-config-group-policy-application
Ответы
200: OK
POST /sys/config/group-policy-application
ID операции: enterprise-stub-write-config-group-policy-application
Ответы
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 операции: enterprise-stub-write-control-group-authorize
Ответы
200: OK
POST /sys/control-group/request
ID операции: enterprise-stub-write-control-group-request
Ответы
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
Считывание информации о конфигурации и ходе выполнения текущей попытки генерации корня.
Ответы
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
Инициализирует новую попытку генерации корня.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
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
Отменяет все текущие попытки генерации корня.
Ответы
204: OK
GET /sys/generate-root/attempt
ID операции: root-token-generation-read-progress
Считывание информации о конфигурации и ходе выполнения текущей попытки генерации корня.
Доступен без аутентификации: да
Ответы
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
Инициализирует новую попытку генерации корня.
Доступен без аутентификации: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
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
Отменяет все текущие попытки генерации корня.
Доступен без аутентификации: да
Ответы
204: OK
POST /sys/generate-root/update
ID операции: root-token-generation-update
Введите единственную долю ключа unseal, чтобы продолжить попытку генерации корня.
Доступен без аутентификации: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
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: инициализирован, разблокирован и активен
429: без печати и в режиме ожидания
472: режим восстановления данных репликация вторичная и активная
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, используемый для шифрования начального корневого токена. Ключ должен быть закодирован в base64 из его исходного двоичного представления. |
secret_shares | integer | нет | Указывает количество долей, на которые нужно разделить ключ разблокировки. |
secret_threshold | integer | нет | Указывает количество долей, необходимых для восстановления ключа unseal. Это значение должно быть меньше или равно 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) | нет | Включить или отключить сбор данных о количестве клиентов: включить, отключить или по умолчанию. |
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 | нет | Контекстная строка, добавляемая к каждой операцииId |
Ответы
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
Отображает все включенные и видимые монтирования auth и secrets.
Доступен без аутентификации: да
Ответы
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 | нет | Истина, если аренда может быть продлена |
ttl | integer | нет | Время жизни, установленное для аренды, возвращает 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
Немедленно отменяет все секреты (через префикс идентификатора аренды) или токены (через свойство пути токенов), созданные под данным префиксом.
Требует 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/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 auth. Если псевдоним принадлежит методу аутентификации 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 операции: enterprise-stub-list-managed-keys-type
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
type | string | path | да | |
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
GET /sys/managed-keys/{type}/{name}
ID операции: enterprise-stub-read-managed-keys-type-name
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | |
type | string | path | да |
Ответы
200: OK
POST /sys/managed-keys/{type}/{name}
ID операции: enterprise-stub-write-managed-keys-type-name
Поддерживается создание: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | |
type | string | path | да |
Ответы
200: OK
DELETE /sys/managed-keys/{type}/{name}
ID операции: enterprise-stub-delete-managed-keys-type-name
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | |
type | string | path | да |
Ответы
204: пустое тело
POST /sys/managed-keys/{type}/{name}/test/sign
ID операции: enterprise-stub-write-managed-keys-type-name-test-sign
Поддерживается создание: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | |
type | string | path | да |
Ответы
200: OK
GET /sys/metrics
ID операции: metrics
Экспортируйте агрегированные метрики для целей телеметрии.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
format | string | query | нет | Формат для экспорта метрик. В настоящее время принимается только “prometheus”. |
Ответы
200: OK
POST /sys/mfa/validate
ID операции: mfa-validate
Проверяет логин для данных методов MFA. При успешной проверке возвращает ответ аутентификации, содержащий токен клиента
Доступен без аутентификации: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
mfa_payload | object | да | Карта из идентификатора метода MFA в фрагмент пасскодов или пустой фрагмент, если метод не использует пасскоды |
mfa_request_id | string | да | Идентификатор для данного запроса MFA |
Ответы
200: OK
GET /sys/monitor
ID операции: monitor
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
log_format | string | query | нет | Формат вывода журналов. Поддерживаются следующие значения: “standard” и “json”. По умолчанию используется “стандартный”. |
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) | нет | Включать ли оборачивающее шифрование для монтирования. |
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) | нет | Включать ли оборачивающее шифрование для монтирования. |
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 | нет | Семантическая версия плагина для использования. |
token_type | string | нет | Тип выпускаемого токена (сервисный или пакетный). |
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 | нет | Определяет видимость монтирования в конечной точке листинга, специфичной для пользовательского интерфейса. Принимаются значения ‘unauth’ и ‘hidden’, при этом пустое значение по умолчанию (’’) ведет себя как ‘hidden’. |
max_lease_ttl | string | нет | Максимальное значение TTL аренды для данного монтирования. |
options | object | нет | Параметры для передачи в бэкенд. Это должен быть json-объект со строковыми ключами и значениями. |
passthrough_request_headers | array | нет | Список заголовков, которые необходимо включить в белый список и передать из запроса в плагин. |
plugin_version | string | нет | Семантическая версия плагина для использования. |
src_ca_cert | string | нет | |
src_secret_path | array | нет | |
src_token | string | нет | |
sync_period_min | integer | нет | |
token_type | string | нет | Тип выпускаемого токена (сервисный или пакетный). |
user_lockout_config | object | нет | Конфигурация блокировки пользователя для передачи в бэкэнд. Это должен быть json-объект со строковыми ключами и значениями. |
Ответы
200: OK
GET /sys/namespaces/
ID операции: namespaces-list-namespaces
Создать новое пространство имен по новому пути
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
POST /sys/namespaces/api-lock/lock
ID операции: namespaces-lock-namespace-api
Заблокировать API для пространства имен и всех его потомков
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
path | string | нет | Необязательный дочерний путь пространства имен для блокировки. Если не указан, блокируется текущее пространство имен. |
Ответы
200: OK
POST /sys/namespaces/api-lock/lock/{path}
ID операции: namespaces-lock-namespaces-api-lock-lock-path
Заблокировать API для пространства имен и всех его потомков
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Необязательный дочерний путь пространства имен для блокировки. Если не указан, блокируется текущее пространство имен. |
Ответы
200: OK
POST /sys/namespaces/api-lock/unlock
ID операции: namespaces-unlock-namespace-api
Разблокировать API для пространства имен и всех его потомков
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
path | string | нет | Необязательный дочерний путь пространства имен для разблокировки. Если не указан, разблокируется текущее пространство имен. |
unlock_key | string | нет | Ключ разблокировки, возвращенный при блокировке пространства имен. Требуется, если не используется токен root. |
Ответы
200: OK
POST /sys/namespaces/api-lock/unlock/{path}
ID операции: namespaces-unlock-namespaces-api-lock-unlock-path
Разблокировать API для пространства имен и всех его потомков
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Необязательный дочерний путь пространства имен для разблокировки. Если не указан, разблокируется текущее пространство имен. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
unlock_key | string | нет | Ключ разблокировки, возвращенный при блокировке пространства имен. Требуется, если не используется токен root. |
Ответы
200: OK
GET /sys/namespaces/{path}
ID операции: namespaces-read-namespace
Чтение информации о пространстве имен
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Путь пространства имен |
Ответы
200: OK
POST /sys/namespaces/{path}
ID операции: namespaces-create-namespace
Создание нового пространства имен по указанному пути.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Путь пространства имен |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
custom_metadata | object | нет | Предоставленные пользователем пары ключ-значение, которые используются для описания информации о секрете. |
Ответы
204: OK
DELETE /sys/namespaces/{path}
ID операции: namespaces-delete-namespace
Удаление пространства имен, указанного по заданному пути.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
path | string | path | да | Путь пространства имен |
Ответы
200: OK
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 исполняемого файла, используемого в поле команды. Она должна быть закодирована в HEX. |
version | string | нет | Семантическая версия плагина для использования. |
POST /sys/plugins/catalog/{name}
ID операции: plugins-catalog-register-plugin
Регистрирует новый плагин или обновляет существующий с указанным именем.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Название плагина |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
args | array | нет | Параметры, передаваемые команде плагина. |
command | string | нет | Команда, используемая для запуска плагина. Исполняемый файл, заданный в этой команде, должен существовать в каталоге плагинов stronghold. |
env | array | нет | Переменные окружения, передаваемые команде плагина. Каждая переменная имеет вид “ключ=значение”. |
sha256 | string | нет | Сумма SHA256 исполняемого файла, используемого в поле команды. Она должна быть закодирована в 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 исполняемого файла, используемого в поле команды. Она должна быть закодирована в 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 | нет | Переменные окружения, передаваемые команде плагина. Каждая переменная имеет вид “ключ=значение”. |
sha256 | string | нет | Сумма SHA256 исполняемого файла, используемого в поле команды. Она должна быть закодирована в 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 операции: enterprise-stub-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 операции: enterprise-stub-list-policies-egp
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
GET /sys/policies/egp/{name}
ID операции: enterprise-stub-read-policies-egp-name
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да |
Ответы
200: OK
POST /sys/policies/egp/{name}
ID операции: enterprise-stub-write-policies-egp-name
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да |
Ответы
200: OK
DELETE /sys/policies/egp/{name}
ID операции: enterprise-stub-delete-policies-egp-name
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да |
Ответы
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 операции: enterprise-stub-list-policies-rgp
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
GET /sys/policies/rgp/{name}
ID операции: enterprise-stub-read-policies-rgp-name
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да |
Ответы
200: OK
POST /sys/policies/rgp/{name}
ID операции: enterprise-stub-write-policies-rgp-name
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да |
Ответы
200: OK
DELETE /sys/policies/rgp/{name}
ID операции: enterprise-stub-delete-policies-rgp-name
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да |
Ответы
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
Возвращает трассировку стека всех текущих 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
Возвращает полезную нагрузку профиля процессора в формате 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 операции: enterprise-stub-list-quotas-lease-count
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
GET /sys/quotas/lease-count/{name}
ID операции: enterprise-stub-read-quotas-lease-count-name
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да |
Ответы
200: OK
POST /sys/quotas/lease-count/{name}
ID операции: enterprise-stub-write-quotas-lease-count-name
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да |
Ответы
200: OK
DELETE /sys/quotas/lease-count/{name}
ID операции: enterprise-stub-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/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
Считывает информацию о конфигурации и ходе выполнения текущей попытки смены ключа.
Доступен без аутентификации: да
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
backup | boolean | нет | |
n | integer | нет | |
nounce | string | нет | |
pgp_fingerprints | array | нет | |
progress | integer | нет | |
required | integer | нет | |
started | string | нет | |
t | integer | нет | |
verification_nonce | string | нет | |
verification_required | boolean | нет |
POST /sys/rekey/init
ID операции: rekey-attempt-initialize
Инициализирует новую попытку смены ключа.
Доступен без аутентификации: да
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
backup | boolean | нет | Указывает, следует ли Stronghold хранить резервную копию PGP-шифрованных ключей в открытом виде, если используются PGP-шифрованные ключи. |
pgp_keys | array | нет | Указывает массив открытых ключей PGP, используемых для шифрования выходных ключей разблокировки. Порядок следования сохраняется. Ключи должны быть закодированы в base64 из их исходного двоичного представления. Размер этого массива должен быть таким же, как secret_shares. |
require_verification | boolean | нет | Включение функции проверки |
secret_shares | integer | нет | Указывает количество долей, на которые нужно разделить ключ разблокировки. |
secret_threshold | integer | нет | Указывает количество долей, необходимых для восстановления ключа unseal. Это значение должно быть меньше или равно secret_shares. При использовании Stronghold HSM с автоматической разблокировкой это значение должно быть равно secret_shares. |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
backup | boolean | нет | |
n | integer | нет | |
nounce | string | нет | |
pgp_fingerprints | array | нет | |
progress | integer | нет | |
required | integer | нет | |
started | string | нет | |
t | integer | нет | |
verification_nonce | string | нет | |
verification_required | boolean | нет |
DELETE /sys/rekey/init
ID операции: rekey-attempt-cancel
Отменяет любой выполняемый повторный ключ.
Доступен без аутентификации: да
Ответы
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 | нет | Указывает нонс попытки смены ключа. |
Ответы
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
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
Немедленно отменяет все секреты (через префикс идентификатора аренды) или токены (через свойство пути токенов), созданные под данным префиксом.
Требует 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.
Требует sudo: да
Ответы
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
Ответы
200: OK
POST /sys/sealwrap/rewrap
ID операции: system-write-sealwrap-rewrap
Ответы
200: OK
POST /sys/step-down
ID операции: step-down-leader
Запускает процедуру передачи узлом активного статуса.
Требует sudo: да
Ответы
204: пустое тело
GET /sys/storage/raft/autopilot/configuration
ID операции: system-read-storage-raft-autopilot-configuration
Возвращает конфигурацию автопилота.
Ответы
200: OK
POST /sys/storage/raft/autopilot/configuration
ID операции: system-write-storage-raft-autopilot-configuration
Возвращает конфигурацию автопилота.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
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 | нет | Минимальное количество серверов, разрешенное в кластере, прежде чем автопилот сможет удалять неработающие серверы. Должно быть не менее 3. |
server_stabilization_time | integer | нет | Минимальное время, в течение которого сервер должен находиться в стабильном, работоспособном состоянии, прежде чем он может быть добавлен в кластер. |
Ответы
200: OK
GET /sys/storage/raft/autopilot/state
ID операции: system-read-storage-raft-autopilot-state
Возвращает состояние кластера raft под интегрированным хранилищем, как видит автопилот.
Ответы
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
Создает вызов для нового узла, который должен быть присоединен к кластеру 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
Делает голосующю ноду неголосующей.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
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
Возвращает снимок текущего состояния хранилища.
Ответы
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
Отображает все имена конфигураций автоматических снимков.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
list | string (true) | query | да | Должно быть установлено значение true. |
Ответы
200: OK
GET /sys/storage/raft/snapshot-auto/config/{name}
ID операции: system-read-storage-raft-snapshot-auto-config-name
Получает конфигурацию автоматического снимка.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя конфигурации для изменения. |
Ответы
200: OK
POST /sys/storage/raft/snapshot-auto/config/{name}
ID операции: system-write-storage-raft-snapshot-auto-config-name
Обновляет конфигурацию автоматического снимка.
Требует sudo: да
Поддерживается создание: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя конфигурации для изменения. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
aws_access_key_id | string | нет | Идентификатор ключа доступа S3. |
aws_s3_bucket | string | да | Контейнер S3 для записи снимков. |
aws_s3_ca_certificate | string (default: ) | нет | Сертификат CA S3 в формате PEM. |
aws_s3_disable_tls | boolean (default: False) | нет | Отключить TLS для конечной точки S3. Следует использовать только в целях тестирования, обычно в сочетании с s3_endpoint. |
aws_s3_endpoint | string | нет | Конечная точка S3. |
aws_s3_region | string (default: ) | нет | Регион S3, в котором находится контейнер. |
aws_secret_access_key | string | нет | Секретный ключ доступа S3. |
file_prefix | string (default: stronghold-snapshot) | нет | В каталоге или префиксе контейнера, заданном path_prefix, имя файла или объекта файлов снимков будет начинаться с этой строки. |
interval | integer | да | Время между снимками. Может быть целым числом секунд или строкой формата длительности Go (например, 24h). |
local_max_space | integer (default: 0) | да | Для storage_type=local - максимальное пространство в байтах для использования всех снимков с заданным file_prefix в каталоге path_prefix. Попытки создания снимков будут неудачными, если в этом лимите недостаточно места. Значение 0 отключает ограничение. |
path_prefix | string | да | Для storage_type=local - каталог для записи снимков. Для типов облачного хранилища - префикс контейнера для использования, также ведущий / игнорируется. Завершающий / необязателен. |
retain | integer (default: 3) | нет | Сколько снимков следует хранить; при записи снимка, если уже сохранено снимков больше этого числа, самые старые будут удалены. |
storage_type | string (local, aws-s3) | да | Один из “local” или “s3”. Остальные параметры, описанные ниже, относятся к выбранному storage_type и имеют соответствующие префиксы. |
Ответы
200: OK
DELETE /sys/storage/raft/snapshot-auto/config/{name}
ID операции: system-delete-storage-raft-snapshot-auto-config-name
Удаляет конфигурацию автоматического снимка.
Требует sudo: да
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя конфигурации для изменения. |
Ответы
204: пустое тело
GET /sys/storage/raft/snapshot-auto/status/{name}
ID операции: system-read-storage-raft-snapshot-auto-status-name
Отображает статус автоматического снимка.
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
name | string | path | да | Имя статуса для получения. |
Ответы
200: OK
POST /sys/storage/raft/snapshot-force
ID операции: system-write-storage-raft-snapshot-force
Устанавливает предоставленный снимок, возвращая кластер в состояние, определенное в нем. Это обходит проверки, обеспечивающие соответствие текущих ключей Autounseal или Shamir данным снимка.
Ответы
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 | нет | Используемый алгоритм (параметр POST URL) |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
sum | string | нет |
POST /sys/tools/hash/{urlalgorithm}
ID операции: generate-hash-with-algorithm
Создает хеш-сумму для входных данных
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
urlalgorithm | string | path | да | Используемый алгоритм (параметр POST URL) |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
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) | нет | Из какой системы брать случайные данные: “платформа”, “печать” или “все”. |
urlbytes | string | нет | Количество байт для генерации (параметр POST URL). |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
random_bytes | string | нет |
POST /sys/tools/random/{source}
ID операции: generate-random-with-source
Генерирует случайные байты
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
source | string | path | да | Из какой системы брать случайные данные: “платформа”, “печать” или “все”. |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
bytes | integer (default: 32) | нет | Количество генерируемых байтов (параметр тела POST). По умолчанию равно 32 (256 бит). |
format | string (default: base64) | нет | Используемый формат кодировки. Может быть “hex” или “base64”. По умолчанию используется “base64”. |
urlbytes | string | нет | Количество байт для генерации (параметр POST URL). |
Ответы
200: OK
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
random_bytes | string | нет |
POST /sys/tools/random/{source}/{urlbytes}
ID операции: generate-random-with-source-and-bytes
Генерирует случайные байты
Параметры
| Параметр | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
source | string | path | да | Из какой системы брать случайные данные: “платформа”, “печать” или “все”. |
urlbytes | string | path | да | Количество байт для генерации (параметр POST URL). |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
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 | да | Количество байт для генерации (параметр POST URL). |
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
bytes | integer (default: 32) | нет | Количество генерируемых байтов (параметр тела POST). По умолчанию равно 32 (256 бит). |
format | string (default: base64) | нет | Используемый формат кодировки. Может быть “hex” или “base64”. По умолчанию используется “base64”. |
source | string (default: platform) | нет | Из какой системы брать случайные данные: “платформа”, “печать” или “все”. |
Ответы
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
Обновляет оборачивающий токен.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
token | string | нет |
Ответы
200: OK
POST /sys/wrapping/unwrap
ID операции: unwrap
Разворачивает оборачивающий токен.
Параметры тела запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
token | string | нет |
Ответы
200: OK
204: No content
POST /sys/wrapping/wrap
ID операции: wrap
Обертка ответа для произвольного объекта JSON.
Ответы
200: OK