step ca health

Name

step ca health -- get the status of the CA

Usage

step ca health
[--ca-url=<uri>] [--root=<file>] [--context=<name>]

Description

step ca health makes an API request to the /health endpoint of the Step CA to check if it is running. If the CA is healthy, the response will be 'ok'.

Options

--ca-url=URI URI of the targeted Step Certificate Authority.

--root=file The path to the PEM file used as the root certificate authority.

--context=name The context name to apply for the given command.

Examples

Using the required flags:

With the required flags preconfigured:

--ca-url is set using environment variables (as STEP_CA_URL) or the default configuration file in $STEPPATH/config/defaults.json.

--root is set using environment variables (as STEP_ROOT), the default configuration file in $STEPPATH/config/defaults.json or the default root certificate located in $STEPPATH/certs/root_ca.crt