Skip to main content
Run expl server from scripts and CI without anyone signing in through a browser, with an API key.

Create an API key

CI is a system that runs steps automatically when code changes. No one can sign in through a browser there, so you give it an API key. Create one as described on the API keys page. Store the key as a secret in your CI (a feature that keeps values hidden). Do not write it in a script, and do not print it to the screen or to logs. A key expires; create a new one and replace the secret before then. For how to create a key and keep it safe, see API keys.

Pass the key

Pass the key with the environment variable EXPL_SERVER_TOKEN. For the order against a saved login, see Sign in. To use another server, set EXPL_SERVER_URL.

Example: GitHub Actions

An example for GitHub Actions. Replace <id> with the id of the content to read. Replace <version> with the version you use, and always pin it.

Exit codes

A script can tell success from failure by the exit code. These two are common in CI. Every exit code is described in Exit codes and errors.

Revoke the API key

Revoke a key that leaks or that you no longer need, as described in API keys. A call with a revoked or expired key exits with code 4.