open-vault/website/source/api/system/internal-ui-mounts.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

1.3 KiB

layout page_title sidebar_title sidebar_current description
api /sys/internal/ui/mounts - HTTP API <code>/sys/internal/ui/mounts</code> api-http-system-internal-ui-mounts The `/sys/internal/ui/mounts` endpoint is used to manage mount listing visibility.

/sys/internal/ui/mounts

The /sys/internal/ui/mounts endpoint is used to manage mount listing visibility. The response generated by this endpoint is based on the listing_visibility value on the mount, which can be set during mount time or via mount tuning. This is currently only being used internally for the UI and is an unauthenticated endpoint.

Due to the nature of its intended usage, there is no guarantee on backwards compatibility for this endpoint.

Get Available Visible Mounts

This endpoint lists all enabled auth methods.

Method Path Produces
GET /sys/internal/ui/mounts 200 application/json

Sample Request

$ curl \
    http://127.0.0.1:8200/v1/sys/internal/ui/mounts

Sample Response

{
  "auth": {
    "github/": {
      "description": "GitHub auth",
      "type": "github"
    }
  },
  "secret": {
    "custom-secrets/": {
      "description": "Custom secrets",
      "type": "kv"
    }
  }
}