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

»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

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

»Sample Response

{
  "value": "custom-value"
}

{  "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

$ 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"]
}

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

»Configure UI Headers

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

»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"]
}

{  "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

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

»Sample Request

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

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

»Sample Request

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

$ 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..."]
  }
}

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