Quickstart

Pairing replaces copying a token by hand. The dashboard hands you a short code, you type it into your server console once, and the connector receives its own credential and writes it to disk.

#Step 1: generate a pairing code

In the dashboard open Settings, then Connectors, and generate a code. A code is eight characters, single use, and expires ten minutes after you make it. A network holds at most one live code at a time.

Only an owner or an admin of a network can generate one.

K3M9-QT4B

#Step 2: install the connector

The dashboard setup panel serves the loader jar from this domain. Press Download for Velocity or Download for Paper and the current release is streamed straight back, with its SHA256 in the X-Checksum-Sha256 header. The loader is open source, and the Source link at the bottom of the setup panel opens the repository.

Put the Velocity jar in your proxy plugins folder, or the Paper jar in your server plugins folder, then start the server once so the config file is written.

Leave the api_token and api-token placeholders alone. They are the older manual path, and a real token in the file takes precedence over a paired credential at every start.

/download/loader/velocity
/download/loader/paper

#Step 3: pair from the console

Type the command into the server console. On Velocity the command is prefixed, on Paper it is not, and both need the mcanalytics.admin permission if you run it as a player.

# Velocity proxy console
/mca pair K3M9-QT4B

# Paper server console
mca pair K3M9-QT4B

#Step 4: verify

Run the status command. It reports whether the connector holds a credential, which endpoint it talks to, and the state of the spool.

Heartbeats are sent every ten seconds by default, so the Health page shows the server shortly after it starts.

/mca status