Skip to Content
API ReferenceServers API

Servers API

Endpoints for managing servers in the system.

Get Servers List

Get the complete list of servers.

Request

GET /api/servers

Headers

NameTypeDescription
X-API-KeystringRequired. API key

Response

{ "servers": [ { "id": 1, "name": "Server #1", "ip": "192.168.1.1", "port": 27015, "enabled": true, "game": "cs2" }, { "id": 2, "name": "Server #2", "ip": "192.168.1.2", "port": 27015, "enabled": false, "game": "cs2" } ] }

Response Fields

FieldTypeDescription
serversarrayArray of servers
idintegerServer ID
namestringServer name
ipstringServer IP address
portintegerServer port
enabledbooleanServer active status
gamestringGame type (cs2, csgo, etc.)

Response Codes

CodeDescription
200Successful request
401Invalid or missing API key
403Insufficient permissions to perform request

Get Server Data

Get detailed information about a specific server.

Request

GET /api/servers/{id}

Path Parameters

NameTypeDescription
idintegerServer ID

Headers

NameTypeDescription
X-API-KeystringRequired. API key

Response

{ "server": { "id": 1, "name": "Server #1", "ip": "192.168.1.1", "port": 27015, "enabled": true, "game": "cs2", "rcon_password": "********", "created_at": "2023-01-01T00:00:00Z", "updated_at": "2023-01-10T00:00:00Z", "stats": { "players_online": 20, "max_players": 32, "map": "de_dust2" } } }

Response Fields

FieldTypeDescription
serverobjectServer object
idintegerServer ID
namestringServer name
ipstringServer IP address
portintegerServer port
enabledbooleanServer active status
gamestringGame type (cs2, csgo, etc.)
rcon_passwordstringHidden RCON password
created_atstringCreation date
updated_atstringUpdate date
statsobjectServer statistics

Response Codes

CodeDescription
200Successful request
401Invalid or missing API key
403Insufficient permissions to perform request
404Server not found

Create Server

Create a new server in the system.

Request

POST /api/servers

Headers

NameTypeDescription
X-API-KeystringRequired. API key
Content-TypestringRequired. application/json

Request Body

{ "name": "New Server", "ip": "192.168.1.3", "port": 27015, "enabled": true, "game": "cs2", "rcon_password": "securepassword" }

Request Body Parameters

NameTypeDescription
namestringRequired. Server name
ipstringRequired. Server IP address
portintegerRequired. Server port
enabledbooleanOptional. Active status
gamestringRequired. Game type
rcon_passwordstringRequired. RCON password

Response

{ "message": "Server created successfully", "server": { "id": 3, "name": "New Server", "ip": "192.168.1.3", "port": 27015, "enabled": true, "game": "cs2", "created_at": "2023-03-15T12:00:00Z" } }

Response Codes

CodeDescription
201Server successfully created
401Invalid or missing API key
403Insufficient permissions to perform request
422Invalid request parameters

Update Server

Update data of an existing server.

Request

PUT /api/servers/{id}

Path Parameters

NameTypeDescription
idintegerServer ID

Headers

NameTypeDescription
X-API-KeystringRequired. API key
Content-TypestringRequired. application/json

Request Body

{ "name": "Updated Server", "ip": "192.168.1.3", "port": 27016, "enabled": true, "game": "cs2", "rcon_password": "newsecurepassword" }

Request Body Parameters

NameTypeDescription
namestringOptional. Server name
ipstringOptional. Server IP address
portintegerOptional. Server port
enabledbooleanOptional. Active status
gamestringOptional. Game type
rcon_passwordstringOptional. RCON password

Response

{ "message": "Server updated successfully", "server": { "id": 3, "name": "Updated Server", "ip": "192.168.1.3", "port": 27016, "enabled": true, "game": "cs2", "updated_at": "2023-03-16T14:30:00Z" } }

Response Codes

CodeDescription
200Server successfully updated
401Invalid or missing API key
403Insufficient permissions to perform request
404Server not found
422Invalid request parameters

Delete Server

Delete a server from the system.

Request

DELETE /api/servers/{id}

Path Parameters

NameTypeDescription
idintegerServer ID

Headers

NameTypeDescription
X-API-KeystringRequired. API key

Response

{ "message": "Server deleted successfully" }

Response Codes

CodeDescription
200Server successfully deleted
401Invalid or missing API key
403Insufficient permissions to perform request
404Server not found

Toggle Server Status

Change server active status.

Request

POST /api/servers/{id}/toggle

Path Parameters

NameTypeDescription
idintegerServer ID

Headers

NameTypeDescription
X-API-KeystringRequired. API key

Response

{ "message": "Server enabled successfully", "enabled": true }

or

{ "message": "Server disabled successfully", "enabled": false }

Response Codes

CodeDescription
200Server status successfully changed
401Invalid or missing API key
403Insufficient permissions to perform request
404Server not found