Docs API Reference Server Status API
Server Status API
3 min read
Get current status
GET /v1/server/status
Response:
{
"data": {
"online": true,
"players": 32,
"maxPlayers": 64,
"uptime": 86400,
"peakToday": 58,
"serverName": "Los Santos State Roleplay",
"lastPing": "2025-06-01T12:00:28Z",
"playerList": [
{
"id": 1,
"name": "Lars Andersen",
"job": "Police Officer",
"jobGrade": "Sergeant",
"gang": null,
"discordId": "123456789012345678"
}
]
}
}
uptime is in seconds. playerList is only included when Config.ShowPlayerList = true in your companion resource.
Get status history
GET /v1/server/history
Query parameters:
| Parameter | Type | Description |
|---|---|---|
from | ISO date | Start of range |
to | ISO date | End of range |
interval | string | hourly or daily |
Response:
{
"data": [
{
"timestamp": "2025-06-01T00:00:00Z",
"online": true,
"players": 12,
"peakPlayers": 58
}
]
}
Push a custom event
Send a real-time event to your site (alternative to using the Lua export):
POST /v1/server/events
{
"event": "myResource:playerArrested",
"payload": {
"officer": "Lars Andersen",
"suspect": "Maria Chen",
"charge": "Armed robbery",
"location": "Vinewood"
}
}
This triggers any Custom Event Node in your visual module builder that listens for myResource:playerArrested.