The control-plane API

Every network the credential can reach. For a session that includes networks another account invited you into; for an API key it is only the account's own.

The dashboard home in one call: server and node counts, players online, group health, and licence state.

Every server, with its group, node, state, player count and uptime. A role confined to particular groups sees only those.

Stops a server. Drains by default, so players are moved before it goes down.

Starts a stopped persistent server. Servers in dynamic groups are destroyed when they stop and cannot be started again — the controller creates a replacement instead.

Stops and starts in one request.

Tears the server down. Whether its data directory is destroyed follows the owning group's persistence — static keeps the world, dynamic discards it — and is never taken from the request.

Every group with its scaling settings and current server count.

Partial update — every field is optional and only what you send changes.

Deletes the group and tears down its servers.

Replaces the group's template assignment wholesale.

Every node with its capacity, agent version, address and last heartbeat.

Mints a single-use enrolment token and returns the install command for a new machine.

Controls which groups may be placed on this node. Its own path rather than more fields on the PATCH above, because renaming is cosmetic and this moves workloads.

Asks the node's agent to update itself now rather than on its next scheduled check.

Retires the node: drains its servers, then removes it from placement.

Every template with its files, versions and group assignment.

One template: files with sizes and hashes, version history, and which groups it reaches.

Deletes the template and every server running one of its versions.

Uploads one file as a raw body — content-type: application/octet-stream, not multipart. Returns the sha256 to reference when publishing. Any file type is accepted here; the size limit and your storage quota apply.

Reads a text file as a string. Restricted to text extensions — cfg conf csv env ini json lang list md properties sh toml txt xml yaml yml — and to files of 1 MB or less. Anything else answers 400.

Writes a text file and publishes a new version in the same call. Creates the file when nothing is at that path, so this is also how you add one without uploading. .json content is parsed and rejected if invalid.

Removes a file from the template and publishes a new version.

Publishes a version. The files list is the complete manifest, not a delta: anything omitted is gone from the new version.

Every backup with its size, server, and creation time, plus the per-group policies.

Takes a backup now. Returns a job; the archive appears in the list when it finishes.

Replaces the server's working directory with the archive. The current data is kept until the restored server starts cleanly, and put back if it does not.

Deletes the archive and frees the storage it counted against.

Headline figures: unique players, sessions, countries, retention and playtime distribution.

One player: sessions, playtime, countries seen, and which servers they visited.

Erases the player's identity while leaving the aggregate counts intact. Its own permission because it is the one player action that cannot be undone.

What is collected and how long it is kept.

Changes collection and retention.

Members, pending invitations, and the roles available to assign.

Emails an invitation. If the address has no Atlas account, the link leads to registration and admits them on completion.

Revokes a pending invitation.

Changes someone's role.

Removes someone from the network.

Leaves a network you were invited to. Separate from removal so that "remove a member" can refuse to act on yourself without also making it impossible to leave.

Replaces the role's definition. Same body as creation.

Deletes a custom role. Answers 409 if anyone still holds it, and refuses on the built-in roles, which can be edited but not removed.

Whether Atlas writes the proxy's server list, and which groups it covers.

Reads the in-game command module's configuration.

Replaces it.

Whether console output is archived when a server ends, and for how long.

Replaces it.

The full captured output of one ended server.

The module's switch, its targeting, the game-kind groups available to target, and every NPC in the network.

Switches the module on or off and chooses which groups render NPCs. Reaches running servers immediately; nothing restarts.

Switched on, set to selected, and given no groups is refused with 400 — that combination is a setting that silently does nothing.

Every NPC on its own, for callers not drawing the settings page. Each carries its group, world and coordinates, appearance, what each click does, and its routing rules.

The resolved skin texture is deliberately not returned. It is a Mojang blob that only the server plugin needs, and it is the largest thing in the row.

Edits an NPC's appearance, behaviour, click actions and routing. Placement stays in game. The complete editable body contains display_name, skin_owner_name, item_in_hand, look_at_player, imitate_player, info_lines, left_click_action, right_click_action, and routing.

The routing document has its own guide, with worked examples: NPCs & routing rules.

routing.rules are evaluated in order. A rule's when.from_group_in names ingress proxy groups. lowest, highest and random take one group or a groups list and choose between them by live population; last_of returns the player to their most recently visited group among its groups. Every strategy may carry a fallback, nested at most twice. The document-level default is used when no condition matches and may be null.

The destination must be an active game group in this network. A named skin is resolved once and stored; the resolved Mojang texture is never returned by the API.

Deletes one NPC and pushes the new set to running servers immediately.