open-vault/website/source/api/system/config-ui.html.md
RJ Spiker fca7cb3794 website: update sidebar_title in front matter to use <code> (#5636)
* website: replace deprecated <tt> with <code> in front matter sidebar_title

* website: wrap front matter sidebar_title in <code> for commands pages
2018-10-29 15:58:37 -04:00

124 lines
2.7 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
layout: "api"
page_title: "/sys/config/ui - HTTP API"
sidebar_title: "<code>/sys/config/ui</code>"
sidebar_current: "api-http-system-config-ui"
description: |-
The '/sys/config/ui' endpoint configures the UI.
---
# `/sys/config/ui`
The `/sys/config/ui` endpoint is used to configure UI settings.
- **`sudo` required**  All UI endpoints require `sudo` capability in
addition to any path-specific capabilities.
## Read UI Settings
This endpoint returns the given UI header configuration.
| Method | Path | Produces |
| :------- | :--------------------------- | :--------------------- |
| `GET` | `/sys/config/ui/headers/:name` | `200 application/json` |
### Parameters
- `name` `(string: <required>)`  The name of the custom header.
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
http://127.0.0.1:8200/v1/sys/config/ui/headers/X-Custom-Header
```
### Sample Response
```json
{
"value": "custom-value"
}
```
## Configure UI Headers
This endpoint allows configuring the values to be returned for the UI header.
| Method | Path | Produces |
| :------- | :--------------------------- | :--------------------- |
| `PUT` | `/sys/config/ui/headers/:name` | `204 (empty body)` |
### Parameters
- `name` `(string: <required>)`  The name of the custom header.
- `values` `(list: <required>)` - The values to be returned from the header.
### Sample Payload
```json
{
"values": ["custom value 1", "custom value 2"]
}
```
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
--request PUT \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/config/ui/headers/X-Custom-Header
```
## Delete a UI Header
This endpoint removes a UI header.
| Method | Path | Produces |
| :------- | :--------------------------- | :--------------------- |
| `DELETE` | `/sys/config/ui/headers/:name`| `204 (empty body)` |
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
--request DELETE \
http://127.0.0.1:8200/v1/sys/config/ui/headers/X-Custom-Header
```
## List UI Headers
This endpoint returns a list of configured UI headers.
| Method | Path | Produces |
| :------- | :--------------------------- | :--------------------- |
| `LIST` | `/sys/config/ui/headers` | `200 application/json` |
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
--request LIST \
http://127.0.0.1:8200/v1/sys/config/ui/headers
```
### Sample Response
```json
{
"data":{
"keys":[
"X-Custom...",
"X-Header...",
]
}
}
```