Host and manage Minecraft servers, mods, worlds and backups on Pixly.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Discards one or more (up to 50) unfinished or inspected uploads. Returns aborted and leftover. Installed files are removed with deleteAsset.
The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.
Pick your client. Values in capitals, like YOUR_TOKEN, are yours to fill in.
claude mcp add --transport http mcp https://pixly.gg/api/mcp
Discards one or more (up to 50) unfinished or inspected uploads. Returns aborted and leftover. Installed files are removed with deleteAsset.
| Argument | Type | Description |
|---|---|---|
| body | object | |
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"body": {
"type": "object",
"required": [
"uploads"
],
"properties": {
"uploads": {
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"uploadId"
],
"properties": {
"key": {
"type": "string",
"minLength": 1,
"description": "key returned by the start call; pass it unchanged."
},
"uploadId": {
"type": "string",
"minLength": 1,
"description": "uploadId returned by the start call for this file."
}
}
},
"maxItems": 50,
"minItems": 1
}
}
},
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Cancels an unfinished, or checked but not yet installed, modpack upload and discards the file. An installed modpack is not affected; remove it with deleteModpack.
| Argument | Type | Description |
|---|---|---|
| body | object | |
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"body": {
"type": "object",
"required": [
"key",
"uploadId"
],
"properties": {
"key": {
"type": "string",
"minLength": 1,
"description": "key returned by the start call; pass it unchanged."
},
"uploadId": {
"type": "string",
"minLength": 1,
"description": "uploadId returned by the start call for this file."
}
}
},
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Cancels an unfinished world upload and discards the parts uploaded so far. The server's current world is not affected. Only before completeWorldUpload.
| Argument | Type | Description |
|---|---|---|
| body | object | |
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"body": {
"type": "object",
"required": [
"key",
"uploadId"
],
"properties": {
"key": {
"type": "string",
"minLength": 1,
"description": "key returned by the start call; pass it unchanged."
},
"uploadId": {
"type": "string",
"minLength": 1,
"description": "uploadId returned by the start call for this file."
}
}
},
"path": {
"type": "object",
"required": [
"jobId",
"serverId"
],
"properties": {
"jobId": {
"type": "string",
"minLength": 1,
"description": "jobId from startWorldUpload."
},
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Cancels a restore from restoreBackup that an online server has not applied yet. Pass the queued backupId. Fails if nothing is queued for it or it is already being applied.
| Argument | Type | Description |
|---|---|---|
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"backupId",
"serverId"
],
"properties": {
"backupId": {
"type": "string",
"minLength": 1,
"description": "backupId from listBackups."
},
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Installs one or more (up to 50) files from startAssetUpload calls; resource packs go through setResourcePack. Files failing a check are returned in rejected with key and error; the rest apply at the next restart.
| Argument | Type | Description |
|---|---|---|
| body | object | |
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"body": {
"type": "object",
"required": [
"uploads"
],
"properties": {
"uploads": {
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"parts",
"uploadId"
],
"properties": {
"key": {
"type": "string",
"minLength": 1,
"description": "key returned by the start call; pass it unchanged."
},
"parts": {
"type": "array",
"items": {
"type": "object",
"required": [
"etag",
"partNumber"
],
"properties": {
"etag": {
"type": "string",
"minLength": 1,
"description": "ETag header from that piece's PUT response, quotes included."
},
"partNumber": {
"type": "integer",
"maximum": 10000,
"minimum": 1,
"description": "Piece number from the start call, from 1."
}
}
},
"maxItems": 10000,
"minItems": 1,
"description": "One entry per uploaded piece, in partNumber order."
},
"uploadId": {
"type": "string",
"minLength": 1,
"description": "uploadId returned by the start call for this file."
}
}
},
"maxItems": 50,
"minItems": 1
}
}
},
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Installs the .mrpack as the server's modpack, replacing loader, version and mods at the next restart; a backup is taken first. Pass uploadId, key and each ETag. Returns the server.
| Argument | Type | Description |
|---|---|---|
| body | object | |
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"body": {
"type": "object",
"required": [
"key",
"parts",
"uploadId"
],
"properties": {
"key": {
"type": "string",
"minLength": 1,
"description": "key returned by the start call; pass it unchanged."
},
"parts": {
"type": "array",
"items": {
"type": "object",
"required": [
"etag",
"partNumber"
],
"properties": {
"etag": {
"type": "string",
"minLength": 1,
"description": "ETag header from that piece's PUT response, quotes included."
},
"partNumber": {
"type": "integer",
"maximum": 10000,
"minimum": 1,
"description": "Piece number from the start call, from 1."
}
}
},
"maxItems": 10000,
"minItems": 1,
"description": "One entry per uploaded piece, in partNumber order."
},
"uploadId": {
"type": "string",
"minLength": 1,
"description": "uploadId returned by the start call for this file."
}
}
},
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Call after every piece is uploaded, with jobId, uploadId, key and each ETag. The current world is not changed: the archive is imported in the background (minutes) into a new backup with reason upload in listBackups. To play it, run restoreBackup with that backupId. Fails over 4 GiB or on low balance.
| Argument | Type | Description |
|---|---|---|
| body | object | |
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"body": {
"type": "object",
"required": [
"key",
"parts",
"uploadId"
],
"properties": {
"key": {
"type": "string",
"minLength": 1,
"description": "key returned by the start call; pass it unchanged."
},
"parts": {
"type": "array",
"items": {
"type": "object",
"required": [
"etag",
"partNumber"
],
"properties": {
"etag": {
"type": "string",
"minLength": 1,
"description": "ETag header from that piece's PUT response, quotes included."
},
"partNumber": {
"type": "integer",
"maximum": 10000,
"minimum": 1,
"description": "Piece number from the start call, from 1."
}
}
},
"maxItems": 10000,
"minItems": 1,
"description": "One entry per uploaded piece, in partNumber order."
},
"uploadId": {
"type": "string",
"minLength": 1,
"description": "uploadId returned by the start call for this file."
}
}
},
"path": {
"type": "object",
"required": [
"jobId",
"serverId"
],
"properties": {
"jobId": {
"type": "string",
"minLength": 1,
"description": "jobId from startWorldUpload."
},
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Takes a manual backup of the server's current world, which can later be restored or exported. Fails while the server is starting, stopping or restoring, before its first boot, or when the account balance is too low. Returns the backup as pending; listBackups shows it completed when done. Name a backup to the user by its time and reason; never show its backupId.
| Argument | Type | Description |
|---|---|---|
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Creates a server, asleep and free until startServer or a joining player wakes it, and returns it with its id and join address. Region sets player latency and cannot change later: ask where players are if unknown; regions and size prices come from getPricingCatalog. Optional content from Modrinth, CurseForge or a link downloads on first start; uploaded files are added afterwards with the asset or modpack upload tools. Accounts hold a limited number of servers; at the limit, delete one with deleteServer.
| Argument | Type | Description |
|---|---|---|
| body* | object |
{
"type": "object",
"required": [
"body"
],
"properties": {
"body": {
"type": "object",
"required": [
"name",
"region",
"size"
],
"properties": {
"name": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Name shown to the owner and used in the join address."
},
"size": {
"enum": [
"c.medium",
"m.medium",
"r.medium",
"c.large",
"m.large",
"r.large",
"c.xlarge",
"m.xlarge",
"r.xlarge",
"m.2xlarge",
"r.2xlarge",
"r.4xlarge"
],
"type": "string",
"description": "Size class: c compute-heavy, m balanced, r extra memory; each step from medium to 4xlarge doubles memory. Prices are in getPricingCatalog. Use m.medium (4 GB) unless the user asked for more; ask before choosing a larger size."
},
"config": {
"type": "object",
"required": [],
"properties": {
"ops": {
"type": "array",
"items": {
"type": "object",
"required": [
"bypassesPlayerLimit",
"level",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 16,
"minLength": 1
},
"uuid": {
"type": "string",
"minLength": 1,
"description": "Optional; filled from the name."
},
"level": {
"type": "integer",
"maximum": 4,
"minimum": 1,
"description": "Operator level 1 to 4; 4 runs every command."
},
"bypassesPlayerLimit": {
"type": "boolean"
}
}
},
"description": "Players with operator rights, who can run admin commands in game."
},
"pvp": {
"type": "boolean",
"description": "Players can hurt each other; default on."
},
"icon": {
"type": "string",
"maxLength": 32768,
"description": "Server list icon as a base64 data URI of a 64x64 PNG."
},
"motd": {
"type": "string",
"maxLength": 2048,
"description": "Message shown under the server name in the multiplayer list."
},
"type": {
"enum": [
"VANILLA",
"FABRIC",
"FORGE",
"NEOFORGE",
"PAPER",
"PUFFERFISH",
"PURPUR",
"LEAF",
"FOLIA",
"QUILT"
],
"type": "string",
"description": "Server software: VANILLA, a mod loader (FABRIC, FORGE, NEOFORGE, QUILT) or a plugin server (PAPER and its forks). It decides which mods or plugins can be installed."
},
"modpack": {
"type": "object",
"required": [
"coord"
],
"properties": {
"name": {
"type": "string"
},
"side": {
"enum": [
"client",
"server",
"both"
],
"type": "string"
},
"bytes": {
"type": "integer",
"minimum": 1,
"description": "Filled in by Pixly; omit."
},
"coord": {
"type": "string",
"maxLength": 1024,
"minLength": 1,
"description": "Modrinth or CurseForge project id of the modpack."
},
"iconId": {
"type": "string",
"maxLength": 32
},
"loader": {
"enum": [
"VANILLA",
"FABRIC",
"FORGE",
"NEOFORGE",
"PAPER",
"PUFFERFISH",
"PURPUR",
"LEAF",
"FOLIA",
"QUILT"
],
"type": "string",
"description": "Filled in by Pixly; omit."
},
"source": {
"enum": [
"modrinth",
"curseforge",
"upload"
],
"type": "string"
},
"version": {
"type": "string",
"maxLength": 48
},
"crc64nvme": {
"type": "string",
"pattern": "^[A-Za-z0-9+/]{11}=$",
"description": "Filled in by Pixly; omit."
},
"fileCount": {
"type": "integer",
"maximum": 10000,
"minimum": 0
},
"minecraft": {
"type": "string",
"description": "Filled in by Pixly; omit."
},
"description": {
"type": "string"
},
"downloadBytes": {
"type": "integer",
"maximum": 1099511627776,
"minimum": 0
},
"loaderVersion": {
"type": "string",
"maxLength": 48
}
},
"description": "A Modrinth or CurseForge modpack to run, downloaded from that site when the server starts. An uploaded .mrpack is set through the modpack upload operations instead."
},
"version": {
"type": "string",
"maxLength": 20,
"description": "Minecraft version such as 1.21.4; leave unset for the latest release. For a type other than VANILLA it must be listed for that type in getLoaderVersions."
},
"gamemode": {
"enum": [
"survival",
"creative",
"adventure",
"spectator"
],
"type": "string",
"description": "Mode new players start in."
},
"hardcore": {
"type": "boolean",
"description": "One life; dead players become spectators. Default off."
},
"projects": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1024,
"minLength": 1
},
{
"type": "object",
"required": [
"coord"
],
"properties": {
"kind": {
"enum": [
"mod",
"modpack",
"plugin",
"datapack",
"resourcepack"
],
"type": "string"
},
"bytes": {
"type": "integer",
"minimum": 1
},
"coord": {
"type": "string",
"maxLength": 1024,
"minLength": 1
},
"source": {
"enum": [
"modrinth",
"curseforge",
"url",
"upload"
],
"type": "string"
},
"metadata": {
"type": "object",
"required": [],
"properties": {
"id": {
"type": "string",
"maxLength": 96
},
"name": {
"type": "string",
"maxLength": 96
},
"side": {
"enum": [
"client",
"server",
"both"
],
"type": "string"
},
"author": {
"type": "string"
},
"iconId": {
"type": "string",
"maxLength": 32
},
"loader": {
"enum": [
"fabric",
"quilt",
"forge",
"neoforge",
"bukkit",
"paper"
],
"type": "string"
},
"version": {
"type": "string",
"maxLength": 48
},
"minecraft": {
"type": "string",
"maxLength": 48
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"required": [
"text"
],
"properties": {
"bold": {
"type": "boolean"
},
"text": {
"type": "string"
},
"color": {
"type": "string"
},
"extra": {
"type": "array",
"items": {
"type": "object",
"required": [
"text"
],
"properties": {
"bold": {
"type": "boolean"
},
"text": {
"type": "string"
},
"color": {
"type": "string"
},
"italic": {
"type": "boolean"
},
"obfuscated": {
"type": "boolean"
},
"underlined": {
"type": "boolean"
},
"strikethrough": {
"type": "boolean"
}
}
}
},
"italic": {
"type": "boolean"
},
"obfuscated": {
"type": "boolean"
},
"underlined": {
"type": "boolean"
},
"strikethrough": {
"type": "boolean"
}
}
}
]
}
}
},
"settings": {
"type": "object",
"required": [],
"properties": {},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 256
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"crc64nvme": {
"type": "string",
"pattern": "^[A-Za-z0-9+/]{11}=$"
}
}
}
]
},
"maxItems": 768,
"description": "Mods, plugins and datapacks to install from Modrinth, CurseForge or a direct download link, which the server downloads when it starts. A string is a Modrinth project id; an object names its source (modrinth, curseforge or url) and coord (the project id or the link). A Modrinth datapack uses the coord datapack:<project id> with kind datapack. Uploaded files are managed through the asset upload operations and kept as they are."
},
"levelSeed": {
"type": "string",
"pattern": "^[^\\x00-\\x1F\\x7F-\\x9F]*$",
"maxLength": 64,
"description": "Applies only to a world not yet generated; use resetServer to regenerate."
},
"levelType": {
"enum": [
"flat",
"largebiomes",
"amplified"
],
"type": "string",
"description": "Generator for a new world: flat, largebiomes, amplified; unset is normal."
},
"whitelist": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 16,
"minLength": 1
},
"uuid": {
"type": "string",
"minLength": 1,
"description": "Optional; filled from the name."
}
}
},
"description": "Players allowed to join while whitelistEnabled is on."
},
"difficulty": {
"enum": [
"peaceful",
"easy",
"normal",
"hard"
],
"type": "string",
"description": "Game difficulty."
},
"maxPlayers": {
"type": "integer",
"maximum": 1000,
"minimum": 0,
"description": "Most players online at once; default 20."
},
"onlineMode": {
"type": "boolean",
"description": "Only players signed in with an official Minecraft account can join. On by default."
},
"allowFlight": {
"type": "boolean",
"description": "Let players fly in survival without being kicked; default off."
},
"serverImage": {
"enum": [
"java25",
"java21",
"java17",
"java8"
],
"type": "string",
"description": "Java runtime. Leave unset: it is chosen from the version and content. Set only when the user asks for a Java version; java8 runs Minecraft older than 1.17."
},
"viewDistance": {
"type": "integer",
"maximum": 32,
"minimum": 3,
"description": "How far players can see, in chunks."
},
"forceGamemode": {
"type": "boolean",
"description": "Put players in gamemode every time they join; default off."
},
"spawnMonsters": {
"type": "boolean",
"description": "Hostile mobs spawn; default on."
},
"bedrockEnabled": {
"type": "boolean",
"description": "Also let Bedrock Edition players on phones, consoles and Windows join. Works only on a type and version inside getBedrockRange."
},
"spawnProtection": {
"type": "integer",
"maximum": 256,
"minimum": 0,
"description": "Radius in blocks around spawn where only operators can build."
},
"voiceChatEnabled": {
"type": "boolean",
"description": "Turn on proximity voice chat; players need the matching voice chat mod."
},
"whitelistEnabled": {
"type": "boolean",
"description": "Only players on the whitelist or operators can join. On when unset."
},
"playerIdleTimeout": {
"type": "integer",
"maximum": 1440,
"minimum": 0,
"description": "Minutes before an idle player is disconnected; 0 never disconnects."
},
"voiceChatProvider": {
"enum": [
"simple-voice-chat",
"plasmo-voice"
],
"type": "string",
"description": "Which voice chat mod is used when voice chat is on; players need the same mod."
},
"enableCommandBlock": {
"type": "boolean",
"description": "Command blocks run; the default depends on the Minecraft version."
},
"simulationDistance": {
"type": "integer",
"maximum": 32,
"minimum": 3,
"description": "How far from players the world keeps running, in chunks."
},
"resourcePackRequired": {
"type": "boolean",
"description": "Disconnect players who decline the server's resource pack."
}
}
},
"region": {
"type": "string",
"minLength": 1,
"description": "Region id from getPricingCatalog nearest to where the players are. Ask the user when they have not said; never guess one or infer it from where the request comes from. It cannot be changed later."
}
}
}
},
"additionalProperties": false
}Uninstalls a custom mod, plugin or datapack file that was uploaded to the server and deletes the file, taking effect at the next restart. The file can only be recovered from a backup.
| Argument | Type | Description |
|---|---|---|
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"fileName",
"serverId"
],
"properties": {
"fileName": {
"type": "string",
"maxLength": 256,
"minLength": 1,
"description": "Installed file name, as listed in the server's uploaded content."
},
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Permanently deletes one backup; this cannot be undone. A backup that is queued for restore or being exported cannot be deleted. For the only remaining copy of a world the call is refused with requiresConfirmation; ask the user, then repeat with confirm true.
| Argument | Type | Description |
|---|---|---|
| path* | object | |
| query | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"backupId",
"serverId"
],
"properties": {
"backupId": {
"type": "string",
"minLength": 1,
"description": "backupId from listBackups."
},
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
},
"query": {
"type": "object",
"required": [],
"properties": {
"confirm": {
"enum": [
"true"
],
"type": "string",
"description": "true only after the user confirms deleting the last copy."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Deletes the downloadable archive made by startBackupExport. The backup itself is kept and can be exported again.
| Argument | Type | Description |
|---|---|---|
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"backupId",
"serverId"
],
"properties": {
"backupId": {
"type": "string",
"minLength": 1,
"description": "backupId from listBackups."
},
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Uninstalls the server's uploaded custom modpack and deletes the file, taking effect at the next restart. The world is kept, though the server may then suggest a world reset to clear content the pack left behind.
| Argument | Type | Description |
|---|---|---|
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Permanently deletes the server with its world, settings, backups and exports, shutting it down if running. Call it only for a server the user named in this request, one server per call; for a request that names none or covers several, such as delete my servers, list them with listServers and ask which to delete first. For a fresh world use resetServer. To keep the world, first startBackupExport and download it with getBackupDownloadUrl. The user can also delete it on the Danger tab of the webUrl from listServers (webUrl followed by danger/). Returns deleted: true.
| Argument | Type | Description |
|---|---|---|
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Clears the notice for a player the whitelist turned away; it does not whitelist, kick or ban. To let them in, add them to whitelist with updateServer. Returns the server.
| Argument | Type | Description |
|---|---|---|
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"playerName",
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
},
"playerName": {
"type": "string",
"minLength": 1,
"description": "Player name from joinAttempts in listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Returns a signed link, valid for 6 hours, to download a backup exported with startBackupExport. Fails if the export is not ready yet; requires a paid account. Returns url (a .tar.gz for the user) and expiresAt.
| Argument | Type | Description |
|---|---|---|
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"backupId",
"serverId"
],
"properties": {
"backupId": {
"type": "string",
"minLength": 1,
"description": "backupId from listBackups."
},
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Shows the signed-in user's balance, this month's spend so far and projected total, and what awake servers cost per hour. Call it when the user asks about their balance or spending. It cannot add funds. When the user asks to add funds: show the balance and addFunds with a link to dashboardUrl, and no other link, no button, amount, total after adding or steps.
No arguments.
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
}Returns the Java version range Bedrock players can join, for fabric, neoforge and spigot (Paper and its forks); an empty string means unknown. Check it before enabling config.bedrockEnabled.
No arguments.
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
}Returns up to 200 recent console lines, including startup, oldest first. Use it to see why a server failed to start or what happened in game; it cannot run commands. Returns events, nextCursor (newer) and prevCursor (older); platform notices are left out, so a page can hold fewer lines, or none, while prevCursor still leads to older ones. degraded: true means the read timed out, retry. Show lines to the user in a code block, one per line.
| Argument | Type | Description |
|---|---|---|
| path* | object | |
| query | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
},
"query": {
"type": "object",
"required": [],
"properties": {
"before": {
"type": "string",
"description": "prevCursor from a previous call; overrides cursor."
},
"cursor": {
"type": "string",
"description": "nextCursor from a previous call."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Lists the Minecraft versions each config.type can run, keyed by type. Use it before createServer or updateServer to choose config.version. VANILLA is omitted because it runs every version; a missing type means its list is unavailable.
No arguments.
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
}Breaks this calendar month's spend so far down by server: cost, compute cost and time awake. Match each serverId to a name with listServers and name servers by that name. For the total and the balance use getBalance.
No arguments.
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
}Returns estimated monthly prices in US cents, as the site shows them, for every available region and size under three play schedules (casual, regular, evenings), plus always-on host references when available. Name each size by its memoryGb, adding vcpu when two sizes share the same memory; the size value is only for createServer. The hourly price the site shows for a size is its lowest monthlyCents divided by hoursPerMonth across the schedules, rounded to a whole cent and never below 1 cent. Use it to quote prices or choose region and size: pass a region's id (not awsRegion) as createServer region, and a size as size. Works without sign-in.
No arguments.
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
}Returns the server's load samples over the last minutes (default 30, up to 360), oldest first, one about every 30 seconds while it runs. Each point has its time, memory use, tick load in permille (divide by 20 for milliseconds per tick; 1000 means the server is lagging) and peak players. Gaps mean the server was asleep or starting. Use it to explain when and why a server lagged.
| Argument | Type | Description |
|---|---|---|
| path* | object | |
| query | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
},
"query": {
"type": "object",
"required": [],
"properties": {
"minutes": {
"type": "integer",
"maximum": 360,
"minimum": 1,
"description": "How many minutes back to read, 1 to 360."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Returns the time the server spent with at least one player online in its latest unbroken run on its current size (its last 7 days with players, or more days back until they hold 8 hours), histograms of CPU, tick load, GC pause share, memory peak, the JVM's live set and memory outside its heap over that time, and suggestion: the smaller, cheaper size that would carry the same play, or null when the current size is needed or that run holds less than 8 hours of play. Use suggestion to answer whether the server can run on a smaller size; changing size is updateServer with the target size and applies on the next start.
| Argument | Type | Description |
|---|---|---|
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Completes a startAssetUpload and reports its kind, size and metadata without installing it. To install, pass it to completeAssetUploads, or setResourcePack with its key for a resource pack; abortAssetUploads discards it.
| Argument | Type | Description |
|---|---|---|
| body | object | |
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"body": {
"type": "object",
"required": [
"key",
"parts",
"uploadId"
],
"properties": {
"key": {
"type": "string",
"minLength": 1,
"description": "key returned by the start call; pass it unchanged."
},
"parts": {
"type": "array",
"items": {
"type": "object",
"required": [
"etag",
"partNumber"
],
"properties": {
"etag": {
"type": "string",
"minLength": 1,
"description": "ETag header from that piece's PUT response, quotes included."
},
"partNumber": {
"type": "integer",
"maximum": 10000,
"minimum": 1,
"description": "Piece number from the start call, from 1."
}
}
},
"maxItems": 10000,
"minItems": 1,
"description": "One entry per uploaded piece, in partNumber order."
},
"uploadId": {
"type": "string",
"minLength": 1,
"description": "uploadId returned by the start call for this file."
}
}
},
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Completes a startModpackUpload and returns its version, loader and contents without installing. To install, call completeModpackUpload with the same arguments; abortModpackUpload discards it.
| Argument | Type | Description |
|---|---|---|
| body | object | |
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"body": {
"type": "object",
"required": [
"key",
"parts",
"uploadId"
],
"properties": {
"key": {
"type": "string",
"minLength": 1,
"description": "key returned by the start call; pass it unchanged."
},
"parts": {
"type": "array",
"items": {
"type": "object",
"required": [
"etag",
"partNumber"
],
"properties": {
"etag": {
"type": "string",
"minLength": 1,
"description": "ETag header from that piece's PUT response, quotes included."
},
"partNumber": {
"type": "integer",
"maximum": 10000,
"minimum": 1,
"description": "Piece number from the start call, from 1."
}
}
},
"maxItems": 10000,
"minItems": 1,
"description": "One entry per uploaded piece, in partNumber order."
},
"uploadId": {
"type": "string",
"minLength": 1,
"description": "uploadId returned by the start call for this file."
}
}
},
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Delays a running server's idle sleep by 5 minutes from now; it keeps being charged meanwhile. Use it while working on a server with no players online; to wake an asleep server use startServer. Fails with 409 if not running. Returns sleepAt.
| Argument | Type | Description |
|---|---|---|
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Lists backups newest first with backupId, startTime, sizeBytes, reason (daily, manual, upload, freeze, reset, config-change) and exportState (idle, exporting, ready). Pass backupId to restoreBackup, cancelBackupRestore, startBackupExport, getBackupDownloadUrl (exportState ready) or deleteBackup. Name a backup to the user by its time and reason; never show its backupId.
| Argument | Type | Description |
|---|---|---|
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Lists past calendar months' bills, newest first, each with its cost per server. status pending means the month is closed but its bill is not final yet. Match each serverId to a name with listServers; a deleted server no longer appears there.
No arguments.
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
}Lists the account's servers with id, name, join address, region, size, settings, state and recent disk, memory and lag figures. runtime.loadCause, when present, says why a server keeps lagging with players on: memory (garbage collection), cpu-starved (one core shared with background work; a second core fixes it), run-bound (the world's own work; optimise rather than upsize) or unclassified. For when and how badly it lagged, use getServerMetrics. Use it to find the serverId other tools take, by the name the user knows. A server is online only when statusDetail is server-online; desiredState stopped means asleep. joinAttempts lists players the whitelist turned away (see dismissJoinAttempt).
No arguments.
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
}Returns new one-hour links for pieces of a startWorldUpload whose links expired. Pass jobId, uploadId, key and the pieces still to upload.
| Argument | Type | Description |
|---|---|---|
| body | object | |
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"body": {
"type": "object",
"required": [
"key",
"partNumbers",
"uploadId"
],
"properties": {
"key": {
"type": "string",
"minLength": 1,
"description": "key returned by the start call; pass it unchanged."
},
"uploadId": {
"type": "string",
"minLength": 1,
"description": "uploadId returned by the start call for this file."
},
"partNumbers": {
"type": "array",
"items": {
"type": "integer",
"maximum": 10000,
"minimum": 1
},
"maxItems": 10000,
"minItems": 1,
"description": "Pieces not yet uploaded whose links expired."
}
}
},
"path": {
"type": "object",
"required": [
"jobId",
"serverId"
],
"properties": {
"jobId": {
"type": "string",
"minLength": 1,
"description": "jobId from startWorldUpload."
},
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Replaces the world with a fresh one, keeping settings, content and address; for an earlier world use restoreBackup instead. A running server disconnects its players and comes back online on the new world. A reset backup of the current world is taken first and earlier backups are kept, but the archived world of a long-asleep server is discarded. The user can also reset it on the Danger tab of the webUrl from listServers (webUrl followed by danger/). Returns the server.
| Argument | Type | Description |
|---|---|---|
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Reboots a running server's machine; players are disconnected for a minute or two while it boots and fetches its content from Modrinth, CurseForge or their download links. Use it for a pending size change or a stuck server; for changed game settings use restartToApplySettings. A restore queued with restoreBackup replaces the world during the reboot, and the restart needs enough account balance for the server's size. Fails unless the server is running (use startServer); returns the server.
| Argument | Type | Description |
|---|---|---|
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Restarts only the Minecraft program on an online server so changed settings apply; players drop for a few seconds while it reloads content from Modrinth, CurseForge or their download links. Use it when the server reports a restart is required; for a size change use restartServer. If a pending change needs a full reboot (size, or a restore queued with restoreBackup) it reboots the machine instead. Fails unless online (use startServer).
| Argument | Type | Description |
|---|---|---|
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Replaces the whole world with the chosen backup. No backup of the current world is taken, so everything since that backup is lost unless you run createBackup first. An asleep server restores at once; an online server applies it at the next restartServer or restartToApplySettings, and until then cancelBackupRestore undoes it. A different backupId replaces a queued restore.
| Argument | Type | Description |
|---|---|---|
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"backupId",
"serverId"
],
"properties": {
"backupId": {
"type": "string",
"minLength": 1,
"description": "backupId from listBackups."
},
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Sets the resource pack players are offered on join, from Modrinth, an uploaded .zip or a link; from: none removes it. It applies at the next restart (restartToApplySettings). Make it mandatory with resourcePackRequired in updateServer. Returns the server.
| Argument | Type | Description |
|---|---|---|
| body* | any | |
| path* | object |
{
"type": "object",
"required": [
"path",
"body"
],
"properties": {
"body": {
"oneOf": [
{
"type": "object",
"required": [
"from",
"projectId"
],
"properties": {
"from": {
"enum": [
"modrinth"
],
"type": "string",
"description": "modrinth: a Modrinth project; upload: a .zip from startAssetUpload; link: a direct https link; none: remove the pack."
},
"projectId": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Modrinth project id, not the slug."
}
}
},
{
"type": "object",
"required": [
"from",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 512,
"minLength": 1,
"description": "key from startAssetUpload, after inspectAssetUpload has completed the upload. The upload is used up on success."
},
"from": {
"enum": [
"upload"
],
"type": "string",
"description": "modrinth: a Modrinth project; upload: a .zip from startAssetUpload; link: a direct https link; none: remove the pack."
}
}
},
{
"type": "object",
"required": [
"from",
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 2048,
"minLength": 1,
"description": "Direct https link to the .zip; it is downloaded and checked now."
},
"from": {
"enum": [
"link"
],
"type": "string",
"description": "modrinth: a Modrinth project; upload: a .zip from startAssetUpload; link: a direct https link; none: remove the pack."
}
}
},
{
"type": "object",
"required": [
"from"
],
"properties": {
"from": {
"enum": [
"none"
],
"type": "string",
"description": "modrinth: a Modrinth project; upload: a .zip from startAssetUpload; link: a direct https link; none: remove the pack."
}
}
}
]
},
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Only for an assistant that can send the user's file with HTTP PUT, such as a coding agent with a shell. Begins uploading one .jar or .zip mod, plugin, datapack or resource pack (up to 512 MiB, storage capped per server and account) and returns uploadId, key, fileName and parts: PUT each piece within an hour and keep each ETag. Then completeAssetUploads installs mods, plugins and datapacks, inspectAssetUpload checks a file or readies a resource pack for setResourcePack, and abortAssetUploads discards it.
| Argument | Type | Description |
|---|---|---|
| body | object | |
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"body": {
"type": "object",
"required": [
"fileName",
"fileSize",
"partCount"
],
"properties": {
"fileName": {
"type": "string",
"maxLength": 256,
"minLength": 1,
"description": "File name with extension, e.g. mymod.jar."
},
"fileSize": {
"type": "integer",
"maximum": 536870912,
"minimum": 1,
"description": "Exact size in bytes."
},
"partCount": {
"type": "integer",
"maximum": 10000,
"minimum": 1,
"description": "Number of 8 MiB pieces: ceil(fileSize / 8388608)."
}
}
},
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Packages a backup into a downloadable archive. Requires a paid account and balance; refused while another upload, export or restore is pending (at most 3 per account). Poll listBackups until exportState is ready, then call getBackupDownloadUrl; if it returns to idle instead, the export failed.
| Argument | Type | Description |
|---|---|---|
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"backupId",
"serverId"
],
"properties": {
"backupId": {
"type": "string",
"minLength": 1,
"description": "backupId from listBackups."
},
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Only for an assistant that can send the user's file with HTTP PUT, such as a coding agent with a shell. Begins uploading a Modrinth .mrpack (up to 1 GiB). Returns uploadId, key, fileName and parts (url valid one hour): PUT each piece, keep each ETag, then completeModpackUpload. Refused when a modpack is set: deleteModpack removes an uploaded one, updateServer a catalog one.
| Argument | Type | Description |
|---|---|---|
| body | object | |
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"body": {
"type": "object",
"required": [
"fileName",
"fileSize",
"partCount"
],
"properties": {
"fileName": {
"type": "string",
"maxLength": 256,
"minLength": 1,
"description": "File name with extension, e.g. pack.mrpack."
},
"fileSize": {
"type": "integer",
"maximum": 1073741824,
"minimum": 1,
"description": "Exact size in bytes."
},
"partCount": {
"type": "integer",
"maximum": 10000,
"minimum": 1,
"description": "Number of 8 MiB pieces: ceil(fileSize / 8388608)."
}
}
},
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Wakes an asleep server so players can join it from the internet at its address; not for an online server (use restartServer). While booting it fetches its mods, plugins and modpack from Modrinth, CurseForge or their download links, and a backup queued with restoreBackup replaces the current world. Starting needs enough account balance for the server's size, which pays for the running server. Returns the server; poll listServers until statusDetail is server-online, a few minutes later.
| Argument | Type | Description |
|---|---|---|
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Only for an assistant that can send the user's file with HTTP PUT, such as a coding agent with a shell. Begins uploading a world archive (.zip, .tar.gz, .tgz; up to 4 GiB). Returns jobId, uploadId, key and parts (partNumber, url valid one hour): PUT each piece to its url, keep each ETag, then call completeWorldUpload. Refused while another upload, export or restore is pending.
| Argument | Type | Description |
|---|---|---|
| body | object | |
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"body": {
"type": "object",
"required": [
"fileName",
"fileSize",
"partCount"
],
"properties": {
"fileName": {
"type": "string",
"maxLength": 256,
"minLength": 1,
"description": "File name with extension, e.g. world.zip."
},
"fileSize": {
"type": "integer",
"maximum": 4294967296,
"minimum": 1,
"description": "Exact size in bytes."
},
"partCount": {
"type": "integer",
"maximum": 10000,
"minimum": 1,
"description": "Number of 8 MiB pieces: ceil(fileSize / 8388608)."
}
}
},
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Shuts a running server down so it sleeps, disconnecting players and ending running charges; world and settings are kept. For a reboot use restartServer. While autoStartEnabled is on, a joining player wakes it (turn off with updateServer). Returns the server.
| Argument | Type | Description |
|---|---|---|
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Changes a server's name, size, settings, player lists, content, auto-start or custom domain. Omitted fields are kept, and a sent list replaces the stored one (uploaded files excepted). Not for the resource pack (setResourcePack) or a fresh world (resetServer). The returned server says when a restart is required (restartToApplySettings); a larger size costs more per running hour.
| Argument | Type | Description |
|---|---|---|
| body* | object | |
| path* | object |
{
"type": "object",
"required": [
"path",
"body"
],
"properties": {
"body": {
"type": "object",
"required": [],
"properties": {
"name": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Display name; also used in the join address."
},
"size": {
"enum": [
"c.medium",
"m.medium",
"r.medium",
"c.large",
"m.large",
"r.large",
"c.xlarge",
"m.xlarge",
"r.xlarge",
"m.2xlarge",
"r.2xlarge",
"r.4xlarge",
null
],
"type": [
"string",
"null"
],
"description": "New size class (prices in getPricingCatalog; larger sizes cost more per running hour). Applies at the next start or restartServer."
},
"config": {
"type": "object",
"required": [],
"properties": {
"ops": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"required": [
"bypassesPlayerLimit",
"level",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 16,
"minLength": 1
},
"uuid": {
"type": "string",
"minLength": 1,
"description": "Optional; filled from the name."
},
"level": {
"type": "integer",
"maximum": 4,
"minimum": 1,
"description": "Operator level 1 to 4; 4 runs every command."
},
"bypassesPlayerLimit": {
"type": "boolean"
}
}
},
"description": "Players with operator rights, who can run admin commands in game."
},
"pvp": {
"type": [
"boolean",
"null"
],
"description": "Players can hurt each other; default on."
},
"icon": {
"type": [
"string",
"null"
],
"maxLength": 32768,
"description": "Server list icon as a base64 data URI of a 64x64 PNG."
},
"motd": {
"type": [
"string",
"null"
],
"maxLength": 2048,
"description": "Message shown under the server name in the multiplayer list."
},
"type": {
"enum": [
"VANILLA",
"FABRIC",
"FORGE",
"NEOFORGE",
"PAPER",
"PUFFERFISH",
"PURPUR",
"LEAF",
"FOLIA",
"QUILT",
null
],
"type": [
"string",
"null"
],
"description": "Server software: VANILLA, a mod loader (FABRIC, FORGE, NEOFORGE, QUILT) or a plugin server (PAPER and its forks). It decides which mods or plugins can be installed."
},
"modpack": {
"type": [
"object",
"null"
],
"required": [
"coord"
],
"properties": {
"name": {
"type": "string"
},
"side": {
"enum": [
"client",
"server",
"both"
],
"type": "string"
},
"bytes": {
"type": "integer",
"minimum": 1,
"description": "Filled in by Pixly; omit."
},
"coord": {
"type": "string",
"maxLength": 1024,
"minLength": 1,
"description": "Modrinth or CurseForge project id of the modpack."
},
"iconId": {
"type": "string",
"maxLength": 32
},
"loader": {
"enum": [
"VANILLA",
"FABRIC",
"FORGE",
"NEOFORGE",
"PAPER",
"PUFFERFISH",
"PURPUR",
"LEAF",
"FOLIA",
"QUILT"
],
"type": "string",
"description": "Filled in by Pixly; omit."
},
"source": {
"enum": [
"modrinth",
"curseforge",
"upload"
],
"type": "string"
},
"version": {
"type": "string",
"maxLength": 48
},
"crc64nvme": {
"type": "string",
"pattern": "^[A-Za-z0-9+/]{11}=$",
"description": "Filled in by Pixly; omit."
},
"fileCount": {
"type": "integer",
"maximum": 10000,
"minimum": 0
},
"minecraft": {
"type": "string",
"description": "Filled in by Pixly; omit."
},
"description": {
"type": "string"
},
"downloadBytes": {
"type": "integer",
"maximum": 1099511627776,
"minimum": 0
},
"loaderVersion": {
"type": "string",
"maxLength": 48
}
},
"description": "A Modrinth or CurseForge modpack to run, downloaded from that site when the server starts. An uploaded .mrpack is set through the modpack upload operations instead."
},
"version": {
"type": [
"string",
"null"
],
"maxLength": 20,
"description": "Minecraft version such as 1.21.4; leave unset for the latest release. For a type other than VANILLA it must be listed for that type in getLoaderVersions."
},
"gamemode": {
"enum": [
"survival",
"creative",
"adventure",
"spectator",
null
],
"type": [
"string",
"null"
],
"description": "Mode new players start in."
},
"hardcore": {
"type": [
"boolean",
"null"
],
"description": "One life; dead players become spectators. Default off."
},
"projects": {
"type": [
"array",
"null"
],
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 1024,
"minLength": 1
},
{
"type": "object",
"required": [
"coord"
],
"properties": {
"kind": {
"enum": [
"mod",
"modpack",
"plugin",
"datapack",
"resourcepack"
],
"type": "string"
},
"bytes": {
"type": "integer",
"minimum": 1
},
"coord": {
"type": "string",
"maxLength": 1024,
"minLength": 1
},
"source": {
"enum": [
"modrinth",
"curseforge",
"url",
"upload"
],
"type": "string"
},
"metadata": {
"type": "object",
"required": [],
"properties": {
"id": {
"type": "string",
"maxLength": 96
},
"name": {
"type": "string",
"maxLength": 96
},
"side": {
"enum": [
"client",
"server",
"both"
],
"type": "string"
},
"author": {
"type": "string"
},
"iconId": {
"type": "string",
"maxLength": 32
},
"loader": {
"enum": [
"fabric",
"quilt",
"forge",
"neoforge",
"bukkit",
"paper"
],
"type": "string"
},
"version": {
"type": "string",
"maxLength": 48
},
"minecraft": {
"type": "string",
"maxLength": 48
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"required": [
"text"
],
"properties": {
"bold": {
"type": "boolean"
},
"text": {
"type": "string"
},
"color": {
"type": "string"
},
"extra": {
"type": "array",
"items": {
"type": "object",
"required": [
"text"
],
"properties": {
"bold": {
"type": "boolean"
},
"text": {
"type": "string"
},
"color": {
"type": "string"
},
"italic": {
"type": "boolean"
},
"obfuscated": {
"type": "boolean"
},
"underlined": {
"type": "boolean"
},
"strikethrough": {
"type": "boolean"
}
}
}
},
"italic": {
"type": "boolean"
},
"obfuscated": {
"type": "boolean"
},
"underlined": {
"type": "boolean"
},
"strikethrough": {
"type": "boolean"
}
}
}
]
}
}
},
"settings": {
"type": "object",
"required": [],
"properties": {},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 256
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"crc64nvme": {
"type": "string",
"pattern": "^[A-Za-z0-9+/]{11}=$"
}
}
}
]
},
"maxItems": 768,
"description": "Mods, plugins and datapacks to install from Modrinth, CurseForge or a direct download link, which the server downloads when it starts. A string is a Modrinth project id; an object names its source (modrinth, curseforge or url) and coord (the project id or the link). A Modrinth datapack uses the coord datapack:<project id> with kind datapack. Uploaded files are managed through the asset upload operations and kept as they are."
},
"bannedIps": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"required": [
"ip",
"reason"
],
"properties": {
"ip": {
"type": "string",
"minLength": 1
},
"reason": {
"type": "string",
"description": "Shown to the player."
},
"source": {
"type": "string",
"description": "Who issued it; Server when omitted."
},
"created": {
"type": "string",
"description": "ISO 8601 time; now when omitted."
},
"expires": {
"type": "string",
"description": "ISO 8601 time or forever; forever when omitted."
}
}
},
"description": "IP addresses that are banned from joining."
},
"levelSeed": {
"type": [
"string",
"null"
],
"pattern": "^[^\\x00-\\x1F\\x7F-\\x9F]*$",
"maxLength": 64,
"description": "Applies only to a world not yet generated; use resetServer to regenerate."
},
"levelType": {
"enum": [
"flat",
"largebiomes",
"amplified",
null
],
"type": [
"string",
"null"
],
"description": "Generator for a new world: flat, largebiomes, amplified; unset is normal."
},
"whitelist": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 16,
"minLength": 1
},
"uuid": {
"type": "string",
"minLength": 1,
"description": "Optional; filled from the name."
}
}
},
"description": "Players allowed to join while whitelistEnabled is on."
},
"difficulty": {
"enum": [
"peaceful",
"easy",
"normal",
"hard",
null
],
"type": [
"string",
"null"
],
"description": "Game difficulty."
},
"maxPlayers": {
"type": [
"integer",
"null"
],
"maximum": 1000,
"minimum": 0,
"description": "Most players online at once; default 20."
},
"onlineMode": {
"type": "boolean",
"description": "Only players signed in with an official Minecraft account can join. On by default."
},
"allowFlight": {
"type": [
"boolean",
"null"
],
"description": "Let players fly in survival without being kicked; default off."
},
"serverImage": {
"enum": [
"java25",
"java21",
"java17",
"java8"
],
"type": [
"string",
"null"
],
"description": "Java runtime. Leave unset: it is chosen from the version and content. Set only when the user asks for a Java version; java8 runs Minecraft older than 1.17."
},
"viewDistance": {
"type": [
"integer",
"null"
],
"maximum": 32,
"minimum": 3,
"description": "How far players can see, in chunks."
},
"bannedPlayers": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"required": [
"name",
"reason",
"uuid"
],
"properties": {
"name": {
"type": "string",
"maxLength": 16,
"minLength": 1
},
"uuid": {
"type": "string",
"minLength": 1
},
"reason": {
"type": "string",
"description": "Shown to the player."
},
"source": {
"type": "string",
"description": "Who issued it; Server when omitted."
},
"created": {
"type": "string",
"description": "ISO 8601 time; now when omitted."
},
"expires": {
"type": "string",
"description": "ISO 8601 time or forever; forever when omitted."
}
}
},
"description": "Players who are banned from joining."
},
"forceGamemode": {
"type": [
"boolean",
"null"
],
"description": "Put players in gamemode every time they join; default off."
},
"spawnMonsters": {
"type": [
"boolean",
"null"
],
"description": "Hostile mobs spawn; default on."
},
"bedrockEnabled": {
"type": [
"boolean",
"null"
],
"description": "Also let Bedrock Edition players on phones, consoles and Windows join. Works only on a type and version inside getBedrockRange."
},
"spawnProtection": {
"type": [
"integer",
"null"
],
"maximum": 256,
"minimum": 0,
"description": "Radius in blocks around spawn where only operators can build."
},
"voiceChatEnabled": {
"type": [
"boolean",
"null"
],
"description": "Turn on proximity voice chat; players need the matching voice chat mod."
},
"whitelistEnabled": {
"type": [
"boolean",
"null"
],
"description": "Only players on the whitelist or operators can join. On when unset."
},
"playerIdleTimeout": {
"type": [
"integer",
"null"
],
"maximum": 1440,
"minimum": 0,
"description": "Minutes before an idle player is disconnected; 0 never disconnects."
},
"voiceChatProvider": {
"enum": [
"simple-voice-chat",
"plasmo-voice",
null
],
"type": [
"string",
"null"
],
"description": "Which voice chat mod is used when voice chat is on; players need the same mod."
},
"enableCommandBlock": {
"type": [
"boolean",
"null"
],
"description": "Command blocks run; the default depends on the Minecraft version."
},
"simulationDistance": {
"type": [
"integer",
"null"
],
"maximum": 32,
"minimum": 3,
"description": "How far from players the world keeps running, in chunks."
},
"resourcePackRequired": {
"type": [
"boolean",
"null"
],
"description": "Disconnect players who decline the server's resource pack."
}
}
},
"resetWorld": {
"type": "boolean",
"description": "Set true only after the user agrees to wipe the world, for a Minecraft version downgrade or a server type change that needs a new world. A backup is taken first. Never set it on your own."
},
"customDomain": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"host": {
"type": "string",
"maxLength": 253,
"minLength": 1,
"description": "Domain the owner controls, such as play.example.com, pointed at the server with a CNAME record."
},
"enabled": {
"type": "boolean",
"description": "false stops routing the domain to this server."
}
},
"description": "A domain the user owns, used to join instead of the Pixly address. After setting it, point its DNS and call verifyCustomDomain."
},
"autoStartEnabled": {
"type": "boolean",
"description": "Whether a player joining an asleep server starts it. On by default."
}
}
},
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Looks up the public DNS record of the custom domain set with updateServer customDomain and updates its status; use it after the user changes DNS. A record that points at the server verifies the domain and starts routing players to it. A failing record is reported with its reason and never takes a verified domain off the server; one whose record stays wrong is revoked later by Pixly's hourly check. Returns check.verified, with a reason on failure, and the server.
| Argument | Type | Description |
|---|---|---|
| path* | object |
{
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "object",
"required": [
"serverId"
],
"properties": {
"serverId": {
"type": "string",
"minLength": 1,
"description": "Server id: the id field from listServers."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}We read every tool's name, description and inputs the way the model will, looking for instructions hidden from you. A clean result means no warning signs, not a guarantee. Scanned Oct 30, 2026.