server

package
v2.0.0-...-6548848 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 5, 2020 License: Apache-2.0 Imports: 27 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateServer

func CreateServer(c *gin.Context)

@Summary Create server @Description Creates the server @Accept json @Produce json @Success 200 {object} pufferd.ServerIdResponse "Server created" @Failure 400 {object} response.Error @Failure 403 {object} response.Empty @Failure 404 {object} response.Empty @Failure 500 {object} response.Error @Param id path string true "Server Identifier" @Param server body apufferi.Server true "Server to create" @Router /server/{id} [put]

func DeleteFile

func DeleteFile(c *gin.Context)

@Summary Delete file @Description Deletes a file from the server @Accept json @Produce json @Success 204 {object} response.Empty "If file was deleted" @Failure 400 {object} response.Error @Failure 403 {object} response.Empty @Failure 404 {object} response.Empty @Failure 500 {object} response.Error @Param id path string true "Server Identifier" @Param filename path string true "File name" @Router /server/{id}/{filename} [delete]

func DeleteServer

func DeleteServer(c *gin.Context)

@Summary Deletes server @Description Deletes the given server @Accept json @Produce json @Success 204 {object} response.Empty "Server deleted" @Failure 400 {object} response.Error @Failure 403 {object} response.Empty @Failure 404 {object} response.Empty @Failure 500 {object} response.Error @Param id path string true "Server Identifier" @Router /server/{id} [delete]

func EditServer

func EditServer(c *gin.Context)

@Summary Edit server data @Description Edits the given server data @Accept json @Produce json @Success 204 {object} response.Empty "Server edited" @Failure 400 {object} response.Error @Failure 403 {object} response.Empty @Failure 404 {object} response.Empty @Failure 500 {object} response.Error @Param id path string true "Server Identifier" @Param data body pufferd.ServerData true "Server data" @Router /server/{id}/data [post]

func EditServerAdmin

func EditServerAdmin(c *gin.Context)

@Summary Edit server data as admin @Description Edits the given server @Accept json @Produce json @Success 204 {object} response.Empty "Server edited" @Failure 400 {object} response.Error @Failure 403 {object} response.Empty @Failure 404 {object} response.Empty @Failure 500 {object} response.Error @Param id path string true "Server Identifier" @Param data body pufferd.ServerData true "Server data" @Router /server/{id} [post]

func GetConsole

func GetConsole(c *gin.Context)

func GetFile

func GetFile(c *gin.Context)

@Summary Get file/list @Description Gets a file or a file list from the server @Accept json @Produce json @Produce octet-stream @Success 200 {object} string "File" @Success 200 {object} messages.FileDesc "File List" @Failure 400 {object} response.Error @Failure 403 {object} response.Empty @Failure 404 {object} response.Empty @Failure 500 {object} response.Error @Param id path string true "Server Identifier" @Param filename path string true "File name" @Router /server/{id}/{filename} [get]

func GetLogs

func GetLogs(c *gin.Context)

@Summary Gets server logs @Description Gets the given server logs since a certain time period @Accept json @Produce json @Success 200 {object} pufferd.ServerLogs "Logs for this server" @Failure 400 {object} response.Error @Failure 403 {object} response.Empty @Failure 404 {object} response.Empty @Failure 500 {object} response.Error @Param id path string true "Server Identifier" @Router /server/{id}/logs [get]

func GetServer

func GetServer(c *gin.Context)

@Summary Gets server data @Description Gets the given server data @Accept json @Produce json @Success 200 {object} pufferd.ServerData "Data for this server" @Failure 400 {object} response.Error @Failure 403 {object} response.Empty @Failure 404 {object} response.Empty @Failure 500 {object} response.Error @Param id path string true "Server Identifier" @Router /server/{id}/data [get]

func GetServerAdmin

func GetServerAdmin(c *gin.Context)

@Summary Gets server data as admin @Description Gets the given server data from an admin's view @Accept json @Produce json @Success 200 {object} pufferd.ServerDataAdmin "Data for this server" @Failure 400 {object} response.Error @Failure 403 {object} response.Empty @Failure 404 {object} response.Empty @Failure 500 {object} response.Error @Param id path string true "Server Identifier" @Router /server/{id} [get]

func GetStats

func GetStats(c *gin.Context)

@Summary Gets server stats @Description Gets the given server stats @Accept json @Produce json @Success 200 {object} pufferd.ServerStats "Stats for this server" @Failure 400 {object} response.Error @Failure 403 {object} response.Empty @Failure 404 {object} response.Empty @Failure 500 {object} response.Error @Param id path string true "Server Identifier" @Router /server/{id}/stats [get]

func GetStatus

func GetStatus(c *gin.Context)

@Summary Gets server status @Description Gets the given server status @Accept json @Produce json @Success 200 {object} pufferd.ServerRunning @Failure 400 {object} response.Error @Failure 403 {object} response.Empty @Failure 404 {object} response.Empty @Failure 500 {object} response.Error @Param id path string true "Server Identifier" @Router /server/{id}/status [get]

func InstallServer

func InstallServer(c *gin.Context)

@Summary Installs server @Description installs the given server @Accept json @Produce json @Success 202 {object} response.Empty "Install has been queued" @Failure 400 {object} response.Error @Failure 403 {object} response.Empty @Failure 404 {object} response.Empty @Failure 500 {object} response.Error @Param id path string true "Server Identifier" @Param wait query bool false "Wait for the operation to complete" @Router /server/{id}/install [post]

func KillServer

func KillServer(c *gin.Context)

@Summary Kill server @Description Stops the given server forcefully @Accept json @Produce json @Success 204 {object} response.Empty "Server killed" @Failure 400 {object} response.Error @Failure 403 {object} response.Empty @Failure 404 {object} response.Empty @Failure 500 {object} response.Error @Param id path string true "Server Identifier" @Router /server/{id}/stop [post]

func OpenSocket

func OpenSocket(c *gin.Context)

func PostConsole

func PostConsole(c *gin.Context)

@Summary Run command @Description Runs a command in the server @Accept json @Produce json @Success 204 {object} response.Empty "If command was ran" @Failure 400 {object} response.Error @Failure 403 {object} response.Empty @Failure 404 {object} response.Empty @Failure 500 {object} response.Error @Param id path string true "Server Identifier" @Param commands body string true "Command to run" @Router /server/{id}/console [post]

func PutFile

func PutFile(c *gin.Context)

@Summary Put file/folder @Description Puts a file or folder on the server @Accept json @Produce json @Success 204 {object} response.Empty "If file/folder was created" @Failure 400 {object} response.Error @Failure 403 {object} response.Empty @Failure 404 {object} response.Empty @Failure 500 {object} response.Error @Param id path string true "Server Identifier" @Param filename path string true "File name" @Param folder path bool true "If this is a folder" @Param file formData file false "File to place" @Router /server/{id}/{filename} [put]

func RegisterRoutes

func RegisterRoutes(e *gin.RouterGroup)

func ReloadServer

func ReloadServer(c *gin.Context)

@Summary Reload server @Description Reloads the server from disk @Accept json @Produce json @Success 204 {object} response.Empty "Reloaded server" @Failure 400 {object} response.Error @Failure 403 {object} response.Empty @Failure 404 {object} response.Empty @Failure 500 {object} response.Error @Param id path string true "Server Identifier" @Router /server/{id}/reload [post]

func StartServer

func StartServer(c *gin.Context)

@Summary Starts server @Description Starts the given server @Accept json @Produce json @Success 204 {object} response.Empty "Server started" @Success 202 {object} response.Empty "Start has been queued" @Failure 400 {object} response.Error @Failure 403 {object} response.Empty @Failure 404 {object} response.Empty @Failure 500 {object} response.Error @Param id path string true "Server Identifier" @Param wait query bool false "Wait for the operation to complete" @Router /server/{id}/start [post]

func StopServer

func StopServer(c *gin.Context)

@Summary Stop server @Description Stops the given server @Accept json @Produce json @Success 204 {object} response.Empty "Server stopped" @Success 202 {object} response.Empty "Stop has been queued" @Failure 400 {object} response.Error @Failure 403 {object} response.Empty @Failure 404 {object} response.Empty @Failure 500 {object} response.Error @Param id path string true "Server Identifier" @Param wait query bool false "Wait for the operation to complete" @Router /server/{id}/stop [post]

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL