API Документация - Мониторинг серверов MTA
Получение информации о сервере
Этот API позволяет получить информацию о сервере MTA по ID. Для этого используйте GET-запрос по следующему URL:
GET /api/monitoring/server/{id}
Где {id} — это уникальный идентификатор сервера. Запрос вернет информацию о сервере в формате JSON.
Пример запроса
GET https://soluteam.ru/api/monitoring/server/12
Ответ
Если сервер найден, ответ будет содержать информацию о сервере в следующем формате:
{ "id": 1, "host": "142.44.199.222", "port": 23293, "name": "Крутой сервер", "description": null, "num_players": 0, "max_players": 300, "gametype": "MTA:SA", "version": "1.6", "ping": 158, "password": false, "keywords": null, "isCustomClient": false, "status": true, "createdAt": "2025-01-11T15:25:57.000Z", "updatedAt": "2025-01-14T11:00:00.000Z" }
Параметры ответа:
- id: Идентификатор сервера.
- host: IP-адрес сервера.
- port: Порт сервера.
- name: Название сервера.
- description: Описание сервера (если есть, может быть null).
- num_players: Текущее количество игроков.
- max_players: Максимальное количество игроков.
- gametype: Тип игры.
- version: Версия сервера.
- ping: Время отклика (ping) сервера в миллисекундах.
- password: Указание на наличие пароля (true/false).
- keywords: Ключевые слова сервера (может быть null).
- isCustomClient: Информация о кастомном клиенте (true/false).
- status: Статус сервера (true — работает, false — не работает).
- createdAt: Дата создания сервера.
- updatedAt: Дата последнего обновления информации о сервере.
Ошибки
В случае, если сервер не найден, API вернёт ошибку 404 со следующим сообщением:
{ "message": "Сервер не найден" }
Описание возможных ошибок:
- 404 Not Found: Сервер с указанным ID не найден в базе данных. В ответе будет поле
message
со строкой "Сервер не найден". - 400 Bad Request: Неверный или пустой запрос.
- 500 Internal Server Error: Внутренняя ошибка сервера (ошибки на сервере).