Manage API keys

API keys for Upper Solo live in Settings > WS API. Generate, regenerate, or revoke keys from there. API access requires the Optimize or Enterprise plan.

API access lets you connect Upper Solo to your own systems for stop and route automation. Keys are generated, regenerated, and revoked from the Settings panel.

Why this matters

API keys are credentials. Treat them like passwords — generate them only for trusted integrations, rotate them after any suspected exposure, and revoke any key you no longer need.

Before you start

Plan requirement — Available on the Optimize and Enterprise plans. Not available on Starter or Professional.
Permissions — Admin or Owner role only. Dispatch Managers cannot view or manage API keys.

Step-by-step: find your API keys

Open "Settings" in the left sidebar.
Click "WS API".
Your API keys are listed on this page.

What you can do here

View existing API keys.
Generate a new API key.
Regenerate a key if it's been compromised.
Revoke a key to cut off access.

Regenerating a key invalidates the old value immediately. Any integration still using the old key will start failing until you update it with the new value.

Common scenarios

You suspect a key was leaked in source code — Regenerate it. Update every integration with the new value, then confirm the leaked key no longer works.
A contractor finished their integration work — Revoke the key they used so it can't be reused.
You need a separate key per environment — Generate one key per integration so you can rotate each independently.

Troubleshooting

The WS API section isn't visible in Settings — Confirm you're on Optimize or Enterprise and that your role is Admin or Owner. Dispatch Managers cannot see API settings.