Developers/REST API

REST API reference

Base URL: https://panel.hostwolf.net/api/client

Auth: send Authorization: Bearer ptlc_... and Accept: application/json. Create keys at Account → API keys.

The API is compatible with the Pterodactyl client API, so existing Pterodactyl tools and libraries work against it. Hostwolf-only endpoints are marked HW.

Conventions#

Responses. Single objects come wrapped as {"object": "server", "attributes": {...}}. Lists come as {"object": "list", "data": [...], "meta": {...}}. Hostwolf-only endpoints return plain JSON.

Pagination. Paginated lists accept ?page= and ?per_page= (max 100 for servers, 50 for backups), and return meta.pagination with total, count, per_page, current_page and total_pages.

Errors.

{
  "errors": [
    { "code": "ValidationException", "status": "422", "detail": "The name field is required." }
  ]
}

Some Hostwolf endpoints return {"error": "...", "code": "..."} instead, e.g. 409 downgrade_requires_reset when switching a game to an older version.

Status codes:

• 204: success with no body.
• 401: bad key.
• 403: missing permission (subusers) or a suspended server.
• 404: not found.
• 409: the server is busy (installing, restoring or transferring).
• 422: validation error.
• 429: rate limited (check Retry-After).
• 502: the server's node is unreachable, or the server must be running.

Server ids. {server} is the server's identifier, the 8 characters in its panel URL. The full uuid also works.

Account#

Servers#

Files#

All paths are relative to the server root. root is the directory that the files entries live in.

Backups#

Game, players and diagnostics HW#

Mods, plugins and modpacks HW#

Schedules#

Network, databases and subusers#

Server extras HW#

Plans and orders HW#

Read-only. Ordering, cancelling and payment happen in the panel.

Console#

The live console is a websocket on the node that runs your server.

1. GET /servers/{server}/websocket returns {"data": {"token": "...", "socket": "wss://..."}}.
2. Connect to socket with an Origin: https://panel.hostwolf.net header.
3. Send {"event": "auth", "args": ["<token>"]} and wait for auth success.
4. Send {"event": "send logs", "args": [null]} to replay recent output.

Messages are JSON in the form {"event": "...", "args": [...]}.

Events you receive:

• console output
• status
• stats (a JSON string)
• install output
• daemon message and daemon error
• token expiring: fetch a new token and send auth again.
• token expired

Events you can send:

• send command with the command text.
• set state with start, stop, restart or kill.
• send logs
• send stats

The SDK handles all of this: hw.console(id) or hw.tail(id).

SFTP#

Files are also reachable over SFTP. Use the address in sftp_details from GET /servers/{server}, with username <your username>.<server identifier>. Log in with your panel password or an SSH key added at /account/ssh-keys.