List servers
Returns a paginated list of servers visible to the application API key.
/api/application/serversAuthorization
default Application API requests require an application API token, or a client API token, that belongs to a root administrator. Admin API requests require a client API token that belongs to a root administrator, and reject application API tokens. Client API requests require a client API token.
In: header
Query Parameters
Number of servers to return per page, up to 100.
Filter servers by UUID.
Filter servers by short UUID identifier.
Filter servers by name.
Filter servers by description.
Filter servers by Docker image.
Filter servers by external identifier.
Search term accepted by the list request. Must not exceed 100 characters.
Sort servers by id or uuid. Prefix with "-" for descending order.
Value in
- "id"
- "-id"
- "uuid"
- "-uuid"
Comma-separated relationships to include. Supports "allocations", "user", "subusers", "egg", "variables", "location", "node", "databases", and "transfer" when the key can read those resources.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/application/servers?per_page=50&filter%5Buuid%5D=4fcb1f44-0f90-4a1a-a8bf-7cc8a14d0f26&filter%5BuuidShort%5D=4fcb1f44&filter%5Bname%5D=Minecraft+Server&filter%5Bdescription%5D=Production&filter%5Bimage%5D=ghcr.io%2Fpterodactyl%2Fyolks%3Ajava_23&filter%5Bexternal_id%5D=billing-server-42&search=minecraft&sort=-id&include=user%2Cnode%2Callocations"{ "object": "list", "data": [ { "object": "server", "attributes": { "id": 8107, "external_id": "string", "uuid": "c248d6eb-38d1-4067-acd6-7acc8c6cfd60", "identifier": "q2xiw8r8", "name": "Asia", "description": "Accusantium harum mollitia modi deserunt aut ab. Perspiciatis quo omnis nostrum aut adipisci quidem nostrum qui. Incidunt iure odit et et modi ipsum.", "status": "string", "suspended": false, "limits": { "memory": 512, "swap": 0, "disk": 512, "io": 500, "cpu": 0, "threads": "string", "oom_disabled": false }, "feature_limits": { "databases": 0, "allocations": 0, "backups": 0 }, "user": 22043, "node": 13322, "allocation": 9812, "egg": 9831, "container": { "startup_command": "/bin/bash echo \"hello world\"", "image": "foo/bar:latest", "installed": 1, "environment": { "SERVER_JARFILE": "server.jar" } }, "updated_at": "2026-09-22T14:45:23+00:00", "created_at": "2026-09-22T14:45:23+00:00" } } ], "meta": { "pagination": { "total": 1, "count": 1, "per_page": 50, "current_page": 1, "total_pages": 1, "links": { "property1": "string", "property2": "string" } } }}