API Reference

https://api.hyrelog.com

Authentication

Most /v1/* endpoints require Authorization: Bearer YOUR_API_KEY.
/health does not require authentication.

Core Endpoint Groups

Events: ingest and query audit events
API Keys: key status and dashboard-managed key lifecycle
Webhooks: create/list/enable/disable webhooks and inspect deliveries
Exports: create export jobs, check status, download data

Dashboard API (not in OpenAPI)

Routes under /dashboard/* power app.hyrelog.com (Event Explorer, saved views, dashboard exports). They use session authentication and are excluded from openapi.json by design.

See Dashboard API overview and the Dashboard product guides.

Webhook Notes

Current webhook event types: AUDIT_EVENT_CREATED only.
Webhook create supports optional customSecret; if omitted, a random secret is generated and returned once.

Browse Endpoints

/api/endpoints/health-check
/api/endpoints/events-ingest
/api/endpoints/events-query
/api/endpoints/keys-create
/api/endpoints/keys-rotate
/api/endpoints/keys-status
/api/endpoints/webhooks-create
/api/endpoints/webhooks-list
/api/endpoints/webhooks-disable
/api/endpoints/webhooks-enable
/api/endpoints/webhooks-deliveries
/api/endpoints/exports-create
/api/endpoints/exports-status
/api/endpoints/exports-download

Interactive API Viewer

Common Responses

200 success
201 created
403 forbidden (scope/plan restrictions)

Use the OpenAPI spec for complete request and response schema details.