Servers API
Endpoints for managing servers in the system.
Get Servers List
Get the complete list of servers.
Request
GET /api/servers
Headers
Name | Type | Description |
---|---|---|
X-API-Key | string | Required. 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
Field | Type | Description |
---|---|---|
servers | array | Array of servers |
id | integer | Server ID |
name | string | Server name |
ip | string | Server IP address |
port | integer | Server port |
enabled | boolean | Server active status |
game | string | Game type (cs2, csgo, etc.) |
Response Codes
Code | Description |
---|---|
200 | Successful request |
401 | Invalid or missing API key |
403 | Insufficient permissions to perform request |
Get Server Data
Get detailed information about a specific server.
Request
GET /api/servers/{id}
Path Parameters
Name | Type | Description |
---|---|---|
id | integer | Server ID |
Headers
Name | Type | Description |
---|---|---|
X-API-Key | string | Required. 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
Field | Type | Description |
---|---|---|
server | object | Server object |
id | integer | Server ID |
name | string | Server name |
ip | string | Server IP address |
port | integer | Server port |
enabled | boolean | Server active status |
game | string | Game type (cs2, csgo, etc.) |
rcon_password | string | Hidden RCON password |
created_at | string | Creation date |
updated_at | string | Update date |
stats | object | Server statistics |
Response Codes
Code | Description |
---|---|
200 | Successful request |
401 | Invalid or missing API key |
403 | Insufficient permissions to perform request |
404 | Server not found |
Create Server
Create a new server in the system.
Request
POST /api/servers
Headers
Name | Type | Description |
---|---|---|
X-API-Key | string | Required. API key |
Content-Type | string | Required. application/json |
Request Body
{
"name": "New Server",
"ip": "192.168.1.3",
"port": 27015,
"enabled": true,
"game": "cs2",
"rcon_password": "securepassword"
}
Request Body Parameters
Name | Type | Description |
---|---|---|
name | string | Required. Server name |
ip | string | Required. Server IP address |
port | integer | Required. Server port |
enabled | boolean | Optional. Active status |
game | string | Required. Game type |
rcon_password | string | Required. 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
Code | Description |
---|---|
201 | Server successfully created |
401 | Invalid or missing API key |
403 | Insufficient permissions to perform request |
422 | Invalid request parameters |
Update Server
Update data of an existing server.
Request
PUT /api/servers/{id}
Path Parameters
Name | Type | Description |
---|---|---|
id | integer | Server ID |
Headers
Name | Type | Description |
---|---|---|
X-API-Key | string | Required. API key |
Content-Type | string | Required. application/json |
Request Body
{
"name": "Updated Server",
"ip": "192.168.1.3",
"port": 27016,
"enabled": true,
"game": "cs2",
"rcon_password": "newsecurepassword"
}
Request Body Parameters
Name | Type | Description |
---|---|---|
name | string | Optional. Server name |
ip | string | Optional. Server IP address |
port | integer | Optional. Server port |
enabled | boolean | Optional. Active status |
game | string | Optional. Game type |
rcon_password | string | Optional. 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
Code | Description |
---|---|
200 | Server successfully updated |
401 | Invalid or missing API key |
403 | Insufficient permissions to perform request |
404 | Server not found |
422 | Invalid request parameters |
Delete Server
Delete a server from the system.
Request
DELETE /api/servers/{id}
Path Parameters
Name | Type | Description |
---|---|---|
id | integer | Server ID |
Headers
Name | Type | Description |
---|---|---|
X-API-Key | string | Required. API key |
Response
{
"message": "Server deleted successfully"
}
Response Codes
Code | Description |
---|---|
200 | Server successfully deleted |
401 | Invalid or missing API key |
403 | Insufficient permissions to perform request |
404 | Server not found |
Toggle Server Status
Change server active status.
Request
POST /api/servers/{id}/toggle
Path Parameters
Name | Type | Description |
---|---|---|
id | integer | Server ID |
Headers
Name | Type | Description |
---|---|---|
X-API-Key | string | Required. API key |
Response
{
"message": "Server enabled successfully",
"enabled": true
}
or
{
"message": "Server disabled successfully",
"enabled": false
}
Response Codes
Code | Description |
---|---|
200 | Server status successfully changed |
401 | Invalid or missing API key |
403 | Insufficient permissions to perform request |
404 | Server not found |