2017-11-14 11:13:11 +00:00
|
|
|
|
---
|
2020-01-18 00:18:09 +00:00
|
|
|
|
layout: api
|
|
|
|
|
page_title: /sys/config/control-group - HTTP API
|
|
|
|
|
description: The '/sys/config/control-group' endpoint configures control groups.
|
2017-11-14 11:13:11 +00:00
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# `/sys/config/control-group`
|
|
|
|
|
|
2017-12-19 16:00:02 +00:00
|
|
|
|
~> **Enterprise Only** – These endpoints require Vault Enterprise.
|
|
|
|
|
|
2020-01-18 00:18:09 +00:00
|
|
|
|
The `/sys/config/control-group` endpoint is used to configure Control Group
|
2017-11-14 11:13:11 +00:00
|
|
|
|
settings.
|
|
|
|
|
|
|
|
|
|
## Read Control Group Settings
|
|
|
|
|
|
|
|
|
|
This endpoint returns the current Control Group configuration.
|
|
|
|
|
|
2020-01-18 00:18:09 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :----- | :-------------------------- |
|
|
|
|
|
| `GET` | `/sys/config/control-group` |
|
2017-11-14 11:13:11 +00:00
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
2020-05-21 17:18:17 +00:00
|
|
|
|
```shell-session
|
2017-11-14 11:13:11 +00:00
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/config/control-group
|
2017-11-14 11:13:11 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"max_ttl": "4h"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Configure Control Group Settings
|
|
|
|
|
|
|
|
|
|
This endpoint allows configuring control groups.
|
|
|
|
|
|
2020-01-18 00:18:09 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :----- | :-------------------------- |
|
|
|
|
|
| `PUT` | `/sys/config/control-group` |
|
2017-11-14 11:13:11 +00:00
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
2020-01-18 00:18:09 +00:00
|
|
|
|
- `max_ttl` `int` – The maximum ttl for a control group wrapping token. This can be provided in seconds or duration (2h).
|
2017-11-14 11:13:11 +00:00
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"max_ttl": "4h"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
2020-05-21 17:18:17 +00:00
|
|
|
|
```shell-session
|
2017-11-14 11:13:11 +00:00
|
|
|
|
$ 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/config/control-group
|
2017-11-14 11:13:11 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Delete Control Group Settings
|
|
|
|
|
|
|
|
|
|
This endpoint removes any control group configuration.
|
|
|
|
|
|
2020-01-18 00:18:09 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :------- | :-------------------------- |
|
2019-03-22 16:15:37 +00:00
|
|
|
|
| `DELETE` | `/sys/config/control-group` |
|
2017-11-14 11:13:11 +00:00
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
2020-05-21 17:18:17 +00:00
|
|
|
|
```shell-session
|
2017-11-14 11:13:11 +00:00
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request DELETE \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/config/control-group
|
2017-11-14 11:13:11 +00:00
|
|
|
|
```
|