2018-08-17 16:17:11 +00:00
|
|
|
|
---
|
|
|
|
|
|
layout: "api"
|
|
|
|
|
|
page_title: "/sys/namespaces - HTTP API"
|
2018-10-29 19:58:37 +00:00
|
|
|
|
sidebar_title: "<code>/sys/namespaces</code>"
|
New Docs Website (#5535)
* conversion stage 1
* correct image paths
* add sidebar title to frontmatter
* docs/concepts and docs/internals
* configuration docs and multi-level nav corrections
* commands docs, index file corrections, small item nav correction
* secrets converted
* auth
* add enterprise and agent docs
* add extra dividers
* secret section, wip
* correct sidebar nav title in front matter for apu section, start working on api items
* auth and backend, a couple directory structure fixes
* remove old docs
* intro side nav converted
* reset sidebar styles, add hashi-global-styles
* basic styling for nav sidebar
* folder collapse functionality
* patch up border length on last list item
* wip restructure for content component
* taking middleman hacking to the extreme, but its working
* small css fix
* add new mega nav
* fix a small mistake from the rebase
* fix a content resolution issue with middleman
* title a couple missing docs pages
* update deps, remove temporary markup
* community page
* footer to layout, community page css adjustments
* wip downloads page
* deps updated, downloads page ready
* fix community page
* homepage progress
* add components, adjust spacing
* docs and api landing pages
* a bunch of fixes, add docs and api landing pages
* update deps, add deploy scripts
* add readme note
* update deploy command
* overview page, index title
* Update doc fields
Note this still requires the link fields to be populated -- this is solely related to copy on the description fields
* Update api_basic_categories.yml
Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages.
* Add bottom hero, adjust CSS, responsive friendly
* Add mega nav title
* homepage adjustments, asset boosts
* small fixes
* docs page styling fixes
* meganav title
* some category link corrections
* Update API categories page
updated to reflect the second level headings for api categories
* Update docs_detailed_categories.yml
Updated to represent the existing docs structure
* Update docs_detailed_categories.yml
* docs page data fix, extra operator page remove
* api data fix
* fix makefile
* update deps, add product subnav to docs and api landing pages
* Rearrange non-hands-on guides to _docs_
Since there is no place for these on learn.hashicorp, we'll put them
under _docs_.
* WIP Redirects for guides to docs
* content and component updates
* font weight hotfix, redirects
* fix guides and intro sidenavs
* fix some redirects
* small style tweaks
* Redirects to learn and internally to docs
* Remove redirect to `/vault`
* Remove `.html` from destination on redirects
* fix incorrect index redirect
* final touchups
* address feedback from michell for makefile and product downloads
2018-10-19 15:40:11 +00:00
|
|
|
|
sidebar_current: "api-http-system-namespaces"
|
2018-08-17 16:17:11 +00:00
|
|
|
|
description: |-
|
|
|
|
|
|
The `/sys/namespaces` endpoint is used manage namespaces in Vault.
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
# `/sys/namespaces`
|
|
|
|
|
|
|
|
|
|
|
|
The `/sys/namespaces` endpoint is used manage namespaces in Vault.
|
|
|
|
|
|
|
|
|
|
|
|
## List Namespaces
|
|
|
|
|
|
|
|
|
|
|
|
This endpoints lists all the namespaces.
|
|
|
|
|
|
|
2019-03-22 16:15:37 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
|
| :--------------------------- | :--------------------- |
|
|
|
|
|
|
| `LIST` | `/sys/namespaces` |
|
2018-08-17 16:17:11 +00:00
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
$ curl \
|
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
|
-X LIST \
|
|
|
|
|
|
http://127.0.0.1:8200/v1/sys/namespaces
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
|
[
|
|
|
|
|
|
"ns1/",
|
|
|
|
|
|
"ns2/"
|
|
|
|
|
|
]
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## Create Namespace
|
|
|
|
|
|
|
|
|
|
|
|
This endpoint creates a namespace at the givent path.
|
|
|
|
|
|
|
2019-03-22 16:15:37 +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
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
$ 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.
|
|
|
|
|
|
|
2019-03-22 16:15:37 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
|
| :--------------------------- | :--------------------- |
|
2018-08-17 16:17:11 +00:00
|
|
|
|
| `DELETE` | `/sys/namespaces/:path` | `204 (empty body) ` |
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
$ 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.
|
|
|
|
|
|
|
2019-03-22 16:15:37 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
|
| :--------------------------- | :--------------------- |
|
|
|
|
|
|
| `GET` | `/sys/namespaces/:path` |
|
2018-08-17 16:17:11 +00:00
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
$ curl \
|
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
|
http://127.0.0.1:8200/v1/sys/namespaces/ns1
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
|
{
|
|
|
|
|
|
"id": "gsudj",
|
|
|
|
|
|
"path": "ns1/"
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|