Organization API: Customer Portal: Software

Part of Customer Portal.

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/addons

Every addon in the folders the server loads from, tracked or hand-uploaded.

DELETE /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/addons/records/{record_uuid}

Drop a tracking record whose files are gone, without touching the disk.

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/addons/remove

Delete one addon from disk, through the tracked uninstall when it has a record.

application/json (required)

Type: Body.

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/addons/toggle

Switch one addon file on or off (Foo.jar <-> Foo.jar.disabled).

application/json (required)

Type: Body.

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/bedrock

Turn Bedrock crossplay on or off for one of the customer's Java servers.

The same switch as the platform's POST /api/v1/client/servers/{uuid}/software/bedrock. Crossplay lets players on Minecraft Bedrock join the Java server, through Geyser and Floodgate. {"enabled": true} installs both plugins before this answers, gives Geyser a port of its own, and the server loads the plugins at its next start. {"enabled": false} deletes both plugins and their folders and returns Geyser's port to the pool. A body without enabled turns crossplay off. The answer is the crossplay state.

It answers 400 with the reason, and nothing changes, when the server cannot run Geyser (it runs mods, Vanilla, a proxy or a Bedrock server, or a Java older than 21), when GeyserMC's downloads do not answer, or when a plugin cannot be installed. An enabled that is not true or false answers 422. Needs software.install. Each request is recorded in the server's activity log.

application/json (required)

PUT /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/bedrock/channel

Choose where Bedrock crossplay takes Geyser from: release or development.

The same switch as the platform's PUT /api/v1/client/servers/{uuid}/software/bedrock/channel, for one of the customer's servers. development is the newest build of GeyserMC's GitHub build workflow, for a Minecraft version no Geyser release supports yet. With crossplay on, the chosen Geyser is installed before this answers and each start updates it from the same place. Needs software.install.

application/json (required)

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/bedrock/packs

Behavior and resource packs on disk, which are active in the world, and importable uploads.

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/bedrock/packs/disable-all

Empty the world's activation lists so it boots on vanilla content; folders stay.

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/bedrock/packs/import

Queue an import of an uploaded .mcaddon / .mcpack / .zip already on the server.

application/json (required)

Type: Body.

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/bedrock/packs/{pack_uuid}/active

Add a pack to, or drop it from, the world's activation list.

application/json (required)

Type: Body.

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/bedrock/packs/{pack_uuid}/remove

Deactivate a pack, delete its folder, and drop its tracking row.

PUT /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/bedrock/texturepack-required

texturepack-required: players must accept the resource packs to join.

application/json (required)

Type: Body.

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/catalog

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/catalog/{key}/versions

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/catalog/{key}/versions/{version}/builds

Publisher builds of one game version: the loader versions for Fabric/Forge.

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/change

application/json (required)

Type: Body.

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/context

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/dependencies/{source_uuid}/{identifier}

What a version requires, named, with what is already installed marked.

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/game-settings

The server's game settings in server.properties words, whatever file holds them.

format is server.properties (every key the file has, in values) or pumpkin.toml (Pumpkin: the keys settings lists, each with its kind and limits, plus bedrock-players). exists is false before the game first wrote its file. Changes apply on the next start. Needs file.read-content.

PATCH /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/game-settings

Change game settings: {"values": {"difficulty": "hard", "max-players": 20}}.

Keys are server.properties words; null puts a key back to its default. On a Pumpkin server only the keys GET lists are taken, each checked the way Pumpkin reads it, and an unknown key or a value out of range answers 400 naming what it takes. At most 40 keys at once. Needs file.update. Recorded in the server's activity log.

application/json (required)

Type: Body.

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/install

application/json (required)

Type: SoftwareInstallBody or object.

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/installs

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/installs/{install_uuid}

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/installs/{install_uuid}/cancel

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/installs/{install_uuid}/retry

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/jvm

The heap slider and the allowlisted startup flags, as the panel shows them.

PATCH /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/jvm

Move the heap, pick startup flags from the catalog, or reset both. Applies on restart.

application/json (required)

Type: Body.

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/resource-pack

The server resource pack as server.properties declares it.

PUT /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/resource-pack

Point players at a pack, from a URL or a marketplace resource pack version.

application/json (required)

Type: Body.

DELETE /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/resource-pack

Stop offering a server resource pack.

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/safe-mode

Arm a one-shot --safeMode start (vanilla datapack only), optionally starting now.

application/json (required)

Type: Body.

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/search

application/json (required)

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/sources

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/updates

Newer compatible builds for the addons the marketplace installed.

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/versions/{source_uuid}/{identifier}

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/via

Turn ViaVersion and ViaBackwards on or off for one of the customer's Java servers.

The same switch as the platform's POST /api/v1/client/servers/{uuid}/software/via. Every plugin server has both plugins unless the customer turns them off: ViaVersion lets players on newer Minecraft versions join, and ViaBackwards lets players on older versions join. true installs the newest releases before it answers and the server loads them at its next start; false removes the two jars and keeps them off. The answer is the state software/context shows under via_plugins, and a refusal answers 400 with the reason. Needs software.install.

application/json (required)

DELETE /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/{record_uuid}

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/software/{record_uuid}/update

Queue an in-place update: the old file is removed, the new build installed.

application/json

Type: object or null.