3. Security and Validation

Deprecated: Set an expression like ${header['api']} on apiKey

headerExtractor

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>: 

<apiKey>
   <headerExtractor /> 

   
   <headerExtractor name="Authorization"/>
 </apiKey>

Can be used in:

apiKey

Attributes

NameRequiredDefaultDescriptionExamples
name false X-Api-Key
 The HTTP header name to check for an API key.
Authorization