mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-22 15:11:07 +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>
88 lines
2.1 KiB
Plaintext
88 lines
2.1 KiB
Plaintext
---
|
|
layout: api
|
|
page_title: /sys/host-info - HTTP API
|
|
description: The '/sys/host-info' endpoint is used to retrieve host information
|
|
---
|
|
|
|
> [!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/host-info`
|
|
|
|
@include 'alerts/restricted-root.mdx'
|
|
|
|
The `/sys/host-info` endpoint is used retrieve information about the
|
|
host instance that the Vault server is running on.
|
|
|
|
## Collect host information
|
|
|
|
This endpoint returns information about the host instance that the Vault
|
|
server is running on. The data returned includes CPU information, CPU
|
|
times, disk usage, host info, and memory statistics.
|
|
|
|
| Method | Path |
|
|
| :----- | :--------------- |
|
|
| `GET` | `/sys/host-info` |
|
|
|
|
### Sample request
|
|
|
|
```shell-session
|
|
$ curl \
|
|
--header "X-Vault-Token: ..." \
|
|
http://127.0.0.1:8200/v1/sys/host-info
|
|
```
|
|
|
|
### Sample response
|
|
|
|
```json
|
|
{
|
|
"data": {
|
|
"cpu": [
|
|
{
|
|
"cpu": 0,
|
|
"vendorId": "GenuineIntel",
|
|
"family": "6",
|
|
"model": "78",
|
|
...
|
|
},
|
|
...
|
|
],
|
|
"cpu_times": [
|
|
{
|
|
"cpu": "cpu",
|
|
"user": 7491,
|
|
"system": 16833,
|
|
"idle": 5726276,
|
|
...
|
|
},
|
|
...
|
|
],
|
|
"disk": [
|
|
{
|
|
"path": "/",
|
|
"fstype": "ext4",
|
|
"total": 410352476160,
|
|
"free": 102141169664,
|
|
"used": 306428051456,
|
|
...
|
|
},
|
|
...
|
|
],
|
|
"host": {
|
|
"hostname": "vault-server-1",
|
|
"uptime": 28618,
|
|
"bootTime": 1570114491,
|
|
"procs": 439,
|
|
...
|
|
},
|
|
"memory": {
|
|
"total": 17179869184,
|
|
"available": 6203424768,
|
|
"used": 10976444416,
|
|
...
|
|
},
|
|
"timestamp": "2019-10-03T22:51:49.715927Z"
|
|
}
|
|
}
|
|
```
|