Permissions
Permissions on a server, for members (Members and permissions) and API tokens (API tokens). Owners and admins have all of them.
| Group | Permission | Allows |
|---|---|---|
| Server | server.view | See the server, its state, ports and stats |
| Server | monitor.view | See the resource charts (Monitor: CPU, memory, disk, network over time) |
| Console | console.read | Read the live console |
| Console | console.write | Send console commands |
| Power | power.start | Start the server |
| Power | power.stop | Stop the server |
| Power | power.restart | Restart the server |
| Power | power.kill | Kill the server |
| Files | files.list | List folders |
| Files | files.read | Read and download files |
| Files | files.write | Create, edit, upload and rename files |
| Files | files.delete | Delete files |
| Files | files.sftp | Connect with SFTP (with the file permissions above) |
| Startup | startup.read | See startup variables |
| Startup | startup.write | Change startup variables |
| Settings | settings.reinstall | Reinstall the server |
| Settings | settings.update | Update the game from Steam, and enter Steam Guard codes for it |
| Backups | backups.list | See the backups |
| Backups | backups.create | Create backups (and lock them) |
| Backups | backups.download | Download backups |
| Backups | backups.restore | Restore a backup over the server's files |
| Backups | backups.delete | Delete backups |
| Schedules | schedules.read | See the schedules |
| Schedules | schedules.write | Create, change and run schedules (only with tasks the person may do) |
Wildcards
Section titled “Wildcards”power.* covers a group, * everything. The list is also served by every panel at GET /api/v1/permissions.
- File permissions can be limited to paths; see path-limited file access.
- Moving or renaming needs
files.writeon both paths. files.sftpis for members only; tokens can’t use SFTP.- A schedule can only contain tasks its author may do (a restart needs
power.restart).