luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity
open-vault/website/source/docs/http/sys-mounts.html.md

3.8 KiB
Raw Blame History

layout page_title sidebar_current description
http HTTP API: /sys/mounts docs-http-mounts-mounts The '/sys/mounts' endpoint is used manage secret backends in Vault.

/sys/mounts

GET

Description
Lists all the mounted secret backends. `default_lease_ttl` or `max_lease_ttl` values of `0` mean that the system defaults are used by this backend.
Method
GET
URL
`/sys/mounts`
Parameters
None
Returns
```javascript
{
  "aws": {
    "type": "aws",
    "description": "AWS keys",
    "config": {
      "default_lease_ttl": 0,
      "max_lease_ttl": 0
    }
  },

  "sys": {
    "type": "system",
    "description": "system endpoint",
    "config": {
      "default_lease_ttl": 0,
      "max_lease_ttl": 0
    }
  }
}
```

POST

Description
Mount a new secret backend to the mount point in the URL.
Method
POST
URL
`/sys/mounts/`
Parameters
  • type required The name of the backend type, such as "aws"
  • description optional A human-friendly description of the mount.
  • config optional Config options for this mount. This is an object with two possible values: `default_lease_ttl` and `max_lease_ttl`. These control the default and maximum lease time-to-live, respectively. If set on a specific mount, this overrides the global defaults.
Returns
`204` response code.

DELETE

Description
Unmount the mount point specified in the URL.
Method
DELETE
URL
`/sys/mounts/`
Parameters
None
Returns
`204` response code.

/sys/mounts/[mount point]/tune

GET

Description
Read the given mount's configuration. Unlike the `mounts` endpoint, this will return the current time in seconds for each TTL, which may be the system default or a mount-specific value.
Method
GET
URL
`/sys/mounts//tune`
Parameters
None
Returns
```javascript
{
  "default_lease_ttl": 3600,
  "max_lease_ttl": 7200
}
```

POST

Description
Tune configuration parameters for a given mount point.
Method
POST
URL
`/sys/mounts//tune`
Parameters
  • default_lease_ttl optional The default time-to-live. If set on a specific mount, overrides the global default. A value of "system" or "0" are equivalent and set to the system default TTL.
  • max_lease_ttl optional The maximum time-to-live. If set on a specific mount, overrides the global default. A value of "system" or "0" are equivalent and set to the system max TTL.
Returns
`204` response code.