Distribution

Rename a bound server

Changes the name the Studio shows a bound server by. Needs the distribute permission on the pack. Free.

POST/packs/{pack}/distribution/servers/{server}/rename

Path parameters

packstringrequired

The pack's slug, as returned by the packs endpoints.

serverstringrequired

The server's id, from GET /packs/{pack}/distribution/servers.

Body

namestringrequiredmax 60 characters

The new name.

Response · 200

Renamed.

packstringrequired

The pack.

serverobjectrequired

The server as it is now.

idstringrequired

The server's id, for renaming or unbinding it.

namestringrequired

What the Studio calls it.

statusstringrequired

waiting until somebody types the code on the server, bound after.

Options: waiting, bound

claimCodestringrequired

The code to type, while waiting. Null once bound.

commandstringrequired

The whole command to type in the server's console or chat, while waiting. Null once bound.

claimedAtstringrequired

ISO 8601, when it was bound.

pluginVersionstringrequired

The RP Engine version it runs, from its last check-in.

serverVersionstringrequired

Its Minecraft version, from its last check-in.

viaVersionbooleanrequired

Whether it runs ViaVersion, so players on other versions can join.

geyserbooleanrequired

Whether it runs Geyser, so Bedrock players can join.

lastSeenAtstringrequired

ISO 8601, its last check-in: the plugin is alive.

lastServeAtstringrequired

ISO 8601, the last time it handed the pack to somebody.

createdAtstringrequired

ISO 8601.

Error codes

Branch on error.code, never on the message.

invalid_request400

Something in the body or query is wrong. message says what.

invalid_api_key401

The key isn't one of ours, or it has been revoked.

missing_api_key401

No Authorization: Bearer header was sent.

wrong_key_kind401

An MCP key sent to the REST API, or an API key sent to the MCP server. Each only opens its own.

account_suspended403

The account is suspended, so its keys open nothing. message says until when, if the suspension has an end date.

forbidden403

Valid key, but not permitted to do this in this pack.

plan_required403

The key is valid, but its account's plan does not include the API.

not_found404

No such pack, asset or job.