Castles:Защита серверов/API защиты серверов: различия между версиями
Перейти к навигации
Перейти к поиску
Swidh (обсуждение | вклад) (Новая страница: «{{TOCRIGHT}} {{nav head|Поддерживаемые игры|'''Castles Pro''' - API защиты серверов|Castles:ApiReference}} = Основные п...») |
Swidh (обсуждение | вклад) м |
||
Строка 5: | Строка 5: | ||
'''[baseUrl]''': Главный URL сервиса (https://api.castles.pro) | '''[baseUrl]''': Главный URL сервиса (https://api.castles.pro) | ||
''' | '''[project]''': Идентификатор проекта (выдается сервисом при подключении, например '''myhost''') | ||
'''<token>''': Токен доступа к сервисам (выдается сервисом при подключении) | |||
'''<ip_address>''': IP-адрес игрового сервера (например 10.10.10.5) | '''<ip_address>''': IP-адрес игрового сервера (например 10.10.10.5) | ||
Строка 16: | Строка 18: | ||
== Просмотр данных сервера == | == Просмотр данных сервера == | ||
GET [baseUrl]/ | '''GET [baseUrl]/[project]/<ip_address>:<main_port>''' | ||
Пример запроса: | Пример запроса: | ||
Строка 24: | Строка 26: | ||
== Просмотр данных всех серверов на IP-адресе == | == Просмотр данных всех серверов на IP-адресе == | ||
GET [baseUrl]/ | '''GET [baseUrl]/[project]/<ip_address>''' | ||
Пример запроса: | Пример запроса: | ||
Строка 32: | Строка 34: | ||
== Добавление сервера под защиту == | == Добавление сервера под защиту == | ||
POST [baseUrl]/ | '''POST [baseUrl]/[project]/<ip_address>''' | ||
Тело запроса: | Тело запроса: | ||
{} | {} | ||
Строка 43: | Строка 45: | ||
== Удаление сервера из под защиты == | == Удаление сервера из под защиты == | ||
DELETE / | '''DELETE [baseUrl]//[project]/<ip_address>:<main_port>''' | ||
= Справочники = | = Справочники = | ||
== Поддерживаемые игры == | == Поддерживаемые игры == | ||
GET / | '''GET [baseUrl]/[project]/games''' | ||
== Перечень обслуживаемых подсетей == | == Перечень обслуживаемых подсетей == | ||
GET / | '''GET [baseUrl]/[project]/network''' | ||
{{nav foot}} | {{nav foot}} |
Версия 22:06, 23 октября 2023
Castles Pro - API защиты серверов
<< Castles:Защита серверов
| К концу статьи | Предыдущая глава: Поддерживаемые игры | Короткая ссылка
Основные параметры
[baseUrl]: Главный URL сервиса (https://api.castles.pro)
[project]: Идентификатор проекта (выдается сервисом при подключении, например myhost)
<token>: Токен доступа к сервисам (выдается сервисом при подключении)
<ip_address>: IP-адрес игрового сервера (например 10.10.10.5)
<main_port>: Главный порт игрового сервера (см. колонку "Основной (адресный) порт" в Поддерживаемые игры)
Доступ и авторизация
Работа с игровыми серверами
Просмотр данных сервера
GET [baseUrl]/[project]/<ip_address>:<main_port>
Пример запроса:
Пример ответа:
Возвращаемые ошибки:
Просмотр данных всех серверов на IP-адресе
GET [baseUrl]/[project]/<ip_address>
Пример запроса:
Пример ответа:
Возвращаемые ошибки:
Добавление сервера под защиту
POST [baseUrl]/[project]/<ip_address>
Тело запроса:
{}
Пример запроса:
Пример ответа:
Возвращаемые ошибки:
Удаление сервера из под защиты
DELETE [baseUrl]//[project]/<ip_address>:<main_port>
Справочники
Поддерживаемые игры
GET [baseUrl]/[project]/games
Перечень обслуживаемых подсетей
GET [baseUrl]/[project]/network