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.
View input schema
{
"type": "object",
"properties": {
"body": {
"properties": {
"config": {
"properties": {
"allowFlight": {
"description": "Let players fly in survival without being kicked; default off.",
"type": "boolean"
},
"bedrockEnabled": {
"description": "Also let Bedrock Edition players on phones, consoles and Windows join. Works only on a type and version inside getBedrockRange.",
"type": "boolean"
},
"difficulty": {
"description": "Game difficulty.",
"enum": [
"peaceful",
"easy",
"normal",
"hard"
],
"type": "string"
},
"enableCommandBlock": {
"description": "Command blocks run; the default depends on the Minecraft version.",
"type": "boolean"
},
"entityBroadcastRangePercentage": {
"description": "How far away players see mobs, items and other players, as a percentage of the normal range; default 100.",
"maximum": 1000,
"minimum": 10,
"type": "integer"
},
"forceGamemode": {
"description": "Put players in gamemode every time they join; default off.",
"type": "boolean"
},
"gamemode": {
"description": "Mode new players start in.",
"enum": [
"survival",
"creative",
"adventure",
"spectator"
],
"type": "string"
},
"hardcore": {
"description": "One life; dead players become spectators. Default off.",
"type": "boolean"
},
"icon": {
"description": "Server list icon as a base64 data URI of a 64x64 PNG.",
"maxLength": 32768,
"type": "string"
},
"levelSeed": {
"description": "Applies only to a world not yet generated; use resetServer to regenerate.",
"maxLength": 64,
"pattern": "^[^\\x00-\\x1F\\x7F-\\x9F]*$",
"type": "string"
},
"levelType": {
"description": "Generator for a new world: flat, largebiomes, amplified; unset is normal.",
"enum": [
"flat",
"largebiomes",
"amplified"
],
"type": "string"
},
"maxPlayers": {
"description": "Most players online at once; default 20.",
"maximum": 1000,
"minimum": 0,
"type": "integer"
},
"modpack": {
"description": "A Modrinth or CurseForge modpack to run, downloaded from that site when the server starts. An uploaded .mrpack or CurseForge .zip is set through the modpack upload operations instead.",
"properties": {
"bytes": {
"description": "Filled in by Pixly; omit.",
"minimum": 1,
"type": "integer"
},
"coord": {
"description": "Modrinth or CurseForge project id of the modpack.",
"maxLength": 1024,
"minLength": 1,
"type": "string"
},
"crc64nvme": {
"description": "Filled in by Pixly; omit.",
"pattern": "^[A-Za-z0-9+/]{11}=$",
"type": "string"
},
"curseforgeProjectId": {
"maxLength": 20,
"pattern": "^\\d+$",
"type": "string"
},
"description": {
"type": "string"
},
"downloadBytes": {
"maximum": 1099511627776,
"minimum": 0,
"type": "integer"
},
"fileCount": {
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"iconId": {
"maxLength": 32,
"type": "string"
},
"loader": {
"description": "Filled in by Pixly; omit.",
"enum": [
"VANILLA",
"FABRIC",
"FORGE",
"NEOFORGE",
"PAPER",
"PUFFERFISH",
"PURPUR",
"LEAF",
"FOLIA",
"QUILT"
],
"type": "string"
},
"loaderVersion": {
"maxLength": 48,
"type": "string"
},
"members": {
"additionalProperties": {
"description": "include: install the member even when the server would skip it as client-only; exclude: never install it",
"enum": [
"include",
"exclude"
],
"type": "string"
},
"description": "Per-member install choices, keyed by member. A member not listed installs as the pack decides. Change it through modpackMemberChanges.",
"properties": {},
"required": [],
"type": "object"
},
"minecraft": {
"description": "Filled in by Pixly; omit.",
"type": "string"
},
"name": {
"type": "string"
},
"side": {
"enum": [
"client",
"server",
"both"
],
"type": "string"
},
"source": {
"enum": [
"modrinth",
"curseforge",
"upload"
],
"type": "string"
},
"version": {
"maxLength": 48,
"type": "string"
}
},
"required": [
"coord"
],
"type": "object"
},
"motd": {
"description": "Message shown under the server name in the multiplayer list.",
"maxLength": 2048,
"type": "string"
},
"onlineMode": {
"description": "Only players signed in with an official Minecraft account can join. On by default.",
"type": "boolean"
},
"ops": {
"description": "Players with operator rights, who can run admin commands in game.",
"items": {
"properties": {
"bypassesPlayerLimit": {
"type": "boolean"
},
"level": {
"description": "Operator level 1 to 4; 4 runs every command.",
"maximum": 4,
"minimum": 1,
"type": "integer"
},
"name": {
"maxLength": 16,
"minLength": 1,
"type": "string"
},
"uuid": {
"description": "Optional; filled from the name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"bypassesPlayerLimit",
"level",
"name"
],
"type": "object"
},
"type": "array"
},
"playerIdleTimeout": {
"description": "Minutes before an idle player is disconnected; 0 never disconnects.",
"maximum": 1440,
"minimum": 0,
"type": "integer"
},
"projects": {
"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 added through the asset upload operations; an existing server's list is changed through projectChanges.",
"items": {
"anyOf": [
{
"maxLength": 1024,
"minLength": 1,
"type": "string"
},
{
"properties": {
"bytes": {
"minimum": 1,
"type": "integer"
},
"coord": {
"maxLength": 1024,
"minLength": 1,
"type": "string"
},
"crc64nvme": {
"pattern": "^[A-Za-z0-9+/]{11}=$",
"type": "string"
},
"disabled": {
"description": "Kept in the list but not installed, as if removed, until enabled again.",
"type": "boolean"
},
"kind": {
"enum": [
"mod",
"modpack",
"plugin",
"datapack",
"resourcepack"
],
"type": "string"
},
"metadata": {
"properties": {
"author": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"bold": {
"type": "boolean"
},
"color": {
"type": "string"
},
"extra": {
"items": {
"properties": {
"bold": {
"type": "boolean"
},
"color": {
"type": "string"
},
"italic": {
"type": "boolean"
},
"obfuscated": {
"type": "boolean"
},
"strikethrough": {
"type": "boolean"
},
"text": {
"type": "string"
},
"underlined": {
"type": "boolean"
}
},
"required": [
"text"
],
"type": "object"
},
"type": "array"
},
"italic": {
"type": "boolean"
},
"obfuscated": {
"type": "boolean"
},
"strikethrough": {
"type": "boolean"
},
"text": {
"type": "string"
},
"underlined": {
"type": "boolean"
}
},
"required": [
"text"
],
"type": "object"
}
]
},
"iconId": {
"maxLength": 32,
"type": "string"
},
"id": {
"maxLength": 96,
"type": "string"
},
"loader": {
"enum": [
"fabric",
"quilt",
"forge",
"neoforge",
"bukkit",
"paper"
],
"type": "string"
},
"minecraft": {
"maxLength": 48,
"type": "string"
},
"name": {
"maxLength": 96,
"type": "string"
},
"side": {
"enum": [
"client",
"server",
"both"
],
"type": "string"
},
"version": {
"maxLength": 48,
"type": "string"
}
},
"required": [],
"type": "object"
},
"settings": {
"additionalProperties": {
"anyOf": [
{
"maxLength": 256,
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"properties": {},
"required": [],
"type": "object"
},
"source": {
"enum": [
"modrinth",
"curseforge",
"url",
"upload"
],
"type": "string"
}
},
"required": [
"coord"
],
"type": "object"
}
]
},
"maxItems": 768,
"type": "array"
},
"pvp": {
"description": "Players can hurt each other; default on.",
"type": "boolean"
},
"resourcePackRequired": {
"description": "Disconnect players who decline the server's resource pack.",
"type": "boolean"
},
"serverImage": {
"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.",
"enum": [
"java25",
"java21",
"java17",
"java8"
],
"type": "string"
},
"simulationDistance": {
"description": "How far from players the world keeps running, in chunks.",
"maximum": 32,
"minimum": 3,
"type": "integer"
},
"spawnMonsters": {
"description": "Hostile mobs spawn; default on.",
"type": "boolean"
},
"spawnProtection": {
"description": "Radius in blocks around spawn where only operators can build.",
"maximum": 256,
"minimum": 0,
"type": "integer"
},
"type": {
"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.",
"enum": [
"VANILLA",
"FABRIC",
"FORGE",
"NEOFORGE",
"PAPER",
"PUFFERFISH",
"PURPUR",
"LEAF",
"FOLIA",
"QUILT"
],
"type": "string"
},
"version": {
"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.",
"maxLength": 20,
"type": "string"
},
"viewDistance": {
"description": "How far players can see, in chunks.",
"maximum": 32,
"minimum": 3,
"type": "integer"
},
"voiceChatEnabled": {
"description": "Turn on proximity voice chat; players need the matching voice chat mod.",
"type": "boolean"
},
"voiceChatProvider": {
"description": "Which voice chat mod is used when voice chat is on; players need the same mod.",
"enum": [
"simple-voice-chat",
"plasmo-voice"
],
"type": "string"
},
"whitelist": {
"description": "Players allowed to join while whitelistEnabled is on.",
"items": {
"properties": {
"name": {
"maxLength": 16,
"minLength": 1,
"type": "string"
},
"uuid": {
"description": "Optional; filled from the name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"whitelistEnabled": {
"description": "Only players on the whitelist or operators can join. On when unset.",
"type": "boolean"
}
},
"required": [],
"type": "object"
},
"name": {
"description": "Name shown to the owner and used in the join address.",
"maxLength": 64,
"minLength": 1,
"type": "string"
},
"region": {
"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.",
"minLength": 1,
"type": "string"
},
"size": {
"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.",
"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"
}
},
"required": [
"name",
"region",
"size"
],
"type": "object"
}
},
"required": [
"body"
],
"additionalProperties": false
}