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

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

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

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