# HyperDX

> Open-source observability platform unifying logs, metrics, traces, session replay and errors on
> ClickHouse and OpenTelemetry. Available self-hosted (MIT), as HyperDX Cloud, and as the user
> interface of ClickStack after ClickHouse acquired HyperDX in March 2025.

This file was generated by the API Evangelist enrichment pipeline on 2026-08-27 from HyperDX's own
published surfaces. HyperDX does not serve an llms.txt of its own — https://www.hyperdx.io/llms.txt
returned 404 on 2026-08-27.

## What you can call

HyperDX has three developer surfaces, and which ones you get depends on which build you run.

- **HyperDX External API (v2)** — 39 REST operations over dashboards, alerts, sources, ClickHouse
  connections, saved searches, webhooks, team management, chart series queries and raw log/trace
  search. Base URL is your own instance: `https://<your-instance>/api/v2`. Ships with the
  open-source build and with ClickStack. **Not served on api.hyperdx.io** — that host returns 404
  for every `/api/v2` path.
- **HyperDX Cloud API (v1)** — alerts, dashboards and chart series at `https://api.hyperdx.io/api/v1`,
  documented as prose. No OpenAPI is published for v1.
- **MCP server** — 27 tools at `{your-hyperdx-url}/api/mcp` over Streamable HTTP. Not available on
  HyperDX Cloud v1.

Authentication on all three is the same: `Authorization: Bearer <personal API access key>`, from
Team Settings → API keys. No OAuth, no OIDC, no scopes. Key rotation was added in release 2.36.0
(2026-08-21).

## Before an agent writes

- **No idempotency key.** A retried POST creates a duplicate. List before you retry a create.
- **No reversal path.** No cancel, undo, restore, soft-delete or version history on any resource,
  and no documented recovery window. Deleting a dashboard also deletes its attached alerts.
- **One guard exists:** deleting a webhook still referenced by an alert returns 409.
- **One dry run exists:** `POST /api/v2/dashboards/validate` checks a dashboard without saving it.
- **Errors** are `application/json` with a single `message` string, prefix-coded by convention
  (`"NOT_FOUND: Alert not found"`). Not RFC 9457. No 429 is declared anywhere in the spec, though
  the v1 Cloud host emits `ratelimit-limit: 100` / `ratelimit-reset: 60`.

## Contract

- OpenAPI 3.0.0 (External API v2): https://github.com/hyperdxio/hyperdx/blob/main/packages/api/openapi.json
- MCP server documentation: https://github.com/hyperdxio/hyperdx/blob/main/MCP.md
- ClickStack API reference: https://clickhouse.com/docs/clickstack/api-reference

## Docs

- Getting started: https://www.hyperdx.io/docs
- Install and SDKs: https://www.hyperdx.io/docs/install
- Search: https://www.hyperdx.io/docs/search
- Alerts: https://www.hyperdx.io/docs/alerts
- Dashboards: https://www.hyperdx.io/docs/dashboards
- v1 API — alerts: https://www.hyperdx.io/docs/api/alerts
- v1 API — dashboards: https://www.hyperdx.io/docs/api/dashboards
- v1 API — chart data: https://www.hyperdx.io/docs/api/charts
- Open source vs Cloud: https://www.hyperdx.io/docs/oss-vs-cloud

## SDKs and tooling

- `@hyperdx/node-opentelemetry` (npm, 0.11.0, 2026-05-26) — Node.js OTel distribution
- `@hyperdx/browser` (npm, 0.25.1, 2026-07-13) — browser SDK with session replay
- `@hyperdx/otel-react-native` (npm, 0.3.0, 2025-01-22) — React Native
- `hyperdx-opentelemetry` (PyPI, 0.4.0, 2026-07-27) — Python OTel distro
- `hyperdx-ruby` (RubyGems, 0.1.2, 2023-05-16) — Ruby, ingestion only, long unmaintained
- `@hyperdx/cli` (npm, 0.6.2, 2026-08-21) — the `hdx` binary; agent-friendly with `--json`,
  NDJSON streaming and documented exit codes

## Operations

- Status page: https://hyperdx.statuspage.io/ (Statuspage v2 API at /api/v2/status.json)
- Changelog: https://github.com/hyperdxio/hyperdx/blob/main/CHANGELOG.md — dated, weekly, with an
  explicit "Breaking Changes" heading on every release
- Source: https://github.com/hyperdxio/hyperdx (MIT)
- Issues: https://github.com/hyperdxio/hyperdx/issues
- Community: https://www.hyperdx.io/discord
- Support: support@hyperdx.io

## Try it

- Live demo, no signup: https://play.hyperdx.io/search
- Local stack: `docker run -p 8080:8080 -p 4317:4317 -p 4318:4318 hyperdxio/hyperdx-local`
- Free Cloud tier: https://www.hyperdx.io/register (3 GB/mo, 3-day retention, 1 user)

## Pricing

- Free — $0/mo, 3 GB/mo, 3-day retention, 1 user
- Starter — $20/mo, 50 GB/mo included, 30-day retention, unlimited users; $0.40 per additional GB,
  $0.40 per 100 metrics
- Enterprise — custom, adds SAML SSO
- Self-hosted open source — free, MIT; no multi-tenancy, alert delivery by webhook only
- Pricing: https://www.hyperdx.io/pricing

## Not published

No security.txt, no /.well-known/ document of any kind on either host, no A2A agent card, no
AsyncAPI, no GraphQL, no gRPC/protobuf, no WSDL, no Postman collection, no public SOC 2 / ISO 27001
attestation, no bug bounty or vulnerability-disclosure page, and no deprecation policy or
Sunset/Deprecation headers. All probed 2026-08-27.