diff --git a/content/v2.0/reference/cli/influx/_index.md b/content/v2.0/reference/cli/influx/_index.md index 1f52fc294..577d01de3 100644 --- a/content/v2.0/reference/cli/influx/_index.md +++ b/content/v2.0/reference/cli/influx/_index.md @@ -49,6 +49,7 @@ retrieving authentication tokens._ | [bucket](/v2.0/reference/cli/influx/bucket) | Bucket management commands | | [help](/v2.0/reference/cli/influx/help) | Help about any command | | [org](/v2.0/reference/cli/influx/org) | Organization management commands | +| [ping](/v2.0/reference/cli/influx/ping) | Check the InfluxDB `/health` endpoint | | [query](/v2.0/reference/cli/influx/query) | Execute a Flux query | | [repl](/v2.0/reference/cli/influx/repl) | Interactive REPL (read-eval-print-loop) | | [setup](/v2.0/reference/cli/influx/setup) | Create default username, password, org, bucket, etc. | diff --git a/content/v2.0/reference/cli/influx/ping/_index.md b/content/v2.0/reference/cli/influx/ping/_index.md new file mode 100644 index 000000000..9dfa8bba8 --- /dev/null +++ b/content/v2.0/reference/cli/influx/ping/_index.md @@ -0,0 +1,33 @@ +--- +title: influx ping – Check the health of InfluxDB +description: > + The `influx ping` command checks the health of a running InfluxDB instance by + querying the `/health` endpoint. +menu: + v2_0_ref: + name: influx ping + parent: influx +weight: 101 +v2.0/tags: [ping, health] +--- + +The `influx ping` command checks the health of a running InfluxDB instance by +querying the `/health` endpoint. +It does not require an authorization token. + +## Usage +``` +influx ping [flags] +``` + +## Flags +| Flag | Description | +|:---- |:----------- | +| `-h`, `--help` | Help for the `ping` command | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string |