List servers

Lists all servers the authenticated user has access to.

Available include parameters

Parameter	Description
egg	Information about the egg the server uses
subusers	List of subusers on the server

Filtering

Use filter[field]=value to narrow the results. Most filters are partial (substring) matches.

Filter	Match	Description
`filter[name]`	partial	Server name
`filter[uuid]`	partial	Server UUID (also matches the short identifier)
`filter[description]`	partial	Server description
`filter[external_id]`	exact	External ID set by the panel admin
`filter[*]`	partial	Searches name, uuid, description and external_id at once

Server type

The type parameter changes which servers are returned (default is owner):

Value	Description
`owner`	Only servers owned by the authenticated user (default)
`admin`	Servers the user can see only because they are an admin (root admin only)
`admin-all`	All servers on the panel, owned or not (root admin only)

GET/api/client

Authorization

ClientToken

AuthorizationBearer <token>

Client API key (generated at /account/api)

In: header

Query Parameters

include?string

Comma-separated list of related resources to embed in each returned object. Accepted values are listed in the include-parameters table above.

type?string

Which set of servers to return. Defaults to owner. admin and admin-all require the user to be a root admin.

Value in"owner" | "admin" | "admin-all"

filter[name]?string

Partial match on the server name.

filter[uuid]?string

Partial match on the server UUID (also matches the short identifier).

filter[description]?string

Partial match on the server description.

filter[external_id]?string

Exact match on the external ID assigned by the panel admin.

filter[*]?string

Partial match across the name, uuid, description and external_id fields at once.

page?integer

Page of results to return.

per_page?integer

Number of results to return per page.

Response Body

`application/json`

curl -X GET "https://pterodactyl.file.properties/api/client?include=egg%2Csubusers&type=owner&filter%5Bname%5D=Survival&filter%5Buuid%5D=1a7ce997&filter%5Bdescription%5D=community&filter%5Bexternal_id%5D=store-1234&filter%5B*%5D=Survival&page=1&per_page=50" \  -H "Authorization: Bearer ptlc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \  -H "Accept: application/json"

{
  "object": "list",
  "data": [
    {
      "object": "server",
      "attributes": {
        "server_owner": true,
        "identifier": "1a7ce997",
        "__deprecated_uuid_short": "1a7ce997",
        "server_identifier": "serv_bld4gxw2rvcd5o7y27nsn5zuuy",
        "internal_id": 69,
        "uuid": "1a7ce997-259b-452e-8b4e-cecc464142ca",
        "name": "Gaming",
        "node": "Test",
        "is_node_under_maintenance": false,
        "sftp_details": {
          "ip": "pterodactyl.file.properties",
          "port": 2022
        },
        "description": "Matt from Wii Sports",
        "limits": {
          "memory": 512,
          "swap": 0,
          "disk": 200,
          "io": 500,
          "cpu": 0,
          "threads": null,
          "oom_disabled": true
        },
        "invocation": "java -Xms128M -Xmx512M -jar server.jar",
        "docker_image": "ghcr.io/pterodactyl/yolks:java_17",
        "egg_features": [
          "eula",
          "java_version",
          "pid_limit"
        ],
        "feature_limits": {
          "databases": 5,
          "allocations": 5,
          "backups": 2
        },
        "status": null,
        "is_suspended": false,
        "is_installing": false,
        "is_transferring": false,
        "relationships": {
          "allocations": {
            "object": "list",
            "data": [
              {
                "object": "allocation",
                "attributes": {
                  "id": 1,
                  "ip": "45.86.168.218",
                  "ip_alias": null,
                  "port": 25565,
                  "notes": null,
                  "is_default": true
                }
              },
              {
                "object": "allocation",
                "attributes": {
                  "id": 2,
                  "ip": "45.86.168.218",
                  "ip_alias": null,
                  "port": 25566,
                  "notes": "Votifier",
                  "is_default": false
                }
              }
            ]
          },
          "variables": {
            "object": "list",
            "data": [
              {
                "object": "egg_variable",
                "attributes": {
                  "name": "Server Jar File",
                  "description": "The name of the server jarfile to run the server with.",
                  "env_variable": "SERVER_JARFILE",
                  "default_value": "server.jar",
                  "server_value": "server.jar",
                  "is_editable": true,
                  "rules": "required|regex:/^([\\w\\d._-]+)(\\.jar)$/"
                }
              }
            ]
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {}
    }
  }
}