Server API

Server API

Read and run a server you admin from your own bot or site: the live server, players, staff, sessions, cases, bans, shifts, departments and logs. With a v2 key you can also make changes and get webhooks.

#Getting access

  1. Apply for the Server API program. On the portal, open Apply and pick Server API. An Uplink owner approves every Server API developer.
  2. Make a key. On the Server API page, give the key a name, pick a server where you are an admin in Uplink, and pick v1 or v2.
  3. Copy it. The key starts with usk_ and is shown once. Uplink only keeps a hash of it.
  4. Call the API. Send the key in the Authorization header on every request.

#Versions

v1: readLive server, players, staff, sessions, cases, bans, shifts, departments and logs. A v1 key can only read. v2: read and writeEverything in v1, plus sessions, cases, bans, shifts and webhooks. A v2 key also works on every v1 address.
VersionBase address
v1https://uplinkrblx.xyz/api/server/v1
v2https://uplinkrblx.xyz/api/server/v2

#Your first call

Terminal
curl https://uplinkrblx.xyz/api/server/v1/server \
  -H "Authorization: Bearer usk_your_key"
Node.js
const res = await fetch("https://uplinkrblx.xyz/api/server/v1/players", {
  headers: { authorization: `Bearer ${process.env.UPLINK_KEY}` },
});
const { players } = await res.json();
console.log(players.map((p) => p.name));

#Keys

  • One key reaches one server. You can have up to 10 keys at once.
  • A key stops working if you stop being an admin of that server in Uplink, or lose Server API access.
  • The server's admins and Uplink owners can see your keys and revoke them. You can revoke your own on the Server API page.
  • Keep keys on a server or bot. Calls from web pages are refused.

#Try it without a real server

The Server API Lab runs your code against a test server with a full dashboard, so you can see every change before you use a real key.