Offentlig API
En lille, skrivebeskyttet HTTP API til at hente serverstatus udefra panelet: et statusdashboard, en oppetidsmonitor, en Discord-bot, en hjemmeautomatiseringsregel. Den betjenes af panelet selv og returnerer de samme live-data, som panelets egne sider viser (fra cachen i hukommelsen), så forespørgsler til den rører aldrig Docker.
Den er slået fra, indtil en administrator bruger den og er administratorbeskyttet. Intet eksponeres, før en token eksisterer.
Aktivering
Sektion kaldt “Aktivering”Indstillinger → Offentlig API → Ny nøgle. Giv den et navn, vælg, hvad den kan se (alle servere eller en specifik undergruppe), og valgfrit en udløbsdato. Den fulde nøgle (en Bearer-token) vises én gang i en dialog; kopier den nu, da kun en kort præfiks beholdes bagefter til identifikation på listen.

Oprettelse af den første nøgle tænder automatisk for API’en (Lad eksterne apps læse status-kontakten er en pausefunktion: slå den fra for at stoppe betjening uden at annullere nogen nøgler). Annuller en nøgle fra samme tabel når som helst; klienter, der bruger den, mister adgangen øjeblikkeligt.
Tokens gemmes som en SHA-256 hash (aldrig i klartekst), overlever en genstart af panelet og lever længere end de servere, de er omfattet af (en slettet server fjernes simpelthen fra den tokens resultater).
Godkendelse
Sektion kaldt “Godkendelse”Send tokenen som en Bearer-legitimationsoplysning:
Authorization: Bearer msm_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxDer er ingen cookies og ingen CORS: dette er til server-til-server og CLI-kaldere,
ikke browserapps fra en anden oprindelse. Hvis panelet er bag en reverse proxy,
skal du sørge for, at proxyen videresender Authorization-headeren.
Fejl returnerer 401 med { "ok": false, "error": "..." }. Alt andet end GET
(eller HEAD) returnerer 405. Ukendte stier returnerer 404. Når API’en er deaktiveret, returnerer enhver rute
404.
Rate limit
Sektion kaldt “Rate limit”Hver token får sit eget budget, RATE_LIMIT_PUBLIC_API_PER_MIN (standard 120
forespørgsler/minut; 0 deaktiverer begrænseren). Overskridelse af grænsen returnerer 429. Hver forespørgsel, før dens token overhovedet er kontrolleret, tæller også mod en begrænsning pr. klient-IP på fem gange det tal, så undersøgelse med manglende, forkert formaterede, tilbagekaldte eller udløbne tokens kan ikke omgå budgettet ved at rotere dem.
Endpoints
Sektion kaldt “Endpoints”GET /api/v1/servers
Sektion kaldt “GET /api/v1/servers”Hver server, som tokenen er omfattet af.
{ "ok": true, "total": 1, "online": 1, "servers": [ { "id": "srv_ab12cd34", "name": "SMP", "type": "PAPER", "state": "running", "cpuPct": 18.4, "memoryMb": 2048, "memoryLimitMb": 4096, "uptimeSeconds": 11722, "players": { "online": 3, "max": 20 } } ]}GET /api/v1/servers/:id
Sektion kaldt “GET /api/v1/servers/:id”Én server, samme objekt under en server-nøgle. Returnerer 404 for et ukendt id
og for en server, som tokenen ikke er omfattet af (ingen eksistensorakel), og 400
for et forkert formateret id.
Responsfelter
Sektion kaldt “Responsfelter”| Felt | Betydning |
|---|---|
total |
Antal servere, der er synlige for denne token (efter dens omfangfilter). |
online |
Antal af disse, der er i tilstanden: running. |
id |
Stabil server-id (srv_...). |
name |
Visningsnavn. |
type |
itzg servertype (PAPER, FABRIC, AUTO_CURSEFORGE, …). |
state |
running, starting, stopped eller crashed: en stabil oversigt over panelets interne status. |
cpuPct |
Nuværende CPU %, eller null, når serveren ikke kører. |
memoryMb |
Resident hukommelse i MB, eller null. |
memoryLimitMb |
Konfigureret containerhukommelsesgrænse i MB, eller null. |
uptimeSeconds |
Sekunder siden containeren startede, eller null. |
players |
{ online, max }, eller null, indtil serveren rapporterer en spilliste. |
Eksempel
Sektion kaldt “Eksempel”curl -s https://panel.example.com/api/v1/servers \ -H "Authorization: Bearer $MSM_TOKEN" | jq