95af5bf6c7
* Add docs on plugins/backend/reload, add plugin backend guide * Fix docs headers * Fix API endpoint description * Update plugin guide and internals pages
47 lines
1.3 KiB
Markdown
47 lines
1.3 KiB
Markdown
---
|
||
layout: "api"
|
||
page_title: "/sys/plugins/backend/reload - HTTP API"
|
||
sidebar_current: "docs-http-system-plugins-backend-reload"
|
||
description: |-
|
||
The `/sys/plugins/backend/reload` endpoint is used to reload plugin backends.
|
||
---
|
||
|
||
# `/sys/plugins/backend/reload`
|
||
|
||
The `/sys/plugins/backend/reload` endpoint is used to reload mounted plugin
|
||
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 |
|
||
| :------- | :---------------------------- | :--------------------- |
|
||
| `PUT` | `/sys/plugins/backend/reload` | `204 (empty body)` |
|
||
|
||
### Parameters
|
||
|
||
- `plugin` `(string: "")` – The name of the plugin to reload, as
|
||
registered in the plugin catalog.
|
||
|
||
- `mounts` `(slice: [])` – Array or comma separated string mount paths
|
||
of the plugin backends to reload.
|
||
|
||
### Sample Payload
|
||
|
||
```json
|
||
{
|
||
"plugin": "mock-plugin"
|
||
}
|
||
```
|
||
|
||
### Sample Request
|
||
|
||
```
|
||
$ curl \
|
||
--header "X-Vault-Token: ..." \
|
||
--request PUT
|
||
https://vault.rocks/v1/sys/backends/reload
|
||
``` |