Documentation

Troubleshooting

Common issues when calling APIs through the gateway.

Symptoms first — each with the usual cause and fix.

401 — "No API key found in request"

You sent the key under the wrong header name. The gateway checks its key-auth plugin's configured header (default apikey), while the API's spec may document a different one like X-API-Key — that header describes the backend, not the gateway. Resend as -H "apikey: <your key>".

401 with a key you believe is valid

The key may be revoked, or issued for a different environment — keys are per-environment, so a dev key does not work on tst. Re-check which environment you are calling and the key's state on your API keys page.

I lost my key, or never saw it

A key is shown in full once and can't be looked up afterwards. On your API keys page, click Regenerate key on its row to get a new one. See Your key is shown once.

My key is not in the "Try it" console's picker

The picker lists keys you requested. A key a producer issued for you directly has no request record and will not appear — paste it into the credential field instead. It works the same.

429 — rate limited

You hit the API's per-minute or per-hour window. Back off and retry after the window resets; the API's catalog page shows its limits. Sustained needs beyond the published limits are a conversation with the producer.

404 — no route

Three common causes, in order of likelihood:

  1. Missing or wrong route prefix. Calls go through /{service}/{major} (e.g. /httpbin/v1/get) — copy the base URL from the API's catalog page.
  2. The API is not serving that environment. An API can be live in dev and absent from tst; the catalog page shows per-environment status.
  3. The API was deprovisioned since you last called it.

Note the status page counts only 5xx as down — a 404 from a missing route records no health sample at all, so "the status page is green" does not contradict your 404.

CORS errors from a browser app

The gateway's CORS allowlist is configured per API by its producer, and by default covers the portal's own origins. If your web app's origin is rejected, ask the producer to add it to the API's CORS plugin origins.