Documentation menu

Reference

API Reference

The HiveScale HTTP API, grouped by area. Authenticate with a bearer token, then call any endpoint below.

Activity

1 endpoint

Durable, tenant-scoped activity log (history/query)

GET

Chat

1 endpoint

Global chat publish

POST

Economy

6 endpoints

Currencies + statistics for any owner (player, farm, ...)

GET POST

Events

1 endpoint

Server→plugin push stream (SSE)

GET

Localization

5 endpoints

Message catalog pull + player language preference

GET POST PUT

Matchmaking

2 endpoints

Plugin-facing server/world matchmaking

POST GET

Permissions

7 endpoints

Permission groups and user permissions

GET PUT DELETE POST

Players

9 endpoints

Player profile, currencies, data store, statistics

GET PUT DELETE POST

Public: Waitlist

2 endpoints

HiveScale pre-launch waitlist signup + confirmation

POST GET

Punishments

11 endpoints

Bans, mutes, warns, kicks + IP punishments

POST GET

Servers

11 endpoints

Server registration, heartbeat, presence, and listing

GET POST DELETE

Transfers

2 endpoints

Move players between servers

POST

Version

1 endpoint

Hub build stamp

GET

Worlds

8 endpoints

On-demand player/team worlds (lease + boot + snapshot)

POST

Scalar Reference Resource

2 endpoints
GET

Collections Resource

9 endpoints
POST GET PUT DELETE

Server Config Resource

3 endpoints
POST GET