Skip to main content

/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.

MethodPath
GET/sys/config/ui/headers/:name

Parameters​

  • name (string: <required>) – The name of the custom header.

  • multivalue (bool: <optional>) - Returns multiple values if true.

Sample request​

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/sys/config/ui/headers/X-Custom-Header

Sample response​

{
  "value": "custom-value"
}

Sample request (Multi value)​

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/sys/config/ui/headers/X-Custom-Header?multivalue=true

Sample response​

{
  "values": ["custom-value-1", "custom-value-2"]
}

Configure UI headers​

This endpoint allows configuring the values to be returned for the UI header.

MethodPath
POST/sys/config/ui/headers/:name

Parameters​

  • name (string: <required>) – The name of the custom header.

  • values (list: <required>) - The values to be returned from the header.

Sample payload​

{
  "values": ["custom value 1", "custom value 2"]
}

Sample request​

$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --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.

MethodPath
DELETE/sys/config/ui/headers/:name

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.

MethodPath
LIST/sys/config/ui/headers

Sample request​

$ curl \
    --header "X-Vault-Token: ..." \
    --request LIST \
    http://127.0.0.1:8200/v1/sys/config/ui/headers

Sample response​

{
  "data": {
    "keys": ["X-Custom...", "X-Header..."]
  }
}