Distribution

Bind a server

What the Distribution tab's Bind a server does: a code for somebody to type on a Minecraft server running RP Engine. Hand command (/rp distribute <code>) to whoever runs the server, then follow GET /packs/{pack}/distribution/servers until its status is bound. The code is for one server and expires if nobody types it; unbind a code you no longer want.

A pack can be bound to 10 servers, codes still waiting included. Needs the distribute permission on the pack. Free.

POST/packs/{pack}/distribution/servers

Path parameters

packstringrequired

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

Response · 201

A claim code, waiting.

packstringrequired

The pack.

serverobjectrequired

The server, waiting.

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_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.

server_limit_reached409

The pack is bound to as many servers as it may, claim codes still waiting included. Unbind one first.