Skip to main content

Get cluster information


Get Cluster Information.

Returns the vault's generation and the generations of all the workers (data servers).

The role that performs this operation must have the CapClusterInfoReader capability. See Access control for more information about how capabilities are used to control access to operations.

Possible responses

The request is successful.

object required*
  • vault - object required*

    Vault Generation.

    • generation_number - integer required*

      Generation number.

    • modified_at - string required*

      Modified at.

  • workers - array of objects required*

    Workers generations.

    Each object:


    • worker_id - integer required*

      Worker id.

    • generation_number - integer required*

      Generation number.

    • generation_checked_at - string required*

      Modified at.

    • refresh_interval_seconds - integer required*

      Refresh interval in seconds.

"vault": {
"generation_number": 0,
"modified_at": "2019-08-24T14:15:22Z"
"workers": [
"worker_id": 0,
"generation_number": 0,
"generation_checked_at": "2019-08-24T14:15:22Z",
"refresh_interval_seconds": 0

Try the API


Navigate to the docs of your local Vault installation to try the API directly from there.

Code examples