List client servers
Returns a paginated list of servers the authenticated user can access as an owner, subuser, or administrator.
/api/clientAuthorization
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
Page number to return.
Number of servers to return per page. The maximum is 100.
Scope of servers to return. "owner" returns owned servers, "admin" returns admin-accessible servers excluding owned or subuser servers, and "admin-all" returns all servers for root administrators.
Value in
- "owner"
- "admin"
- "admin-all"
Filter servers by UUID.
Filter servers by name.
Filter servers by description.
Filter servers by external identifier.
Search across server name, UUID, short UUID, external identifier, or allocation address and port.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/client?page=1&per_page=50&type=owner&filter%5Buuid%5D=4fcb1f44-0f90-4a1a-a8bf-7cc8a14d0f26&filter%5Bname%5D=Minecraft+Server&filter%5Bdescription%5D=Production&filter%5Bexternal_id%5D=billing-server-42&filter%5B*%5D=192.0.2.10%3A25565"{ "object": "list", "data": [ { "object": "server", "attributes": { "server_owner": false, "identifier": "dmjkuwbo", "__deprecated_uuid_short": "dmjkuwbo", "server_identifier": "serv_1a2b3c4d", "internal_id": 8117, "uuid": "b4775bce-7333-4ebc-aa89-115fb04a9d51", "name": "Leo", "node": "FactoryNode_bbRqrPBYOG", "is_node_under_maintenance": false, "sftp_details": { "ip": "246.107.107.140", "port": 2022 }, "description": "Survival world", "limits": { "memory": 512, "swap": 0, "disk": 512, "io": 500, "cpu": 0, "threads": "1,2", "oom_disabled": false }, "invocation": "/bin/bash echo \"hello world\"", "docker_image": "foo/bar:latest", "egg_features": [ "eula" ], "feature_limits": { "databases": 5, "allocations": 5, "backups": 5 }, "status": null, "is_suspended": false, "is_installing": false, "is_transferring": false, "relationships": { "allocations": { "object": "list", "data": [ { "object": "allocation", "attributes": { "id": 9834, "ip": "54.95.112.197", "ip_alias": "string", "port": 8189, "notes": "Primary game port", "is_default": false } } ] }, "variables": { "object": "list", "data": [ { "object": "egg_variable", "attributes": { "name": "Leo", "description": "Et modi ipsum nostrum omnis autem et consequatur.", "env_variable": "AUT_DOLORES", "default_value": "OldLace", "server_value": "string", "is_editable": true, "rules": "required|string" }, "meta": { "startup_command": "java -Xms128M -Xmx1024M -jar paper.jar", "raw_startup_command": "java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}" } } ], "meta": { "startup_command": "java -Xms128M -Xmx1024M -jar paper.jar", "docker_images": { "Java 23": "ghcr.io/pterodactyl/yolks:java_23" }, "raw_startup_command": "java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}" } } } }, "meta": { "is_server_owner": true, "user_permissions": [ "websocket.connect" ] } } ], "meta": { "pagination": { "total": 1, "count": 1, "per_page": 50, "current_page": 1, "total_pages": 1, "links": { "property1": "string", "property2": "string" } } }}