Pterodactyl Client icon

Pterodactyl Client

User-level server management with Pterodactyl Panel Client API

Server → List

AI-generated

Summary

Retrieve a list of all accessible game servers for the authenticated user through the Pterodactyl Client API.

Inputs

  • Return All — Boolean to specify whether to return all available server results or limit the number returned.
  • Limit — When 'Return All' is false, sets the maximum number of server records to return (minimum 1, maximum 100).

Output shape

A list of JSON objects, each representing a server accessible by the client user.

If 'Return All' is set to true, all servers are returned. Otherwise, the number of returned servers is capped by the 'Limit' value. Errors in listing servers are returned as error messages within the workflow execution.

Examples

Example 1: List all servers

Set 'Return All' to true to retrieve all accessible servers.

Example 2: List a limited number of servers

Set 'Return All' to false and specify a 'Limit' to retrieve up to that many servers.

Discussion