Get status of the API services for InfluxDB

GET /status/influx

Get status of the database, key value store, event stream, job queue, indexer as a JSON object.

Responses

200 application/json

Status of database, key value, event stream, job queue and time
Hide response attributes Show response attributes object
- database-up integer
- key-value-store-up integer
- event-stream-up integer
- job-queue-up integer
- indexer-up integer
- time number(float)

GET /status/influx

curl -X GET "http://api.example.com/status/influx" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

import requests

url = "http://api.example.com/status/influx"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json"
}
params = {}
payload = None

response = requests.get(
    url,
    headers=headers,
    params=params,
    json=payload
)

response.raise_for_status()

if response.content:
    print(response.json())

curl \
 --request GET 'http://api.example.com/status/influx' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "database-up": 1,
  "key-value-store-up": 1,
  "event-stream-up": 1,
  "job-queue-up": 1,
  "indexer-up": 1,
  "time": 1701948600.123
}