API key override

What is an API key override?

An API key override lets you set a provider API key directly on a service, bypassing the partial key mechanism. When an override is set, every request that arrives at your service's serviceURL uses the override key, regardless of which partialKey (if any) the client sends.

To set an API key override, tap on your service in the left sidebar of the dashboard and select Settings from the submenu, then paste the provider key into the API key override field.

If set, any requests arriving at serviceURL will use this key. Your service's serviceURL is found in the same Settings menu.

When to use an override

The override is useful when you need to change the key in use without shipping a client update. You do not need to bake a new partialKey into your client to start using a new provider key (rotating the value in the dashboard is sufficient).

Behavior

While an override is set, the partialKey sent by clients is ignored for that service. Any request that reaches the service's serviceURL is forwarded upstream using the override key.

Clear the API key override field in your service's settings to return to the partial key mechanism (the mechanism used when you submit a key using the sidebar's API keys menu).