mirrors/vault
1
0
Fork 0
mirror of https://github.com/hashicorp/vault.git synced 2026-05-05 04:16:31 +02:00
Code Issues Projects Releases Wiki Activity

Docs: Add filtered paths api docs (#7786)

Browse Source
This commit is contained in:
Michel Vocks 2019-11-12 00:25:48 +01:00 committed by Brian Kassouf
parent c4c15e2cf2
commit edf4e75f0d
1 changed files with 162 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

165
website/source/api/system/replication/replication-performance.html.md
View File

@ -242,7 +242,160 @@ $ curl \
http://127.0.0.1:8200/v1/sys/replication/performance/primary/revoke-secondary
```
## Create Mounts Filter
## Create Paths Filter
This endpoint is used to modify the mounts and namespaces that are filtered to a secondary.
Filtering can be specified in allow mode or deny mode. In allow
mode the secret and auth mounts that are specified are included to the
selected secondary. In deny mode, the mount and namespace paths are excluded.
| Method | Path |
| :------------------------------------------------------- | :--------------------- |
| `POST` | `/sys/replication/performance/primary/paths-filter/:id` |
### Parameters
- `id` `(string: <required>)` – Specifies the unique performance secondary identifier.
- `mode` `(string: "allow")` – Specifies the filtering mode. Available values
are "allow" and "deny".
- `paths` `(array: [])` – The list of mount and namespace paths that are filtered.
### Sample Payload
```json
{
"mode": "allow",
"paths": ["secret/", "ns1/"]
}
```
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/replication/performance/primary/paths-filter/mySecondaryID
```
## Read Paths Filter
This endpoint is used to read the mode and the mount/namespace paths that are filtered
for a secondary.
| Method | Path |
| :------------------------------------------------------- | :--------------------- |
| `GET` | `/sys/replication/performance/primary/paths-filter/:id` | `200 (empty body)` |
### Parameters
- `id` `(string: <required>)` – Specifies the unique performance secondary identifier.
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
http://127.0.0.1:8200/v1/sys/replication/performance/primary/paths-filter/mySecondaryID
```
### Sample Response
```json
{
"mode": "allow",
"paths": ["secret/", "ns1/"]
}
```
## Delete Paths Filter
This endpoint is used to delete the mount and namespace filters for a secondary.
| Method | Path |
| :------------------------------------------------------- | :--------------------- |
| `DELETE` | `/sys/replication/performance/primary/paths-filter/:id` |
### Parameters
- `id` `(string: <required>)` – Specifies the unique performance secondary identifier.
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
--request DELETE \
http://127.0.0.1:8200/v1/sys/replication/performance/primary/paths-filter/mySecondaryID
```
## Read Dynamically Generated Filter (PRIMARY)
This endpoint is used to read the namespace and the mount paths that are dynamically
filtered for a secondary on the primary.
| Method | Path |
| :------------------------------------------------------- | :--------------------- |
| `GET` | `/sys/replication/performance/primary/dynamic-filter/:id` | `200 (empty body)` |
### Parameters
- `id` `(string: <required>)` – Specifies the unique performance secondary identifier.
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
http://127.0.0.1:8200/v1/sys/replication/performance/primary/dynamic-filter/mySecondaryID
```
### Sample Response
```json
{
"dynamic_filtered_mounts": ["ns1/ns2/secret/", "ns1/kv/"],
"dynamic_filtered_namespaces": ["ns1/", "ns1/ns2/"]
}
```
## Read Dynamically Generated Filter (SECONDARY)
This endpoint is used to read the namespace and the mount paths that are dynamically
filtered for a secondary on the secondary.
| Method | Path |
| :------------------------------------------------------- | :--------------------- |
| `GET` | `/sys/replication/performance/secondary/dynamic-filter/:id` | `200 (empty body)` |
### Parameters
- `id` `(string: <required>)` – Specifies the unique performance secondary identifier.
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
http://127.0.0.1:8200/v1/sys/replication/performance/secondary/dynamic-filter/mySecondaryID
```
### Sample Response
```json
{
"dynamic_filtered_mounts": ["ns1/ns2/secret/", "ns1/kv/"],
"dynamic_filtered_namespaces": ["ns1/", "ns1/ns2/"]
}
```
## Create Mounts Filter (DEPRECATED)
~> This API is deprecated and will be removed in a future version of Vault.
Please use Paths Filter instead.
This endpoint is used to modify the mounts that are filtered to a secondary.
Filtering can be specified in whitelist mode or blacklist mode. In whitelist
@ -281,7 +434,10 @@ $ curl \
http://127.0.0.1:8200/v1/sys/replication/performance/primary/mount-filter/us-east-1
```
## Read Mounts Filter
## Read Mounts Filter (DEPRECATED)
~> This API is deprecated and will be removed in a future version of Vault.
Please use Paths Filter instead.
This endpoint is used to read the mode and the mount paths that are filtered
for a secondary.
@ -311,7 +467,10 @@ $ curl \
}
```
## Delete Mounts Filter
## Delete Mounts Filter (DEPRECATED)
~> This API is deprecated and will be removed in a future version of Vault.
Please use Paths Filter instead.
This endpoint is used to delete the mount filters for a secondary.