2018-08-17 16:17:11 +00:00
|
|
|
|
---
|
2020-01-18 00:18:09 +00:00
|
|
|
|
layout: api
|
|
|
|
|
page_title: /sys/namespaces - HTTP API
|
|
|
|
|
description: The `/sys/namespaces` endpoint is used manage namespaces in Vault.
|
2018-08-17 16:17:11 +00:00
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# `/sys/namespaces`
|
|
|
|
|
|
|
|
|
|
The `/sys/namespaces` endpoint is used manage namespaces in Vault.
|
|
|
|
|
|
|
|
|
|
## List Namespaces
|
|
|
|
|
|
|
|
|
|
This endpoints lists all the namespaces.
|
|
|
|
|
|
2020-01-18 00:18:09 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :----- | :---------------- |
|
|
|
|
|
| `LIST` | `/sys/namespaces` |
|
2018-08-17 16:17:11 +00:00
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
2020-05-21 17:18:17 +00:00
|
|
|
|
```shell-session
|
2018-08-17 16:17:11 +00:00
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
-X LIST \
|
|
|
|
|
http://127.0.0.1:8200/v1/sys/namespaces
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
```json
|
2020-01-18 00:18:09 +00:00
|
|
|
|
["ns1/", "ns2/"]
|
2018-08-17 16:17:11 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Create Namespace
|
|
|
|
|
|
|
|
|
|
This endpoint creates a namespace at the givent path.
|
|
|
|
|
|
2020-01-18 00:18:09 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :----- | :---------------------- |
|
|
|
|
|
| `POST` | `/sys/namespaces/:path` |
|
2018-08-17 16:17:11 +00:00
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `path` `(string: <required>)` – Specifies the path where the namespace
|
|
|
|
|
will be namespace. This is specified as part of the URL.
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
2020-05-21 17:18:17 +00:00
|
|
|
|
```shell-session
|
2018-08-17 16:17:11 +00:00
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request POST \
|
|
|
|
|
http://127.0.0.1:8200/v1/sys/namespaces/ns1
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Delete Namespace
|
|
|
|
|
|
|
|
|
|
This endpoint deletes a namespace at the specified path.
|
|
|
|
|
|
2020-01-18 00:18:09 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :------- | :---------------------- |
|
|
|
|
|
| `DELETE` | `/sys/namespaces/:path` |
|
2018-08-17 16:17:11 +00:00
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
2020-05-21 17:18:17 +00:00
|
|
|
|
```shell-session
|
2018-08-17 16:17:11 +00:00
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request DELETE \
|
|
|
|
|
http://127.0.0.1:8200/v1/sys/namespaces/ns1
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Read Namespace Information
|
|
|
|
|
|
|
|
|
|
This endpoint get the metadata for the given namespace path.
|
|
|
|
|
|
2020-01-18 00:18:09 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :----- | :---------------------- |
|
|
|
|
|
| `GET` | `/sys/namespaces/:path` |
|
2018-08-17 16:17:11 +00:00
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
2020-05-21 17:18:17 +00:00
|
|
|
|
```shell-session
|
2018-08-17 16:17:11 +00:00
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
http://127.0.0.1:8200/v1/sys/namespaces/ns1
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"id": "gsudj",
|
|
|
|
|
"path": "ns1/"
|
|
|
|
|
}
|
|
|
|
|
```
|