Skip to main content

Get data service health/status


Gets the status of the service.

The status codes returned follow the IETF standard Health Check Response Format for HTTP APIs. For example, pass is returned when the service is up.

The role performing this operation must have the CapDataReader 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*
  • status - string required*

    The status of the service.

"status": "pass"
Navigate to the docs of your local Vault installation to try the API directly from there.

Code examples