Skip to content

Scopes and roles ​

ScopeWhat it allows
metrics:readSee traffic statistics
domains:readSee domains
domains:writeAdd, check and delete domains
buckets:readSee buckets
buckets:writeAdd, check and delete buckets
routes:readSee routes and test files
routes:writeCreate and delete routes
settings:writeChange node settings
users:manageManage users, security and activity log
notifications:manageConfigure email and Telegram notifications

A scope x:write always includes x:read.

Predefined roles ​

RoleScopes
Administrator (admin)all
Operator (operator)metrics:read, domains:write, buckets:write, routes:write (+ the implicit reads)
Read-only (viewer)metrics:read, domains:read, buckets:read, routes:read
Custom (custom)the chosen ones

Scope required for each API action ​

RequestScope
GET /api/panelnone (the data shown depends on the read scopes)
GET /api/metricsmetrics:read
PUT /api/settingssettings:write
PUT /api/https, PUT /api/admin-host, PUT /api/admin-allow, PUT /api/updates, POST /api/update/checksettings:write
POST /api/domains, /api/domains/check, /api/domains/test, /api/domains/redirectdomains:write
POST /api/certs/issue, /api/certs/uploaddomains:write
DELETE /api/domains/{host}domains:write
POST /api/buckets, /api/buckets/check, /api/buckets/testbuckets:write
DELETE /api/buckets/{id}buckets:write
POST /api/rules, DELETE /api/rules/{id}routes:write
POST /api/proberoutes:read
POST /api/purge, POST /api/warmroutes:write
PUT /api/rules/{id}, POST /api/linksroutes:write
POST /api/links/rotatesettings:write
POST /api/diagnoseroutes:read
/api/users…, /api/audit, /api/policy, /api/backup/…users:manage
GET/PUT /api/notifications, POST /api/notifications/testnotifications:manage
/api/me…none (logged-in user)

Rilasciato con licenza MIT o Apache-2.0, a scelta.