mirror of
https://github.com/optim-enterprises-bv/vault.git
synced 2025-11-01 19:17:58 +00:00
Add experiment system + events experiment (#18682)
This commit is contained in:
46
website/content/api-docs/system/experiments.mdx
Normal file
46
website/content/api-docs/system/experiments.mdx
Normal file
@@ -0,0 +1,46 @@
|
||||
---
|
||||
layout: api
|
||||
page_title: /sys/experiments - HTTP API
|
||||
description: The `/sys/experiments` endpoint returns information about experiments on the Vault node.
|
||||
---
|
||||
|
||||
# `/sys/experiments`
|
||||
|
||||
The `/sys/experiments` endpoint returns information about experiments on the Vault node.
|
||||
|
||||
## Read Experiments
|
||||
|
||||
This endpoint returns the experiments available and enabled on the Vault node.
|
||||
Experiments are per-node and cannot be changed while the node is running. See
|
||||
the [`-experiment`](/docs/commands/server#experiment) flag and the
|
||||
[`experiments`](/docs/configuration#experiments) config key documentation for
|
||||
details on enabling experiments.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :----------------- |
|
||||
| `GET` | `/sys/experiments` |
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
$ curl \
|
||||
http://127.0.0.1:8200/v1/sys/experiments
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
||||
```json
|
||||
{
|
||||
"request_id": "cb48b1e2-635c-52e9-db79-ad9a54ed3e88",
|
||||
"lease_id": "",
|
||||
"lease_duration": 0,
|
||||
"renewable": false,
|
||||
"data": {
|
||||
"available": [
|
||||
"events.beta1"
|
||||
],
|
||||
"enabled": []
|
||||
},
|
||||
"warnings": null
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user