pufferd

The pufferd API specification
Type Definitions
messages.FileDesc
Object
extension
string
isFile
boolean
modifyTime
integer
name
string
size
integer
Methods: Get filelist
models.NodeView
Object
id
integer
name
string
privateHost
string
privatePort
integer
publicHost
string
publicPort
integer
sftpPort
integer
models.Template
Object
data
Object
additional properties
display
string
environment
Object
id
string
install
Array
Object
name
string
readme
string
supportedEnvironments
Array
Object
type
string
uninstall
Array
Object
pufferpanel.Error
Object
code
string
metadata
Object
msg
string
pufferpanel.Execution
Object
arguments
Array of string
autorecover
boolean
autorestart
boolean
autostart
boolean
command
string
disabled
boolean
environmentVars
Object
additional properties
string
post
Array
Object
pre
Array
Object
program
string
stop
string
stopCode
integer
pufferpanel.PufferdRunning
Object
message
string
Methods: Is daemon up
pufferpanel.Server
Object
data
Object
additional properties
display
string
environment
Object
id
string
install
Array
Object
type
string
uninstall
Array
Object
Methods: Create server
pufferpanel.ServerData
Object
data
Object
additional properties
pufferpanel.ServerDataAdmin
Object
data
Object
additional properties
display
string
environment
Object
id
string
install
Array
Object
type
string
uninstall
Array
Object
pufferpanel.ServerIdResponse
Object
id
string
Methods: Create server
pufferpanel.ServerLogs
Object
epoch
integer
logs
string
pufferpanel.ServerRunning
Object
running
boolean
pufferpanel.ServerStats
Object
cpu
number
memory
number
pufferpanel.Variable
Object
desc
string
display
string
internal
boolean
options
required
boolean
type
string
userEdit
boolean
value
Object
pufferpanel.VariableOption
Object
display
string
value
Object
Operations
GET /api/nodes
POST /api/nodes
GET /api/nodes/{id}
PUT /api/nodes/{id}
DELETE /api/nodes/{id}
GET /api/templates
GET /daemon
HEAD /daemon
GET /daemon/server/{id}
PUT /daemon/server/{id}
DELETE /daemon/server/{id}
POST /daemon/server/{id}/console
GET /daemon/server/{id}/data
POST /daemon/server/{id}/data
POST /daemon/server/{id}/install
GET /daemon/server/{id}/logs
POST /daemon/server/{id}/reload
POST /daemon/server/{id}/start
GET /daemon/server/{id}/stats
GET /daemon/server/{id}/status
POST /daemon/server/{id}/stop
GET /daemon/server/{id}/{filename}
PUT /daemon/server/{id}/{filename}
DELETE /daemon/server/{id}/{filename}
Get nodes
GET /api/nodes

Authentication

OAuth 2

Gets all nodes registered to the panel

Request body

application/json

Responses

200 200

Nodes

Body
application/json
Array of models.NodeView
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Create node
POST /api/nodes

Authentication

OAuth 2

Creates a node

Path variables

id
string required

Node Identifier

Request body

application/json

Responses

200 200

Node created

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Get node
GET /api/nodes/{id}

Authentication

OAuth 2

Gets information about a single node

Path variables

id
string optional

Request body

application/json

Responses

200 200

Nodes

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Update node
PUT /api/nodes/{id}

Authentication

OAuth 2

Updates a node with given information

Path variables

id
string required

Node Id

Request body

application/json

Responses

204 204

No Content

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Deletes a node
DELETE /api/nodes/{id}

Authentication

OAuth 2

Deletes the node

Path variables

id
string required

Node Id

Request body

application/json

Responses

204 204

No Content

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Adds or updates a template
GET /api/templates

Authentication

OAuth 2

Request body

application/json

Responses

204 204

No Content

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Is daemon up
GET /daemon

Authentication

OAuth 2

Easy way to tell if the daemon is running is by using this endpoint

Request body

application/json

Responses

200 200

Service running

Body
application/json
Is daemon up
HEAD /daemon

Authentication

OAuth 2

Easy way to tell if the daemon is running is by using this endpoint

Request body

application/json

Responses

204 204

Service running

Body
application/json
Gets server data as admin
GET /daemon/server/{id}

Authentication

OAuth 2

Gets the given server data from an admin’s view

Path variables

id
string required

Server Identifier

Request body

application/json

Responses

200 200

Data for this server

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Create server
PUT /daemon/server/{id}

Authentication

OAuth 2

Creates the server

Path variables

id
string required

Server Identifier

Request body

application/json

Server to create

Responses

200 200

Server created

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Deletes server
DELETE /daemon/server/{id}

Authentication

OAuth 2

Deletes the given server

Path variables

id
string required

Server Identifier

Request body

application/json

Responses

204 204

Server deleted

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Run command
POST /daemon/server/{id}/console

Authentication

OAuth 2

Runs a command in the server

Path variables

id
string required

Server Identifier

Request body

application/json

Command to run

string

Responses

204 204

If command was ran

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Gets server data
GET /daemon/server/{id}/data

Authentication

OAuth 2

Gets the given server data

Path variables

id
string required

Server Identifier

Request body

application/json

Responses

200 200

Data for this server

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Edit server data
POST /daemon/server/{id}/data

Authentication

OAuth 2

Edits the given server data

Path variables

id
string required

Server Identifier

Request body

application/json

Server data

Responses

204 204

Server edited

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Installs server
POST /daemon/server/{id}/install

Authentication

OAuth 2

installs the given server

Path variables

id
string required

Server Identifier

Request parameters

wait
boolean optional

Wait for the operation to complete

Request body

application/json

Responses

202 202

Install has been queued

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Gets server logs
GET /daemon/server/{id}/logs

Authentication

OAuth 2

Gets the given server logs since a certain time period

Path variables

id
string required

Server Identifier

Request body

application/json

Responses

200 200

Logs for this server

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Reload server
POST /daemon/server/{id}/reload

Authentication

OAuth 2

Reloads the server from disk

Path variables

id
string required

Server Identifier

Request body

application/json

Responses

204 204

Reloaded server

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Starts server
POST /daemon/server/{id}/start

Authentication

OAuth 2

Starts the given server

Path variables

id
string required

Server Identifier

Request parameters

wait
boolean optional

Wait for the operation to complete

Request body

application/json

Responses

202 202

Start has been queued

Body
application/json
204 204

Server started

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Gets server stats
GET /daemon/server/{id}/stats

Authentication

OAuth 2

Gets the given server stats

Path variables

id
string required

Server Identifier

Request body

application/json

Responses

200 200

Stats for this server

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Gets server status
GET /daemon/server/{id}/status

Authentication

OAuth 2

Gets the given server status

Path variables

id
string required

Server Identifier

Request body

application/json

Responses

200 200

OK

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Kill server
POST /daemon/server/{id}/stop

Authentication

OAuth 2

Stops the given server forcefully

Path variables

id
string required

Server Identifier

Request body

application/json

Responses

204 204

Server killed

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Get filelist
GET /daemon/server/{id}/{filename}

Authentication

OAuth 2

Gets a file or a file list from the server

Path variables

id
string required

Server Identifier

filename
string required

File name

Request body

application/json

Responses

200 200

File List

Body
application/json
application/octet-stream
400 400

Bad Request

Body
application/json
application/octet-stream
403 403

Forbidden

Body
application/json
application/octet-stream
404 404

Not Found

Body
application/json
application/octet-stream
500 500

Internal Server Error

Body
application/json
application/octet-stream
Put filefolder
PUT /daemon/server/{id}/{filename}

Authentication

OAuth 2

Puts a file or folder on the server

Path variables

id
string required

Server Identifier

filename
string required

File name

Request body

application/json
string binary

Responses

204 204

If file/folder was created

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json
Delete file
DELETE /daemon/server/{id}/{filename}

Authentication

OAuth 2

Deletes a file from the server

Path variables

id
string required

Server Identifier

filename
string required

File name

Request body

application/json

Responses

204 204

If file was deleted

Body
application/json
400 400

Bad Request

Body
application/json
403 403

Forbidden

Body
application/json
404 404

Not Found

Body
application/json
500 500

Internal Server Error

Body
application/json