Текущая версия на 23:08, 21 мая 2017

Общая информация

Все запросы к API отправляются в указанном виде:

http://ds-host.ru/panel/api/?key=КЛЮЧ_API&action=МЕТОД

При необходимости, в строку запроса добавляются дополнительные параметры

Пример успешного ответа

Каждый успешный ответ имеет вид:

{"success":true,"responce": ВОЗВРАЩАЕМЫЕ_ДАННЫЕ (Зависят от конкретного запроса) }

Параметр success, будет true если запрос выполнился без ошибок.

Пример ответа с ошибкой

Каждый ответ с ошибкой будет иметь вид:

{"success":false,"error_message":"Описание ошибки"}

Поле success, будет false т.к. запрос был выполнен с ошибкой.

Поле error_message, будет содержать строку с описанием ошибки и будет заполнен, только если были ошибки при выполнении запроса.

Аккаунт пользователя

account.getInfo [Получение информации об аккаунте пользователя]

Пример запроса:

http://ds-host.ru/panel/api/?key=КЛЮЧ_API&action=account.getInfo

При успешном результате в объекте(responce), содержатся следующие поля:

"id": Id пользователя
"first_name": Имя пользователя
"last_name": Фамилия пользователя
"balance": баланс в рублях
"ip": Текущий ip адрес пользователя (не считая авторизации через API)
"last_ip": Последний ip адрес пользователя (не считая авторизации через API)

Игровые сервера пользователя

servers.get [Получение игровых серверов пользователя]

Пример запроса:

http://ds-host.ru/panel/api/?key=КЛЮЧ_API&action=servers.get

При успешном результате в объекте(responce), содержится массив с игровыми серверами пользователя. Каждый элемент имеет поля:

"id": Id сервера
"status":  0 - не установлен; 1 - установлен; 2 - просрочен; 3 - в очереди на установку; 4 - в процессе установки; 5 - не оплачен;

Управление игровым сервером

server.getInfo [Получение информации о сервере]

Пример запроса:

http://ds-host.ru/panel/api/?key=КЛЮЧ_API&action=server.getInfo&server_id=12345

server_id [Обязательно] - Id игрового сервера

При успешном результате в объекте(responce), содержатся следующие поля:

"id": Id сервера
"ip": Ip сервера
"port": Порт сервера
"status": 0 - не установлен; 1 - установлен; 2 - просрочен; 3 - в очереди на установку; 4 - в процессе установки; 5 - не оплачен;
"day": Количество оставшихся оплаченных дней
"owner_id": Id владельца сервером
"owner_login": Логин владельца сервера
"slots": Количество оплаченных слотов
"tarif_name": Название игрового тарифа
"game_prefix": Сокращенный префикс игры
"autoup_count": Сколько раз сервер не ответил на запрос скрипта Автоматического подъема сервера, при "autoup_count" >= 3 сервер перезагружается автоматически
"autoup": Включен ли автоматический подъем сервера при падении. (По умолчанию включается при старте игрового сервера)
"is_test_server": 1 - если сервер тестовый (взят на тестирование из ПУ), 0 - если сервер оплаченный
"access_flags": Флаги доступа (актуальны для совладельцев сервером), соответствуют разрешениям при выдаче/редактировании совладельца игрового сервера в ПУ.

server.getConsoleOutput [Получение консоли сервера]

Для совладельцев требуется разрешение: console (Просмотр и выполнение команд в консоли сервера)

Пример запроса:

http://ds-host.ru/panel/api/?key=КЛЮЧ_API&action=server.getConsoleOutput&server_id=12345&highlight=1

server_id [Обязательно] - Id игрового сервера

highlight [Не обязательно] - При значении 1 ответ консоли (поле data в объекте responce) будет подсвечен HTML тегами (как в консоли ПУ).

При успешном результате в объекте(responce), содержатся следующие поля:

"result": true - ответ консоли получен успешно, false - ответ не получен (возможно потеряна связь с игровым сервером)
"data": Содержит строку с дампом консоли сервера, поле будет заполнено, только если result = true

server.sendCommandToConsole [Отправка команды в консоль сервера]

Для совладельцев требуется разрешение: console (Просмотр и выполнение команд в консоли сервера)

Пример запроса:

http://ds-host.ru/panel/api/?key=КЛЮЧ_API&action=server.sendCommandToConsole&server_id=12345&command=status

server_id [Обязательно] - Id игрового сервера

command [Обязательно] - Отправляемая команда

При успешном результате в объекте(responce), содержатся следующие поля:

"result": true - команда отправлена успешно, false - команда не отправлена (возможно потеряна связь с игровым сервером)

server.getGraphics [Получение графиков статистики сервера]

Пример запроса:

http://ds-host.ru/panel/api/?key=КЛЮЧ_API&action=server.getGraphics&server_id=12345

server_id [Обязательно] - Id игрового сервера

При успешном результате в объекте(responce), содержатся следующие поля:

"online_past_3h": Ссылка на изображение графика онлайна за последние 3 часа
"online_past_1d": Ссылка на изображение графика онлайна за последний день
"online_past_7d": Ссылка на изображение графика онлайна за последние 7 дней
"online_past_30d": Ссылка на изображение графика онлайна за последние 30 дней

"cpu_past_3h": Ссылка на изображение графика использования процессора за последние 3 часа
"cpu_past_1d": Ссылка на изображение графика использования процессора за последний день
"cpu_past_7d": Ссылка на изображение графика использования процессора за последние 7 дней
"cpu_past_30d": Ссылка на изображение графика использования процессора за последние 30 дней
           
"memory_past_3h": Ссылка на изображение графика использования оперативной памяти за последние 3 часа
"memory_past_1d": Ссылка на изображение графика использования оперативной памяти за последний день
"memory_past_7d": Ссылка на изображение графика использования оперативной памяти за последние 7 дней
"memory_past_30d": Ссылка на изображение графика использования оперативной памяти за последние 30 дней

server.startServer [Старт/рестарт игрового сервера]

Для совладельцев требуется разрешение: startstop (Доступ к включению и выключению сервера)

Пример запроса:

http://ds-host.ru/panel/api/?key=КЛЮЧ_API&action=server.startServer&server_id=12345

server_id [Обязательно] - Id игрового сервера

При успешном результате в объекте(responce), содержатся следующие поля:

"result": true - серверу отправлена команда перезапуска, false - команда перезапуска не отправлена (возможно потеряна связь с игровым сервером)

server.stopServer [Остановка игрового сервера]

Для совладельцев требуется разрешение: startstop (Доступ к включению и выключению сервера)

Пример запроса:

http://ds-host.ru/panel/api/?key=КЛЮЧ_API&action=server.stopServer&server_id=12345

server_id [Обязательно] - Id игрового сервера

При успешном результате в объекте(responce), содержатся следующие поля:

"result": true - серверу отправлена команда остановки, false - команда остановки не отправлена (возможно потеряна связь с игровым сервером)

server.killServer [Экстренное выключение игрового сервера]

Для совладельцев требуется разрешение: configs (Доступ к конфигам сервера)

Пример запроса:

http://ds-host.ru/panel/api/?key=КЛЮЧ_API&action=server.killServer&server_id=12345

server_id [Обязательно] - Id игрового сервера

При успешном результате в объекте(responce), содержатся следующие поля:

"result": true - серверу отправлена команда аварийной остановки, false - команда аварийно остановки не отправлена (возможно потеряна связь с игровым сервером)