---
title: "Check HEC health"
method: GET
path: "/services/collector/health"
tags: ["hec"]
---

# Check HEC health

`GET /services/collector/health`

## Request

- Base URL: `https://hec.{axiom-domain}`
- URL: `https://hec.{axiom-domain}/services/collector/health`
- Auth: none required
- TypeScript: <https://skmtc.dev/axiom/apis/axiom-hec/docs/services/collector/health/get.ts> (a function with typed inputs; its response is checked against the schema)

Reports whether the HEC endpoint is accepting data. Requires no authentication and returns HEC code `17` when healthy.

## Response `200`

The collector is healthy.

- HecStatus: The Splunk HEC status envelope.
  - `text` string, required: A human-readable status message.
  - `code` integer, required: The Splunk status code. `0` indicates success, `17` indicates a healthy collector, and `5`, `6`, and `7` indicate no data, invalid data format, and incorrect index respectively.

---

[API](https://skmtc.dev/axiom/apis/axiom-hec.md) - [All operations](https://skmtc.dev/axiom/apis/axiom-hec/llms.txt) - [OpenAPI document](https://skmtc.dev/axiom/apis/axiom-hec/revisions/72333289959e?raw)
