Bot Command Docs

Commands use the registered panel API key of the author. All commands follow a basic ?command subcommand argument structure. For example, ?user register A0D10C8...

Commands that take a channel as an argument will default to the current channel that the command is sent in if no channel is specified. Commands that take a server ID as an argument will default to the server linked to the current channel, if the current channel is a mirror.

User (?user)

register apikey

Registers an API key with the bot, associating it with your account and enabling you to run commands.

• apikey - Your Pterodactyl panel API key. See Getting Started for more info.

unregister Removes your API key from the bot. Takes no arguments.

info

Shows information about the API key of the user running the command. This does not reveal sensitive information outside of bot DMs, but it's best not to use it in public channels. Takes no arguments.

servers

Shows a list of servers that you (your API key) have permission to access. This can be used to find server IDs for use in other commands. Takes no arguments.

verify serverid

Verifies that your registered API key is valid and working.

• serverid (optional) If specified, prompts the bot to verify access to that particular server.

server (?server)

power serverid action

Sets the power state of the server. Must supply power state, such as on/off.

• serverid The ID of the server.
• action This can be one of the following: start, stop, restart, kill

resources serverid

Displays the current hardware resource usage of the server.

• serverid The ID of the server.

gameinfo serverid

Displays game information about the server, such as players, current map, and server name. Currently only works for Minecraft and Source Engine servers.

• serverid The ID of the server

mirror (?mirror)

link serverid channel

Creates a mirror linking a server to a Discord channel.

unlink serverid or channel

Unlinks a channel from the server and destroys the mirror.