> For the complete documentation index, see [llms.txt](https://coldbox-security.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://coldbox-security.ortusbooks.com/secure-your-app/route-middleware/api-key.md).

# API Keys

Protect routes with API keys using the ApiKey middleware.

`ApiKey@cbsecurity` requires an API key. It reads the `x-api-key` header first and then the `apiKey` request key. A missing or wrong key gets a `401`.

```javascript
route( "/webhooks/billing" )
    .middleware( "ApiKey@cbsecurity" )
    .meta( { apiKeys : [ getSystemSetting( "BILLING_WEBHOOK_KEY" ) ] } )
    .to( "webhooks.billing" )
```

{% hint style="info" %}
`ApiKey` identifies a **client**. If you need to know **who** the user is, with permissions and expiration, use [JwtAuth](/secure-your-app/route-middleware.md) instead.
{% endhint %}

## Where Keys Come From

The middleware checks these, in order:

1. The route `meta` key `apiKeys` (a list or an array).
2. The `middleware.apiKey.keys` setting.
3. A validator service from `middleware.apiKey.validator`: a WireBox ID of an object with `boolean isValidKey( required string key, required event )`. Use it to look keys up in a database.

If none is configured the middleware throws `cbsecurity.MiddlewareMisconfigured`. Keys are compared in constant time. Keep them out of source control and load them from environment variables.

## Changing Where It Looks

| Route meta key | Setting                    | Default     |
| -------------- | -------------------------- | ----------- |
| `apiKeyHeader` | `middleware.apiKey.header` | `x-api-key` |
| `apiKeyParam`  | `middleware.apiKey.param`  | `apiKey`    |

```javascript
route( "/partners" )
    .middleware( "ApiKey@cbsecurity" )
    .meta( { apiKeys : "abc,def", apiKeyHeader : "x-partner-token", apiKeyParam : "token" } )
    .to( "partners.index" )
```

Prefer the header. A key in the query string ends up in access logs and browser history.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://coldbox-security.ortusbooks.com/secure-your-app/route-middleware/api-key.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.