vault/website/content/api-docs/system/config-control-group.mdx
Erica Thompson 0660ea6fac
Update README (#31244)
* Update README

Let contributors know that docs will now be located in UDR

* Add comments to each mdx doc

Comment has been added to all mdx docs that are not partials

* chore: added changelog

changelog check failure

* wip: removed changelog

* Fix content errors

* Doc spacing

* Update website/content/docs/deploy/kubernetes/vso/helm.mdx

Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>

---------

Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com>
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2025-07-22 08:12:22 -07:00

87 lines
2.1 KiB
Plaintext
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
layout: api
page_title: /sys/config/control-group - HTTP API
description: The '/sys/config/control-group' endpoint configures control groups.
---
> [!IMPORTANT]
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
# `/sys/config/control-group`
@include 'alerts/enterprise-only.mdx'
The `/sys/config/control-group` endpoint is used to configure Control Group
settings.
## Read control group settings
This endpoint returns the current Control Group configuration.
| Method | Path |
| :----- | :-------------------------- |
| `GET` | `/sys/config/control-group` |
### Sample request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
http://127.0.0.1:8200/v1/sys/config/control-group
```
### Sample response
```json
{
"max_ttl": "4h"
}
```
## Configure control group settings
This endpoint allows configuring control groups.
| Method | Path |
| :----- | :-------------------------- |
| `POST` | `/sys/config/control-group` |
### Parameters
- `max_ttl` `int`  The maximum ttl for a control group wrapping token. This can be provided in seconds or duration (2h).
### Sample payload
```json
{
"max_ttl": "4h"
}
```
### Sample request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/config/control-group
```
## Delete control group settings
This endpoint removes any control group configuration.
| Method | Path |
| :------- | :-------------------------- |
| `DELETE` | `/sys/config/control-group` |
### Sample request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request DELETE \
http://127.0.0.1:8200/v1/sys/config/control-group
```