Scopes: read, write and manage
What each scope lets a key or an AI app do, in plain words.
When you make an API key or connect an AI app, you choose what it can do: its scopes. They narrow what it may do within what its account may do: they never add anything the account does not have.
| Scope | In the dashboard | It lets the key or app |
|---|---|---|
read |
Read: see lines, streams, connections, stats | Look: every list, detail, stat and status. It changes nothing. |
write |
Change: create, edit and extend lines (spends credits), change streams | Create and change: add lines and extend them with a package, enable or disable them, start, stop and sort streams, edit bouquets, movies, TV shows and playlists. |
manage |
Delete and money: delete anything, credits, accounts, servers and settings | Delete anything, move credits, change packages and their prices, accounts and what they may do, servers, panel settings, backups and the licence. Tick it on purpose only. |
write and manage include read: a key that may change things may also look at them.
How the panel decides
Every call needs one scope, decided by what it does. The API reference shows it on every call.
- Looking (a
GET):read. - Deleting:
manage— everyDELETE, and the calls that delete without one: deleting many streams at once, merging duplicates, removing provider links, emptying or purging a playlist's bin, putting a playlist's backup back over it. Closing a stream or movie preview is onlywrite: it deletes nothing. - Money, accounts and the whole panel:
manage— credits, packages (they carry the prices), users, groups and permissions, servers, settings (except categories), backups, the licence, a reseller's own domain, the TV guide's settings and countries, the playlist editor's settings, blocked addresses and the activity log. - Changing anything else (a
POST,PUTorPATCH):write.
Never reachable
Whatever the account and the scopes, no key or AI app can:
- sign in, change the account's password, two-step sign-in, passkeys or single sign-on;
- make, see or revoke API keys, or connect or disconnect AI apps;
- set another account's password, two-step sign-in or passkeys;
- change the email of a staff or reseller account (single sign-on finds people by their email);
- make other kinds of credentials: the playlist editor's API tokens, the remote database login, or a move of the panel to another server;
- open the panel's back office.
A key that leaks can never make itself a new key or lock you out. A manage key can create accounts, though, and an account it made keeps working after the key is revoked: give manage keys an end date and an address list.
Choosing
- Reports, dashboards, an AI app that answers questions:
read. - Selling and renewing lines, restarting streams:
read+write. - Cleaning up, moving credits between resellers, running the panel: add
manage, and keep that key somewhere safe.
A call that needs a scope the key lacks is refused with 403 and changes nothing; the answer says which scope it needs. See Errors.