open-vault/website/pages/api-docs/system/plugins-reload-backend.mdx

48 lines
1.2 KiB
Plaintext
Raw Normal View History

---
layout: api
page_title: /sys/plugins/reload/backend - HTTP API
sidebar_title: <code>/sys/plugins/reload/backend</code>
description: The `/sys/plugins/reload/backend` endpoint is used to reload plugin backends.
---
# `/sys/plugins/reload/backend`
The `/sys/plugins/reload/backend` 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 - |
| :----- | :---------------------------- |
| `PUT` | `/sys/plugins/reload/backend` |
### Parameters
- `plugin` `(string: "")`  The name of the plugin to reload, as
registered in the plugin catalog.
- `mounts` `(array: [])`  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 \
--data @payload.json \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/sys/plugins/reload/backend
```