mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-31 19:41:12 +02:00
0660ea6fac
* 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>
85 lines
2.4 KiB
Plaintext
85 lines
2.4 KiB
Plaintext
---
|
|
layout: api
|
|
page_title: /sys/config/state - HTTP API
|
|
description: The '/sys/config/state' endpoint is used to retrieve the configuration state.
|
|
---
|
|
|
|
> [!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/state`
|
|
|
|
@include 'alerts/restricted-root.mdx'
|
|
|
|
The endpoints under `sys/config/state` return Vault's configuration state.
|
|
Currently, it only supports returning a sanitized version of the configuration.
|
|
|
|
## Get sanitized configuration state
|
|
|
|
This endpoint returns a sanitized version of the configuration state. The
|
|
configuration excludes certain fields and mappings in the configuration file
|
|
that can potentially contain sensitive information, which includes values from
|
|
`Storage.Config`, `HAStorage.Config`, `Seals.Config` and the
|
|
`Telemetry.CirconusAPIToken` value.
|
|
|
|
| Method | Path |
|
|
| :----- | :---------------------------- |
|
|
| `GET` | `/sys/config/state/sanitized` |
|
|
|
|
### Sample request
|
|
|
|
```shell-session
|
|
$ curl \
|
|
--header "X-Vault-Token: ..." \
|
|
'http://127.0.0.1:8200/v1/sys/config/state/sanitized'
|
|
```
|
|
|
|
### Sample response
|
|
|
|
```json
|
|
{
|
|
"api_addr": "http://127.0.0.1:8200",
|
|
"cache_size": 0,
|
|
"cluster_addr": "",
|
|
"cluster_cipher_suites": "",
|
|
"cluster_name": "",
|
|
"default_lease_ttl": 0,
|
|
"default_max_request_duration": 0,
|
|
"disable_cache": false,
|
|
"disable_clustering": false,
|
|
"disable_indexing": false,
|
|
"disable_mlock": false,
|
|
"disable_performance_standby": false,
|
|
"disable_printable_check": false,
|
|
"disable_sealwrap": false,
|
|
"enable_ui": true,
|
|
"listeners": [
|
|
{
|
|
"config": {
|
|
"address": "127.0.0.1:8200",
|
|
"tls_disable": 1
|
|
},
|
|
"type": "tcp"
|
|
}
|
|
],
|
|
"log_format": "",
|
|
"log_level": "",
|
|
"max_lease_ttl": 0,
|
|
"pid_file": "",
|
|
"plugin_directory": "/opt/vault/plugins",
|
|
"raw_storage_endpoint": false,
|
|
"seals": [
|
|
{
|
|
"disabled": false,
|
|
"type": "shamir"
|
|
}
|
|
],
|
|
"storage": {
|
|
"cluster_addr": "",
|
|
"disable_clustering": false,
|
|
"redirect_addr": "http://127.0.0.1:8200",
|
|
"type": "inmem"
|
|
}
|
|
}
|
|
```
|