mirror of
https://github.com/optim-enterprises-bv/vault.git
synced 2025-11-03 20:17:59 +00:00
61d67d0e73
The operations are handled identically, but ~85% of the references were POST, and having a mix of PUT and POST was a source of questions. A subsequent commit will update the internal use of "PUT" such as by the API client and -output-curl-string.
51 lines
1.4 KiB
Plaintext
51 lines
1.4 KiB
Plaintext
---
|
||
layout: api
|
||
page_title: /sys/plugins/reload/backend - HTTP API
|
||
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 - |
|
||
| :----- | :---------------------------- |
|
||
| `POST` | `/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.
|
||
|
||
- `scope` `(string: "")` - The scope of the reload. If omitted, reloads the
|
||
plugin or mounts on this Vault instance. If 'global', will begin reloading the
|
||
plugin on all instances of a cluster.
|
||
|
||
### Sample Payload
|
||
|
||
```json
|
||
{
|
||
"plugin": "mock-plugin"
|
||
}
|
||
```
|
||
|
||
### Sample Request
|
||
|
||
```shell-session
|
||
$ curl \
|
||
--header "X-Vault-Token: ..." \
|
||
--request POST \
|
||
--data @payload.json \
|
||
http://127.0.0.1:8200/v1/sys/plugins/reload/backend
|
||
```
|