`/sys/namespaces`

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

1. Список пространств имен

Данная конечная точка возвращает список всех пространств имен.

Метод Путь

Метод	Путь
`LIST`	`/sys/namespaces`

LIST

/sys/namespaces

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

$ curl \
    --header "X-Vault-Token: ..." \
    -X LIST \
    http://127.0.0.1:8200/v1/sys/namespaces

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

{
  "data": {
    "key_info": {
      "bar/": {
        "custom_metadata": {},
        "id": "HWmNL",
        "path": "bar/"
      },
      "foo/": {
        "custom_metadata": {},
        "id": "5q39x",
        "path": "foo/"
      }
    },
    "keys": [
      "bar/",
      "foo/"
    ]
  }
}

2. Создание пространств имен

Данная конечная точка отвечает за создание пространств имен.

Метод Путь

Метод	Путь
`POST`	`/sys/namespaces/:path`

POST

/sys/namespaces/:path

2.1. Параметры

path (string)– указывает путь, по которому будет создано пространство имен;
custom_metadata (map<string|string>)- отображение произвольной строки в строковые значения предоставленных пользователем метаданных. Параметр необходим для описания пространства имен.

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

{
  "custom_metadata": {
    "foo": "abc",
    "bar": "123"
  }
}

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

$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/sys/namespaces/ns1

3. Пространство имен патча

Данная конечная точка исправляет существующее пространство имен по указанному пути.

Метод Путь

Метод	Путь
`PATCH`	`/sys/namespaces/:path`

PATCH

/sys/namespaces/:path

3.1. Параметры

path (string) – указывает путь к существующему пространству имен.
custom_metadata (map<string|string>)- отображение произвольной строки в строковые значения предоставленных пользователем метаданных. Параметр необходим для описания пространства имен.

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

{
  "custom_metadata": {
    "foo": "abc",
    "bar": "123"
  }
}

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

$ curl \
    --header "X-Vault-Token: ..." \
    --header "Content-Type: application/merge-patch+json"
    --request PATCH \
    --data @payload.json \
    http://127.0.0.1:8200/v1/sys/namespaces/ns1

4. Удаление пространств имен

Данная конечная точка отвечает за удаление пространств имен по указанному пути.

Метод Путь

Метод	Путь
`DELETE`	`/sys/namespaces/:path`

DELETE

/sys/namespaces/:path

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

$ curl \
    --header "X-Vault-Token: ..." \
    --request DELETE \
    http://127.0.0.1:8200/v1/sys/namespaces/ns1

5. Чтение информации о пространстве имен

Данная конечная точка позволяет получить метаданные для заданного пути пространства имен.

Метод Путь

Метод	Путь
`GET`	`/sys/namespaces/:path`

GET

/sys/namespaces/:path

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

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/sys/namespaces/ns1

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

{
  "id": "gsudj",
  "path": "ns1/",
  "custom_metadata": {
    "foo": "abc",
    "bar": "123"
  }
}