Skip to Content
Справочник APIAPI серверов

API серверов

Эндпоинты для управления серверами в системе.

Получение списка серверов

Получение полного списка серверов.

Запрос

GET /api/servers

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. API ключ

Ответ

{ "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" } ] }

Поля ответа

ПолеТипОписание
serversarrayМассив серверов
idintegerID сервера
namestringИмя сервера
ipstringIP-адрес сервера
portintegerПорт сервера
enabledbooleanСтатус активности сервера
gamestringТип игры (cs2, csgo и т.д.)

Коды ответов

КодОписание
200Успешный запрос
401Неверный API ключ или отсутствует
403Недостаточно прав для выполнения запроса

Получение данных сервера

Получение детальной информации о конкретном сервере.

Запрос

GET /api/servers/{id}

Параметры пути

НазваниеТипОписание
idintegerID сервера

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. API ключ

Ответ

{ "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" } } }

Поля ответа

ПолеТипОписание
serverobjectОбъект сервера
idintegerID сервера
namestringИмя сервера
ipstringIP-адрес сервера
portintegerПорт сервера
enabledbooleanСтатус активности сервера
gamestringТип игры (cs2, csgo и т.д.)
rcon_passwordstringСкрытый RCON пароль
created_atstringДата создания
updated_atstringДата обновления
statsobjectСтатистика сервера

Коды ответов

КодОписание
200Успешный запрос
401Неверный API ключ или отсутствует
403Недостаточно прав для выполнения запроса
404Сервер не найден

Создание сервера

Создание нового сервера в системе.

Запрос

POST /api/servers

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. API ключ
Content-TypestringОбязательный. application/json

Тело запроса

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

Параметры тела запроса

НазваниеТипОписание
namestringОбязательный. Имя сервера
ipstringОбязательный. IP-адрес сервера
portintegerОбязательный. Порт сервера
enabledbooleanНеобязательный. Статус активности
gamestringОбязательный. Тип игры
rcon_passwordstringОбязательный. RCON пароль

Ответ

{ "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" } }

Коды ответов

КодОписание
201Сервер успешно создан
401Неверный API ключ или отсутствует
403Недостаточно прав для выполнения запроса
422Неверные параметры запроса

Обновление сервера

Обновление данных существующего сервера.

Запрос

PUT /api/servers/{id}

Параметры пути

НазваниеТипОписание
idintegerID сервера

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. API ключ
Content-TypestringОбязательный. application/json

Тело запроса

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

Параметры тела запроса

НазваниеТипОписание
namestringНеобязательный. Имя сервера
ipstringНеобязательный. IP-адрес сервера
portintegerНеобязательный. Порт сервера
enabledbooleanНеобязательный. Статус активности
gamestringНеобязательный. Тип игры
rcon_passwordstringНеобязательный. RCON пароль

Ответ

{ "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" } }

Коды ответов

КодОписание
200Сервер успешно обновлен
401Неверный API ключ или отсутствует
403Недостаточно прав для выполнения запроса
404Сервер не найден
422Неверные параметры запроса

Удаление сервера

Удаление сервера из системы.

Запрос

DELETE /api/servers/{id}

Параметры пути

НазваниеТипОписание
idintegerID сервера

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. API ключ

Ответ

{ "message": "Server deleted successfully" }

Коды ответов

КодОписание
200Сервер успешно удален
401Неверный API ключ или отсутствует
403Недостаточно прав для выполнения запроса
404Сервер не найден

Включение/отключение сервера

Изменение статуса активности сервера.

Запрос

POST /api/servers/{id}/toggle

Параметры пути

НазваниеТипОписание
idintegerID сервера

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. API ключ

Ответ

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

или

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

Коды ответов

КодОписание
200Статус сервера успешно изменен
401Неверный API ключ или отсутствует
403Недостаточно прав для выполнения запроса
404Сервер не найден