Skip to content

Instantly share code, notes, and snippets.

@draem

draem/internal-api.md

Created April 6, 2020 03:05
Show Gist options
  • Save draem/e920294eeec3cd4f12918b235d11c70a to your computer and use it in GitHub Desktop.
Save draem/e920294eeec3cd4f12918b235d11c70a to your computer and use it in GitHub Desktop.
Download ZIP
Raw
internal-api.md

Generic Requests

Get

Header Value
x-access-token secret auth
accept application/json
Content-Type application/json

Post

Header Value
x-access-token secret auth
accept application/json
Content-Type application/json

Endpoints

POST /players/login

Request

Key Type
name String
uuid String
ip String
includeServerProfile Boolean

Response

Key Type
profile PlayerProfile
denyJoin Boolean
denyJoinMessage String
punishment Punishment
firstJoin Boolean
firstJoinNumber Integer

GET /players/find/name/

Response

Key Type
player OnlinePlayer
notFound Boolean
findingDisabled Boolean
lastOnServer String
name String
lastOnlineDate Date

GET /servers

Response

Key Type
servers ServerSession[]

POST /lobbies/heartbeat

Request

Key Type
id String
name String
type String
playerCount Integer
maxPlayers Integer
ip String
port Integer

POST /custom_servers/heartbeat

Request

Key Type
id String
name String
icon String
type String
playerCount Integer
maxPlayers Integer
ip String
port Integer
motd String

POST /players/join_player_server

Request

Key Type
player SimplePlayer
serverName String

Response

Key Type
sent Boolean
starting Boolean
error Boolean
message LocalizedMessage

GET /lobbies

Response

Key Type
servers Lobby[]

POST /players/send_to_lobby

Request

Key Type
name String
uuid UUID

Response

Key Type
error Boolean
message LocalizedMessage

GET /servers/id

Response

Key Type
server ServerProfile

GET /servers/name

Response

Key Type
server ServerProfile

POST /players/heartbeat_group

Request

Key Type
players PlayerHeartbeat[]
serverId String
serverType String

POST /players/send_message

Request

Key Type
from String
to String
message String

Response

Key Type
success Boolean
message LocalizedMessage

POST /players/send_reply

Request

Key Type
from String
message String

Response

Key Type
success Boolean
message LocalizedMessage

POST /players/issue_punishment

Request

Key Type
punisherName String
punishedName String
reason String
issued Long
expires Long
type String

Response

Key Type
punishment Punishment

POST /players/set_rank

Request

Key Type
playerName String
rank String

Response

Key Type
error Boolean
message LocalizedMessage

POST /servers/handle_rank_purchase

Request

Key Type
playerName String
rank String

Response

Key Type
error Boolean
message LocalizedMessage

POST /players/unmute

Request

Key Type
playerName String
staffName String

Response

Key Type
error Boolean
message LocalizedMessage

POST /players/unban

Request

Key Type
playerName String
staffName String

Response

Key Type
error Boolean
message LocalizedMessage

GET /network/stats

Response

Key Type
motd String
playerCount Integer
lobbyCount Integer
serverCount Integer

POST /servers/shutdown

Request

Key Type
serverName String

Response

Key Type
error Boolean
message LocalizedMessage

[POST]](#post) /players/direct_join_server

Request

Key Type
playerName String
serverName String

Response

Key Type
error Boolean
message LocalizedMessage

GET /lobbies/image

Response

Key Type
url String

GET /players/playerName/punishments

Response

Key Type
punishments Punishment[]
error Boolean
message LocalizedMessage

POST /players/ignore

Request

Key Type
senderUuid String
playerName String

Response

Key Type
error Boolean
message LocalizedMessage
ignored Boolean

POST /players/set_setting

Request

Key Type
uuid UUID
settingName String
newValue String

Response

Key Type
error Boolean
message LocalizedMessage

GET /players/friends/playerUuid

Response

Key Type
friends SemiSimplePlayer[]

GET /players/friend_requests/playerUuid

Response

Key Type
error Boolean
message LocalizedMessage
requests FriendRequestModel[]

POST /players/add_friend

Request

Key Type
senderUuid UUID
friendName String

Response

Key Type
error Boolean
message LocalizedMessage
request Boolean
name String

POST /players/remove_friend

Request

Key Type
senderUuid UUID
friendName String

Response

Key Type
error Boolean
message LocalizedMessage
name String

GET /players/find/name/requester?friendTeleport=true

Response

Key Type
error Boolean
message LocalizedMessage
player OnlinePlayer

GET /player/username

Response

Key Type
profile PlayerProfile
notFound Boolean

GET /player/uuid/?uuid=true

Response

Key Type
profile PlayerProfile
notFound Boolean

POST /players/proxy_login

Request

Key Type
domain String

Response

Key Type
redirect String

POST /players/proxy_motd

Request

Key Type
domain String

Response

Key Type
motd String
players Integer
maxPlayers Integer

GET /network/featured_servers

Response

Key Type
servers FeaturedServer[]

POST /player/account/link

Request

Key Type
code String
minecraft_name String
minecraft_uuid String

Response

Key Type
error Boolean
message LocalizedMessage

Types

PlayerProfile

Key Type
_id ObjectId
name String
nameLower String
uuid UUID
initialJoinDate Date
lastOnlineDate Date
server ObjectId
ips String[]
ranks String[]
activePunishments Punishment[]
rank PlayerRank
voteCount Integer
lastVote Long
firstJoin Boolean
friendRequests FriendRequestModel[]
friends UUID[]
ignoredUsers UUID[]
settings Map<PlayerSetting, Option>

Punishment

Key Type
punisher ObjectId
punisherName String
punisherUuid String
punished ObjectId
punishedName String
punishedUuid String
punishedIp String
reason String
type String
issued Date
expires Date
transient punishment PunishmentType

FriendRequestModel

Key Type
uuid UUID
name String
rank PlayerRank

OnlinePlayer

Key Type
name String
uuid UUID
id ObjectId
serverName String
serverType String
serverId String

ServerSession

Key Type
_id ObjectId
playerCount Integer
online Boolean
ip String
port Integer
managerPort Integer
name String
motd String
maxPlayers Integer
visibility Boolean
icon String
status Status

SimplePlayer

Key Type
name String
uuid UUID

LocalizedMessage

Key Type
message String
inserts String[]

Lobby

Key Type
id String
name String
playerCount Integer
maxPlayers Integer
ip String
port Integer

ServerProfile

Key Type
_id ObjectId
name String
owner UUID
maxPlayers Integer
maxPlugins Integer
creationDate Date
lastOnlineDate Date
ram Integer
motd String
totalOnlineTime Long
starts Integer
totalJoins Integer
userJoinsCount Integer
unlockedServerIcons ServerIconModel[]
suspended Boolean
suspendedReason String
rank_full ServerTier

ServerIconModel

Key Type
id String
datePurchased Date

ServerTier

Key Type
id String
name String
ram Integer
maxPlayers Integer
maxPlugins Integer
worldBorder Integer

PlayerHeartbeat

Key Type
name String
uuid UUID
id ObjectId
rank String

SemiSimplePlayer

Key Type
name String
uuid UUID
online Boolean
rank PlayerRank

FeaturedServer

Key Type
_id String

Enums

PunishmentType

KICK, MUTE, BAN

PlayerRank

ADMIN, DEVELOPER, JR_DEVELOPER, SR_MOD, MOD, JR_MOD, YOUTUBE, ARTIST, BUILDER, TOP_VOTER, PATRON, LEGEND, PRO, VIP, DEFAULT

PlayerSetting

PRIVATE_MESSAGES, JOIN_MESSAGES, LEAVE_MESSAGES, FRIEND_REQUESTS, FRIEND_TELEPORT, PLAYER_FINDING

Option

TRUE, FALSE, ALL_PLAYERS, DONORS_ONLY, FRIENDS_ONLY, NONE

Status

UNZIPPING_SERVER, DOWNLOADING_SERVER, DOWNLOADING_PLUGINS, SAVING, STOPPING, STARTING, ONLINE, OFFLINE, SERVICE_OFFLINE, SERVICE_STARTING

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment