Packs

Send a Custom GUI to a server

The editor's Send to server: the Custom GUI as saved, frozen under a code. On a server running MC GUI, /mcgui import <code> writes its pages into the plugin's pages folder; importing a later code of the same GUI tidies the files the earlier one wrote. Free.

POST/packs/{pack}/custom-guis/{gui}/share

Path parameters

packstringrequired

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

guistringrequired

The Custom GUI's id from the list.

Response · 200

The code.

packstringrequired

The pack.

codestringrequired

The import code.

commandstringrequired

What to type on the server.

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.