1---
2layout: "api"
3page_title: "/sys/config/ui - HTTP API"
4sidebar_title: "<code>/sys/config/ui</code>"
5sidebar_current: "api-http-system-config-ui"
6description: |-
7  The '/sys/config/ui' endpoint configures the UI.
8---
9
10# `/sys/config/ui`
11
12The `/sys/config/ui` endpoint is used to configure UI settings.
13
14- **`sudo` required** – All UI endpoints require `sudo` capability in
15  addition to any path-specific capabilities.
16
17## Read UI Settings
18
19This endpoint returns the given UI header configuration.
20
21| Method   | Path                         |
22| :--------------------------- | :--------------------- |
23| `GET`    | `/sys/config/ui/headers/:name` |
24
25### Parameters
26
27- `name` `(string: <required>)` – The name of the custom header.
28
29### Sample Request
30
31```
32$ curl \
33    --header "X-Vault-Token: ..." \
34    http://127.0.0.1:8200/v1/sys/config/ui/headers/X-Custom-Header
35```
36
37### Sample Response
38
39```json
40{
41  "value": "custom-value"
42}
43```
44
45## Configure UI Headers
46
47This endpoint allows configuring the values to be returned for the UI header.
48
49| Method   | Path                         |
50| :--------------------------- | :--------------------- |
51| `PUT`    | `/sys/config/ui/headers/:name` |
52
53### Parameters
54
55- `name` `(string: <required>)` – The name of the custom header.
56
57- `values` `(list: <required>)` - The values to be returned from the header.
58
59### Sample Payload
60
61```json
62{
63  "values": ["custom value 1", "custom value 2"]
64}
65```
66
67### Sample Request
68
69```
70$ curl \
71    --header "X-Vault-Token: ..." \
72    --request PUT \
73    --data @payload.json \
74    http://127.0.0.1:8200/v1/sys/config/ui/headers/X-Custom-Header
75```
76
77## Delete a UI Header
78
79This endpoint removes a UI header.
80
81| Method   | Path                         |
82| :--------------------------- | :--------------------- |
83| `DELETE` | `/sys/config/ui/headers/:name`|
84
85### Sample Request
86
87```
88$ curl \
89    --header "X-Vault-Token: ..." \
90    --request DELETE \
91    http://127.0.0.1:8200/v1/sys/config/ui/headers/X-Custom-Header
92```
93
94## List UI Headers
95
96This endpoint returns a list of configured UI headers.
97
98| Method   | Path                         |
99| :--------------------------- | :--------------------- |
100| `LIST`   | `/sys/config/ui/headers`   |
101
102
103### Sample Request
104
105```
106$ curl \
107    --header "X-Vault-Token: ..." \
108    --request LIST \
109    http://127.0.0.1:8200/v1/sys/config/ui/headers
110```
111
112### Sample Response
113
114```json
115{
116  "data":{
117    "keys":[
118      "X-Custom...",
119      "X-Header...",
120    ]
121  }
122}
123```
124