Send the key
Use theAuthorization header with the Bearer scheme.
X-API-Key is also accepted for clients that cannot set a bearer token.
Key lifecycle
- Create separate keys for each application and environment.
- Give keys only the permissions their application needs.
- Rotate keys without reusing or sharing secrets between services.
- Revoke a key immediately when it is exposed or no longer needed.
Authentication errors
The API returns401 when a key is missing, malformed, expired, revoked, or otherwise invalid. It returns 403 when the key is valid but lacks permission for the requested operation. Both responses use the standard Problem Details shape and include a request ID.