`/sys/raw`

Конечная точка /sys/raw используется для доступа к необработанному базовому хранилищу в StarVault.

Эта конечная точка отключена по умолчанию. Чтобы включить её, см. документацию по настройке StarVault.

1. Чтение raw

Данная конечная точка считывает значение ключа по указанному пути. Это необработанный путь в системе хранения, а не логический путь, предоставляемый через систему монтирования.

Метод

Путь

GET

/sys/raw/:path

1.1. Параметры

path (string: <required>) – указывает необработанный путь к файлу в системе хранения данных. Он указывается как часть URL-адреса.
compressed (bool: true) - попытка распаковать значение.
encoding (string: "") — задаёт кодировку возвращаемых данных. По умолчанию кодировка отсутствует. «base64» возвращает значение, закодированное в формате base64.

Пример запроса:

curl \
  --header "X-Vault-Token: ..." \
  http://127.0.0.1:8200/v1/sys/raw/secret/foo

Пример ответа:

{
  "value": "{'foo':'bar'}"
}

2. Создание/обновление raw

Данная конечная точка обновляет значение ключа по указанному пути. Это необработанный путь в системе хранения, а не логический путь, предоставляемый через систему монтирования.

Метод

Путь

POST

/sys/raw/:path

2.1. Параметры

path (string: <required>) – указывает необработанный путь к файлу в системе хранения данных. Он указывается как часть URL-адреса.
value (string: <required>) – указывает значение ключа.
compression_type (string: "") - создание/обновление с использованием сжатой формы value. Поддерживаемые compression_type значения: gzip, lzw, lz4, snappy, или "". "" означает, что сжатие не используется. Если параметр пропущен и ключ уже существует, обновление использует то же сжатие (или не использует его), что и существующее значение.
encoding (string: "") — указывает кодировку value. По умолчанию кодировка отсутствует. Используйте «base64», если в value используется кодировка base64.

Пример тела запроса:

{
  "value": "{\"foo\": \"bar\"}"
}

Пример запроса:

curl \
  --header "X-Vault-Token: ..." \
  --request POST \
  --data @payload.json \
  http://127.0.0.1:8200/v1/sys/raw/secret/foo

3. Список raw

Эта конечная точка возвращает список ключей для заданного префикса пути.

Для данной конечной точки требуются sudo-права.

Метод

Путь

LIST

/sys/raw/:prefix

GET

/sys/raw/:prefix?list=true

Пример запроса:

curl \
  --header "X-Vault-Token: ..." \
  --request LIST \
  http://127.0.0.1:8200/v1/sys/raw/logical

Пример ответа:

{
  "data": {
    "keys": ["abcd-1234...", "efgh-1234...", "ijkl-1234..."]
  }
}

4. Удаление raw

Эта конечная точка удаляет ключ по указанному пути. Это необработанный путь в системе хранения, а не логический путь, предоставляемый через систему монтирования.

Метод

Путь

DELETE

/sys/raw/:path

4.1. Параметры

path (string: <required>) – указывает необработанный путь к файлу в системе хранения данных. Он указывается как часть URL-адреса.

Пример запроса:

curl \
  --header "X-Vault-Token: ..." \
  --request DELETE \
  http://127.0.0.1:8200/v1/sys/raw/secret/foo