API Keys

Create scoped keys so your own tools and automations can use the Stratos API.

An API key is a credential that lets your own software call the Stratos API: upload media, update playlists, read screen status. Each key has only the scopes you give it.

Where to find it: Settings → API keys. You need developer_integrations:read to view and developer_integrations:write to create and revoke (by default the Account Owner). API access is a plan feature. If the page is missing, see Plans & Subscription.

API keys

Create a key

Click Create API key.
Enter a Name that says what it’s for, such as CI/CD pipeline or Reporting dashboard.
Choose the Access mode:
- Read only: can fetch data.
- Read and write: can also make changes, but only for the scopes you select.
Select the Scopes: the specific areas the key may touch.
Click Create API Key.

Scopes

Scopes are shown as the area plus View (read) or Edit (write), for example Media — Edit.

Scope	View	Edit
Feeds	✓
Layouts	✓	✓
Media	✓	✓
Playlists	✓	✓
Schedules	✓	✓
Screens	✓
Screen groups	✓

Copy your key now

The full key is shown only once, right after you create it (Copy your API key now). Copy it to a secure place such as a password manager or your secrets store. Afterwards only the key’s prefix is shown. If you lose it, revoke it and create another.

Using a key

Send the key with each request to the Stratos API. A key can do only what its mode and scopes allow, so a read-only key can’t change anything even if it leaks.

The list

Each key shows its name, prefix, access mode, scopes, when it was last used and created, and its state (Active or Revoked).

Revoke a key

Revoke a key you no longer need or that may have been exposed (confirm in the dialog). It stops working immediately and can’t be restored. Revoked keys stay in the list for your records.