Create an API key | Outlap Docs

API keys let software you control, such as a timing PC, a script or a website, act for your club. You need to be an admin of the club or track.

Create one

Open your club or track and go to Settings → API keys.
Choose Create key and give it a name that says what will use it, such as Race Control PC or Website calendar.
Copy the key now. It looks like olap_ followed by 48 characters, and is shown only once. Outlap stores only a hash.
Put it in the place that will use it: an environment variable, your secrets manager, or the timing bridge’s --key flag.

New keys get the timing:write and timing:read scopes. See Authentication.

Good habits

One key per system, so you can revoke one without breaking the rest.
Name keys by purpose and place. The list shows the name, the prefix (first eight characters) and when it was last used.
Never put a key in a web page or a public repository.
Prefer environment variables over command-line flags, which can show up in shell history and process lists:
```
export OUTLAP_API_KEY=olap_xxxxxxxx
```

Revoke a key

If a key is lost, leaked or no longer needed, revoke it from the same list. It stops working immediately, and requests with it return 401. Create a replacement and update whatever used it.

Prefer to automate?

Admin tools can mint keys through the API keys endpoint with a signed-in admin’s session.