web

func RegisterRoutes ¶

func RegisterRoutes(e *gin.Engine)

RegisterRoutes Registers all routes @title PufferPanel API @version 3.0 @description PufferPanel API interface for both the panel and daemon. @contact.name PufferPanel @contact.url https://pufferpanel.com @license.name Apache 2.0 @license.url http://www.apache.org/licenses/LICENSE-2.0.html @Accept json @Produce json @description.markdown @securitydefinitions.oauth2.application OAuth2Application @tokenUrl /oauth2/token @scope.none No scope needed @scope.admin Administrator, full rights to all actions @scope.login Allows logging into the panel @scope.oauth2.auth Scope to validate another OAuth2 credential @scope.nodes.view Allows viewing nodes @scope.nodes.create Allows creating nodes @scope.nodes.delete Allows for deleting nodes @scope.nodes.edit Allows editing of node connection information @scope.nodes.deploy Allows getting the config of a node for deployment @scope.self.edit Allows editing of personal account @scope.self.clients Allows creating OAuth2 clients under the account @scope.server.admin Admin access to a server (full permissions) @scope.server.view Allows viewing a server @scope.server.create Allows creating servers @scope.server.delete Allows deleting servers @scope.server.definition.edit Allows editing a server's definition @scope.server.data.edit Allows editing the values of variables @scope.server.flags.edit Allows changing flags on the server @scope.server.name.edit Allows editing of a server name @scope.server.definition.view Allows viewing a server's definition @scope.server.data.view Allows viewing a server's variables @scope.server.flags.view Allows viewing a server's flags @scope.server.clients.view Allows viewing OAuth2 clients associated to a server @scope.server.clients.edit Allows editing OAuth2 clients associated to a server @scope.server.clients.create Allows adding a new OAuth2 client to a server @scope.server.clients.delete Allows deleting OAuth2 clients associated to a server @scope.server.users.view Allows viewing users associated to a server @scope.server.users.edit Allows editing user permissions to a server @scope.server.users.create Allows adding a new user to a server @scope.server.users.delete Allows removing users from to a server @scope.server.tasks.view Allows viewing tasks associated to a server @scope.server.tasks.edit Allows editing tasks associated to a server @scope.server.tasks.add Allows adding a new tasks to a server @scope.server.tasks.delete Allows deleting tasks from to a server @scope.server.tasks.run Allows for running tasks on a server @scope.server.reload Allows reloading of a server's definition from disk @scope.server.start Allow starting a server @scope.server.stop Allows stopping a server @scope.server.kill Allows killing a server @scope.server.install Allows using the "Install" button for a server @scope.server.files.view Allows viewing and downloading files for a server through the File Manager @scope.server.files.edit Allows editing files for a server through the File Manager @scope.server.sftp Allows connection to a server over SFTP @scope.server.console Allows viewing the console of a server @scope.server.console.send Allows sending commands to a server's console @scope.server.stats Allows getting stats of a server like CPU and memory usage @scope.server.status Allows getting the status of a server @scope.settings.edit Allows for editing of panel settings @scope.templates.view Allows viewing templates @scope.templates.local.edit Allows editing of templates in the local repo @scope.templates.repo.create Allows adding a new template repo @scope.templates.repo.delete Allows deleting of a template repo @scope.users.info.search Allows for searching for users @scope.users.info.view Allows for viewing a user's info @scope.users.info.edit Allows for editing a user's info @scope.users.perms.view Allows for viewing a user's global permissions @scope.users.perms.edit Allows for editing a user's global permissions