Skip to content

Commit

Permalink
[cherry-pick] update APIKey suppliedIn docs (#7085)
Browse files Browse the repository at this point in the history
  • Loading branch information
nginx-bot authored Jan 8, 2025
1 parent bd708da commit 8b7bd08
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions site/content/configuration/policy-resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,11 +192,14 @@ data:
{{% table %}}
|Field | Description | Type | Required |
| ---| ---| ---| --- |
|``suppliedIn`` | `header` or `query`. | | Yes |
|``suppliedIn.header`` | An array of headers that the API Key may appear in. | ``string[]`` | No |
|``suppliedIn.query`` | An array of query params that the API Key may appear in. | ``string[]`` | No |
|``clientSecret`` | The name of the Kubernetes secret that stores the API Key(s). It must be in the same namespace as the Policy resource. The secret must be of the type ``nginx.org/apikey``, and the API Key(s) must be stored in a key: val format where each key is a unique clientID and each value is a unique base64 encoded API Key | ``string`` | Yes |
{{% /table %}}

{{<important>}}An APIKey Policy must include a minimum of one of the `suppliedIn.header` or `suppliedIn.query` parameters. Both can also be supplied.{{</important>}}

#### APIKey Merging Behavior

A VirtualServer or VirtualServerRoute can be associated with only one API Key policy per route or subroute. However, it is possible to replace an API Key policy from a higher-level with a different policy defined on a more specific route.
Expand Down

0 comments on commit 8b7bd08

Please sign in to comment.