Start here. Returns the panel version and host, the record counts (users, servers, nodes, eggs, database hosts, ...), and — unless you turn them off — CPU/memory/disk figures and clock/migration health. One call to orient yourself before drilling in.

Health detail: clock offsets against NTP, applied vs pending database migrations, and per-node reachability. Use nodes: true for the node-by-node view.

List backup configurations — the S3 / Restic / PBS / Kopia targets that locations, nodes and servers back up to. Credentials inside them are redacted unless CALAGOPUS_ALLOW_SECRETS is set.

List scheduled panel-wide backup policies and what each one targets (locations, nodes, servers).

List the backend extensions installed on the panel, with their version and enabled state.

List configured SSO/OAuth providers and their role mappings. Client secrets are redacted unless CALAGOPUS_ALLOW_SECRETS is set.

List user accounts on the Calagopus panel, newest page first. Use search to match a username, email or name. Requires the users.read admin permission.

Fetch one user by UUID, or by the external ID carried over from a billing system or a Pterodactyl/Pelican migration.

List the servers owned by one user. Answers 'what does this customer actually have' without paging the whole server list.

Audit trail for one user: logins, server actions, API key use. Requires users.activity.

List roles and the admin/server permission sets they grant. Useful for working out why a user can or cannot do something.

Panel-wide admin audit log, most recent first. Optionally scope to one user with user. Requires activity.read.

List game servers across the whole panel. search matches the server name, UUID and owner. Each record names its node, owner, egg and primary allocation. Requires servers.read.

Fetch one server by UUID (full or short), or by external ID. detail: "full" adds the complete egg, node and owner records plus the startup command and every limit.

Fetch one facet of a server: its allocations, egg variables, backups, databases, database instances, mounts, or its console and install logs.

List the wings nodes attached to the panel, with their location, public URL, SFTP endpoint and memory/disk allocation limits. Requires nodes.read.

Fetch one node by UUID, including its location and backup configuration.

Fetch one facet of a node: the servers on it, its allocations (all, free, or just the IPs), backups, mounts, capacity headroom, attached database hosts, in-flight transfers, or live system overview/stats/logs from the wings daemon. The system_* facets require the node to be online.

List the locations nodes are grouped into, with the backup configuration each one inherits.

List host-path mounts that can be attached to eggs, nodes and servers.

List nests — the groups eggs are organised into (Minecraft, Source, Rust, ...). Requires nests.read.

List eggs (server templates). Omit nest to get every egg on the panel grouped by nest; pass a nest UUID to page through just that nest's eggs. The summary drops the install script and the upstream repository copy — ask for a single egg with detail 'full' when you need those. Requires eggs.read.

Fetch one egg. detail: "full" includes the install script, config files, startup parsing rules and the upstream repository copy — that is ~13 KB, so prefer the summary unless you need the scripts.

List the environment variables an egg declares: name, env var, default value, validation rules, and whether the user may see or edit each one.

List every server created from one egg. Use this before changing an egg to see the blast radius.

List the git repositories eggs are synced from, and when each last synced. Pass repository to list the eggs available in one of them.

List reusable egg configuration presets (shared startup/stop/script blocks eggs can inherit).

List the external database servers the panel hands out user databases on, with their type, public host/port and deployment state. Connection credentials are redacted unless CALAGOPUS_ALLOW_SECRETS is set. Requires database-hosts.read.

Fetch one database host by UUID. Set databases: true to list the databases currently provisioned on it instead.

List database agent hosts — machines running the Calagopus database agent, which provisions containerised database instances from templates. Shows the agent URL and its memory/disk budget. Requires database-agent-hosts.read.

Fetch one database agent host by UUID.

Fetch one facet of a database agent host: the database instances running on it, its remaining capacity, its agent config, or live system overview/stats. The instances, capacity and system_* facets need the agent to be reachable.

List the templates the database agent provisions instances from: engine type, docker images, and the CPU/memory/disk each instance gets. Requires database-agent-templates.read.

Search users, servers, nodes and eggs in one call and get the matches side by side. Use this when you have a name, email, IP or partial UUID and do not yet know what kind of thing it is.

Search this panel's live OpenAPI spec for endpoints. Use it when no dedicated tool covers what you need, then call calagopus_get with the path you find. Reflects the panel's actual version, including routes added by extensions.

Escape hatch: issue a raw authenticated GET against any path on the configured panel and return the JSON verbatim. Use it for endpoints the dedicated tools do not cover — find paths with calagopus_list_endpoints first. Only GET is possible; this server cannot create, modify or delete anything.