Skip to main content

API Key

Use this type when upstream APIs authenticate using an API key in header/query/cookie.

Configure​

  1. Open Credentials -> New Credential.
  2. Select type api_key.
  3. Set:
    • api_key
    • key_in (header, query, or cookie)
    • key_name (for example x-api-key)
  4. Save and attach the credential to the target proxy/workflow step.

Verify​

Run one request through the proxy path that uses this credential and confirm upstream success.

Common issues​

  • 401 from upstream: wrong key value or expired key.
  • 400 from upstream: wrong key_name or wrong key_in placement.