---
title: Health
description: Check the health and readiness of an InfluxDB OSS v2 instance.
url: https://docs.influxdata.com/influxdb/v2/api/health/
estimated_tokens: 370
product: InfluxDB OSS v2
version: v2
publisher: InfluxData
canonical: https://docs.influxdata.com/influxdb/v2/api/health/
---

[Download InfluxDB API Spec](/openapi/influxdb-oss-v2-api.yml)

Check the health and readiness of an InfluxDB OSS v2 instance.

GET`/health`

### Retrieve the health of the instance

Returns the health of the instance.

#### Parameters

##### Header parameters

`Zap-Trace-Span`string

OpenTracing span context

Example request[Ask AI about this](#)

```sh
curl --request GET \
  "http://localhost:8086/health" \
  --header "Authorization: Bearer INFLUX_TOKEN"
```

#### Responses

200The instance is healthy.
The response body contains the health check items and status.

`checks`object[]

`commit`string

`message`string

`name`requiredstring

`status`requiredstring

Allowed:`pass`, `fail`

`version`string

503The instance is unhealthy.

`checks`object[]

`commit`string

`message`string

`name`requiredstring

`status`requiredstring

Allowed:`pass`, `fail`

`version`string

defaultNon 2XX error response from server.

`code`requiredstring

code is the machine-readable error code.

Allowed:`internal error`, `not implemented`, `not found`, `conflict`, `invalid`, `unprocessable entity`, `empty value`, `unavailable`, `forbidden`, `too many requests`, `unauthorized`, `method not allowed`, `request too large`, `unsupported media type`

`err`string

Stack of errors that occurred during processing of the request. Useful for debugging.

`message`string

Human-readable message.

`op`string

Describes the logical code operation when the error occurred. Useful for debugging.
