Packs

Link a player to receive pushes

The Studio's Sync menu: who push_pack and give_asset reach for you in this pack, and when nobody is linked yet, the code that links somebody. Type command (/rp sync <code>) on a server running RP Engine, then push. A player linked to the test server with /permlink and online there is reached without one. The code is yours for this pack; a collaborator has their own.

GET/packs/{pack}/link

Path parameters

packstringrequired

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

Response · 200

The link.

packstringrequired

The pack.

statusstringrequired

linked when a push would reach somebody, waiting while the code is unclaimed.

Options: linked, waiting

viastringrequired

How they are linked: code, or permalink for the test server.

playerstringrequired

Who a push reaches.

codestringrequired

The code.

commandstringrequired

What to type in game to claim it.

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.