API Keys

An API key lets your own software send loads to Load Optimizer without anyone opening the web app.

Where your keys live

Your own account

Open API from the main menu. Keys you create here belong to you.

Creating a key

1
Open the API page and choose Create key.
2
Fill in the Label field with a name that tells you which system will use the key.
3
Copy the key while the dialog is open, and put it somewhere safe.

The key is shown once

Save this key now means exactly that. Once you close the dialog the key cannot be shown again. If you lose it, revoke it and create a new one.

Using a key

Every request carries the key in a header named X-Api-Key. The API reference covers authentication, a quickstart you can follow in about five minutes, and the full list of what you can send.

Open the API reference

Revoking a key

Choose Revoke next to a key you no longer need, or one that may have been seen by someone who should not have it. Anything still using that key may keep working for a short while afterwards, then stops.

Which plans include it

API access is part of the paid plans. If your plan does not include it yet, the API page shows you how to change that.