All pages

Authentication

Every /v1/* endpoint authenticates with a single Bearer key: add an Authorization: Bearer ng-... header to each request. Treat the key like a password. Never ship it in client-side code or a public repo. Mutating (POST) requests can also send the optional Idempotency-Key header for safe retries.

Your Hormouz API key. Include it in every request:

Authorization: Bearer ng-1234567890abcdef1234567890abcdef

The key is shown once when your admin creates your account. If lost, ask your admin to reset it.

FAQ

What if my API key leaks?

Ask your account admin to reset it immediately. The old key stops working at once and the new key is shown exactly once.

What does a request without a key return?

401 UNAUTHORIZED with the standard error envelope {"error":{"code":"UNAUTHORIZED",...}}.

Updated 2026-10-13