Pterodactyl Client API integration
Pterodactyl is a self-hosted game server panel. With a user's Client API key, list and inspect the servers that user can access, start, stop or restart them and send console commands, read live resource usage, browse, read, write, compress and delete server files, manage databases, backups, schedules and their tasks, network allocations, subusers and startup variables, and read activity logs. Built for Panel 1.x. Left out: account security (two-factor setup, email and password changes, API keys, SSH keys), the console websocket, the file upload link, and database password rotation, whose answer is a password. Authentication is a Client API key (Account, API Credentials in the Panel) sent as a Bearer token, plus the address of your Panel.
Say what should happen.
The workflow builds itself.
What you can do with Pterodactyl Client API
Each of these is one operation on one endpoint, available both as a workflow step and as a tool an AI agent can call on its own. Nothing bundles several operations into one action, so what a run did stays readable afterwards.
Each badge shows the default agent permission of an endpoint (allowed: an agent calls it without asking; ask first: you are asked before an agent calls it, when the agent or chat asks permission for sensitive actions; never: no agent may call it), which every user can change endpoint by endpoint in their credential settings.
Most endpoints run on the free plan. A few, mainly the ones that publish on your behalf, need a paid plan.
File, 7 operations
compress_filesCompress filesPOSTAgents: ask firstCreates an archive of one or more files or folders from one directory and returns the new archive file.copy_fileCopy filePOSTAgents: ask firstCreates a copy of one file on the server, in the same folder.decompress_fileDecompress filePOSTAgents: ask firstExtracts one archive file into its directory on the server.delete_filesDelete filesPOSTAgents: ask firstPermanently deletes one or more files or folders (with their content) from one directory of the server.list_filesList filesGETAgents: ask firstLists the files and folders in one directory of the server, with size, permissions, type and dates.rename_filesRename filesPUTAgents: ask firstRenames or moves one or more files or folders inside one directory of the server.write_fileWrite filePOSTAgents: ask firstWrites text to one server file, creating it or replacing its whole content (the old content is lost).
Schedule, 6 operations
create_scheduleCreate schedulePOSTAgents: ask firstCreates a schedule (cron timing) on the server; add its steps with create_schedule_task. Its tasks then act on the server automatically.delete_scheduleDelete scheduleDELETEAgents: ask firstPermanently deletes a schedule and all its tasks.get_scheduleGet scheduleGETAgents: ask firstReturns one schedule with its cron timing, state, last and next run, and its tasks in order.list_schedulesList schedulesGETAgents: ask firstLists the server's schedules with their cron timing, state, last and next run, and tasks.run_scheduleRun schedulePOSTAgents: ask firstRuns a schedule's tasks now, whatever its cron timing (acts on the live server).update_scheduleUpdate schedulePOSTAgents: ask firstUpdates a schedule's name and cron timing; every cron field is required, so read get_schedule first and send the values to keep.
Backup, 5 operations
create_backupCreate backupPOSTAgents: ask firstStarts a backup of the server files (counts against its backup limit); poll get_backup until completed_at is set.delete_backupDelete backupDELETEAgents: ask firstPermanently deletes a backup and its archive; a locked backup must be unlocked first.get_backupGet backupGETAgents: ask firstReturns one backup: name, size, checksum, lock state, success flag and dates (completed_at stays null while it runs).list_backupsList backupsGETAgents: ask firstLists the server's backups with name, size, checksum, lock state, success and dates; completed_at is null while a backup runs.restore_backupRestore backupPOSTAgents: ask firstRestores a completed backup over the server's files (overwrites them; with truncate, deletes every file first). Refused while the server installs, transfers or restores.
Subuser, 5 operations
create_subuserCreate subuserPOSTAgents: ask firstGives a person access to the server with the listed permissions (grants access); an email with no panel account gets a new account.delete_subuserDelete subuserDELETEAgents: ask firstRemoves a subuser from the server (revokes their access and SFTP tokens; the account itself stays).get_subuserGet subuserGETAgents: ask firstReturns one subuser of the server with username, email and granted permission keys. Personal data.list_subusersList subusersGETAgents: ask firstLists the subusers who can access the server, with username, email and granted permission keys. Personal data.update_subuserUpdate subuserPOSTAgents: ask firstSets a subuser's permissions on the server to the list sent (changes access) and revokes their current SFTP access tokens.
Allocation, 4 operations
assign_allocationAssign allocationPOSTAgents: ask firstAssigns one more free allocation (IP and port) to the server; works only when the panel's auto-assign is enabled and the server is under its allocation limit.list_allocationsList allocationsGETAgents: ask firstLists the server's network allocations (IP, alias, port, note) and which one is primary.set_primary_allocationSet primary allocationPOSTAgents: ask firstMakes one of the server's allocations its primary IP and port.unassign_allocationUnassign allocationDELETEAgents: ask firstRemoves a non-primary allocation from the server and returns it to the free pool.
Server, 4 operations
get_serverGet serverGETAgents: ask firstReturns one server: name, node, limits, feature limits, Docker image, startup command, install and suspension state, SFTP details, allocations and startup variables, plus the key's permissions on it.list_serversList serversGETAgents: ask firstLists the servers the key's user can access, with limits, state, SFTP details, allocations and startup variables. Use identifier as the server param of every other tool.reinstall_serverReinstall serverPOSTAgents: ask firstQueues a reinstall of the server on its node: the egg's install process runs again on the server's files.rename_serverRename serverPOSTAgents: ask firstRenames the server, and can change its description.
Database, 3 operations
create_databaseCreate databasePOSTAgents: ask firstCreates a database for the server on a host the panel picks (counts against the server's database limit). The generated password is not returned: view it in the Panel.delete_databaseDelete databaseDELETEAgents: ask firstPermanently deletes one of the server's databases and its data.list_databasesList databasesGETAgents: ask firstLists the server's databases with host, name, user name, allowed remote addresses and connection limit. Passwords are not returned.
Schedule task, 3 operations
create_schedule_taskCreate schedule taskPOSTAgents: ask firstAdds a step to a schedule: a console command, a power signal or a backup, run after a delay in seconds.delete_schedule_taskDelete schedule taskDELETEAgents: ask firstPermanently deletes one step of a schedule.update_schedule_taskUpdate schedule taskPOSTAgents: ask firstUpdates a schedule step: action, payload and delay are required, so read get_schedule first and send the values to keep.
Startup variable, 2 operations
list_startup_variablesList startup variablesGETAgents: ask firstReturns the server's startup variables the user may see (current value, default, rules, editable flag), the startup command and the allowed Docker images. Values can include game passwords.update_startup_variableUpdate startup variablePUTAgents: ask firstSets one editable startup variable of the server and returns it with the updated startup command.
Account, 1 operation
get_accountGet accountGETAgents: ask firstReturns the key's own user account: id, username, email, first and last name, language and whether it is a root administrator. Personal data.
Account activity, 1 operation
list_account_activityList account activityGETAgents: ask firstLists the activity log of the key's own account (sign-ins and account changes) with event name, IP address and time. Personal data.
Allocation note, 1 operation
set_allocation_noteSet allocation notePOSTAgents: ask firstSets the note shown on one of the server's allocations.
Backup download, 1 operation
get_backup_download_urlGet backup download urlGETAgents: ask firstReturns a signed URL that downloads one backup archive; the link expires shortly and works without the API key.
Backup lock, 1 operation
toggle_backup_lockToggle backup lockPOSTAgents: ask firstFlips a backup's lock: a locked backup cannot be deleted, by hand or by backup rotation. Returns the backup with its new is_locked.
Console command, 1 operation
send_console_commandSend console commandPOSTAgents: ask firstSends a command to the running server's console (acts on the live game server). The server must be online: the panel answers 502 otherwise.
Docker image, 1 operation
update_docker_imageUpdate docker imagePUTAgents: ask firstSwitches the server to another Docker image allowed by its egg; refused when an admin set a custom image.
File content, 1 operation
get_file_contentsGet file contentsGETAgents: ask firstReturns the raw text of one server file (configs, logs...). The text may hold secrets the file stores, such as passwords in a config file.
File download, 1 operation
get_file_download_urlGet file download urlGETAgents: ask firstReturns a signed one-time URL that downloads one server file directly from its node; the link expires shortly.
File permission, 1 operation
change_file_permissionsChange file permissionsPOSTAgents: ask firstChanges the permission bits of one or more files or folders in one directory.
Folder, 1 operation
create_folderCreate folderPOSTAgents: ask firstCreates a folder in a directory of the server.
Permission, 1 operation
list_permissionsList permissionsGETAgents: ask firstLists every permission key a subuser can be granted (control.console, file.read...), grouped with descriptions; pass keys to create_subuser or update_subuser.
Power signal, 1 operation
send_power_signalSend power signalPOSTAgents: ask firstStarts, stops, restarts or kills the server (acts on the live game server). kill ends the process at once and can lose unsaved data.
Remote file, 1 operation
pull_remote_filePull remote filePOSTAgents: ask firstMakes the server's node download a file from a URL into the server's files (adds a file to the live server).
Server activity, 1 operation
list_server_activityList server activityGETAgents: ask firstLists the server's activity log (power actions, file changes, console commands, backups...) with event name, IP address and time. Personal data.
Server resource, 1 operation
get_server_resourcesGet server resourcesGETAgents: ask firstReturns the server's live power state and its current memory, CPU, disk and network usage as last reported by its node.
Use Pterodactyl Client API from Claude Code, Cursor or Codex
Connect Pterodactyl Client API in LiveContext, create an API key in Settings, then add the LiveContext MCP server to your client. Its Pterodactyl Client API operations become tools the client can call, next to every other integration you connected.
claude mcp add --transport http livecontext https://livecontext.ai/mcp --header "X-API-Key: YOUR_API_KEY"[mcp_servers.livecontext]
url = "https://livecontext.ai/mcp"
[mcp_servers.livecontext.http_headers]
"X-API-Key" = "YOUR_API_KEY"{
"mcpServers": {
"livecontext": {
"type": "http",
"url": "https://livecontext.ai/mcp",
"headers": {
"X-API-Key": "YOUR_API_KEY"
}
}
}
}How to connect Pterodactyl Client API
- Create your workspace
Sign up free. Nothing to install.
- Connect Pterodactyl Client API once
Add your Pterodactyl Client API connection in Settings. Every tool from this integration reuses it, and secrets are encrypted at rest and visible only to you.
- Describe the job in chat
The workflow builds itself in front of you and picks the endpoints it needs. Drag the steps yourself on the canvas whenever you would rather be explicit.
Pterodactyl Client API integration FAQ
What can you do with the Pterodactyl Client API integration?
LiveContext exposes 55 operations on Pterodactyl Client API, covering file, schedule, backup and subuser.
