/sys/namespaces
The /sys/namespaces
endpoint is used manage namespaces in Vault.
List Namespaces
This endpoints lists all the namespaces.
Method | Path |
---|---|
LIST | /sys/namespaces |
Sample Request
Sample Response
Create Namespace
This endpoint creates a namespace at the given path.
Method | Path |
---|---|
POST | /sys/namespaces/:path |
Parameters
path
(string: <required>)
– Specifies the path where the namespace will be created.
Sample Request
Delete Namespace
This endpoint deletes a namespace at the specified path.
Method | Path |
---|---|
DELETE | /sys/namespaces/:path |
Sample Request
Read Namespace Information
This endpoint gets the metadata for the given namespace path.
Method | Path |
---|---|
GET | /sys/namespaces/:path |
Sample Request
Sample Response
Lock Namespace
This endpoint locks the API for the current namespace path or optional subpath. The behavior when interacting with Vault from a locked namespace is described in API Locked Response.
Method | Path |
---|---|
POST | /sys/namespaces/api-lock/lock/:subpath |
Sample Request - Current Namespace
Sample Response - Current Namespace
Sample Request - X-Vault-Namespace
Sample Response - X-Vault-Namespace
Sample Request - Descendant of Current Namespace
Sample Response - Descendant of Current Namespace
Unlock Namespace
This endpoint unlocks the api for the current namespace path or optional subpath.
Method | Path |
---|---|
POST | /sys/namespaces/api-lock/unlock/:subpath |
Sample Payload - Current Namespace Non-Root
Sample Request - Current Namespace Non-Root
Sample Request - Current Namespace Root
Sample Payload - Descendant Namespace Non-Root
Sample Request - Descendant Namespace Non-Root