2017-08-08 16:39:19 +00:00
|
|
|
|
---
|
|
|
|
|
layout: "api"
|
2017-08-16 16:40:38 +00:00
|
|
|
|
page_title: "/sys/plugins/reload/backend - HTTP API"
|
|
|
|
|
sidebar_current: "docs-http-system-plugins-reload-backend"
|
2017-08-08 16:39:19 +00:00
|
|
|
|
description: |-
|
2017-08-16 16:40:38 +00:00
|
|
|
|
The `/sys/plugins/reload/backend` endpoint is used to reload plugin backends.
|
2017-08-08 16:39:19 +00:00
|
|
|
|
---
|
|
|
|
|
|
2017-08-16 16:40:38 +00:00
|
|
|
|
# `/sys/plugins/reload/backend`
|
2017-08-08 16:39:19 +00:00
|
|
|
|
|
2017-08-16 16:40:38 +00:00
|
|
|
|
The `/sys/plugins/reload/backend` endpoint is used to reload mounted plugin
|
2017-08-08 16:39:19 +00:00
|
|
|
|
backends. Either the plugin name (`plugin`) or the desired plugin backend mounts
|
|
|
|
|
(`mounts`) must be provided, but not both. In the case that the plugin name is
|
|
|
|
|
provided, all mounted paths that use that plugin backend will be reloaded.
|
|
|
|
|
|
|
|
|
|
## Reload Plugins
|
|
|
|
|
|
|
|
|
|
This endpoint reloads mounted plugin backends.
|
|
|
|
|
|
|
|
|
|
| Method | Path - | Produces |
|
|
|
|
|
| :------- | :---------------------------- | :--------------------- |
|
2017-08-16 16:40:38 +00:00
|
|
|
|
| `PUT` | `/sys/plugins/reload/backend` | `204 (empty body)` |
|
2017-08-08 16:39:19 +00:00
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `plugin` `(string: "")` – The name of the plugin to reload, as
|
|
|
|
|
registered in the plugin catalog.
|
|
|
|
|
|
2017-08-16 16:40:38 +00:00
|
|
|
|
- `mounts` `(slice: [])` – Array or comma-separated string mount paths
|
2017-08-08 16:39:19 +00:00
|
|
|
|
of the plugin backends to reload.
|
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"plugin": "mock-plugin"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request PUT
|
2017-08-16 16:40:38 +00:00
|
|
|
|
https://vault.rocks/v1/sys/plugins/reload/backend
|
|
|
|
|
```
|