Extracts an API key from a specific HTTP request header. By default, the header name is X-Api-Key. If the header is present, its first value is returned as the API key.

Example usage inside <apiKey>:

Example Configuration

apiKey:
  extractors:
    - header: x-key # custom header name

apiKey:
  extractors:
    - header: x-key # custom header name

Syntax

header: <string>

header: <string>

Can be used in

apiKey