open-vault/website/content/api-docs/system/config-control-group.mdx

84 lines
1.7 KiB
Plaintext
Raw Normal View History

2017-11-14 11:13:11 +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`
~> **Enterprise Only**  These endpoints require Vault Enterprise.
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.
| Method | Path |
| :----- | :-------------------------- |
| `GET` | `/sys/config/control-group` |
2017-11-14 11:13:11 +00:00
### Sample Request
```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.
| Method | Path |
| :----- | :-------------------------- |
| `PUT` | `/sys/config/control-group` |
2017-11-14 11:13:11 +00:00
### Parameters
- `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
```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.
| Method | Path |
| :------- | :-------------------------- |
| `DELETE` | `/sys/config/control-group` |
2017-11-14 11:13:11 +00:00
### Sample Request
```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
```