SurvivalHost API: различия между версиями
Перейти к навигации
Перейти к поиску
Swidh (обсуждение | вклад) |
Swidh (обсуждение | вклад) |
||
Строка 52: | Строка 52: | ||
Возвращаемые ошибки: | Возвращаемые ошибки: | ||
* HTTP 400 Machine not | * HTTP 404 Machine not found. | ||
== Query статус машины == | |||
'''GET [baseUrl]/v1/machines/<machine_id>/query''' | |||
Пример запроса: | |||
curl -H "Authorization: Bearer nv73MHPHw3!eEVzuHAlAhSZH/CenIgAN=/eccBIuK2AlwHF4aYSrsV3EZnMkmo-V" -X GET https://panel-api.survivalhost.org/v1/machines/1/query -k -v | |||
Пример ответа: | |||
{ | |||
"status": true, | |||
"query_status": 1 | |||
} | |||
Возвращаемые ошибки: | |||
* HTTP 404 Machine not found. | |||
* HTTP 400 Machine do not support control. | |||
* HTTP 400 Failed to complete action. | |||
{{nav foot}} | {{nav foot}} |
Версия 19:34, 7 ноября 2023
SurvivalHost API
<< SurvivalHost Wiki
| К концу статьи
Основные параметры
[baseUrl]: Главный URL сервиса (https://panel-api.survivalhost.org)
<token>: Токен доступа к сервисам (выдается сервисом при подключении)
<machine_id>: Идентификатор машины
Доступ и авторизация
Authorization: Bearer <token>
Пример тестового токена: nv73MHPHw3!eEVzuHAlAhSZH/CenIgAN=/eccBIuK2AlwHF4aYSrsV3EZnMkmo-V
Работа с машинами
Просмотр данных всех машин
GET [baseUrl]/v1/machines
Пример запроса:
curl -H "Authorization: Bearer nv73MHPHw3!eEVzuHAlAhSZH/CenIgAN=/eccBIuK2AlwHF4aYSrsV3EZnMkmo-V" -X GET https://panel-api.survivalhost.org/v1/machines -k -v
Пример ответа:
[ { "id": "1", "alias": "SH-VM10", "main_ip": "10.20.30.1", "distributive": "Windows Server 2019" }, { "id": "2", "alias": "SH-VM15", "main_ip": "10.20.30.2", "distributive": "Debian-9" } ]
Просмотр данных машины
GET [baseUrl]/v1/machines/<machine_id>
Пример запроса:
curl -H "Authorization: Bearer nv73MHPHw3!eEVzuHAlAhSZH/CenIgAN=/eccBIuK2AlwHF4aYSrsV3EZnMkmo-V" -X GET https://panel-api.survivalhost.org/v1/machines/1 -k -v
Пример ответа:
{ "id": "1", "alias": "SH-VM10", "main_ip": "10.20.30.1", "distributive": "Windows Server 2019" }
Возвращаемые ошибки:
- HTTP 404 Machine not found.
Query статус машины
GET [baseUrl]/v1/machines/<machine_id>/query
Пример запроса:
curl -H "Authorization: Bearer nv73MHPHw3!eEVzuHAlAhSZH/CenIgAN=/eccBIuK2AlwHF4aYSrsV3EZnMkmo-V" -X GET https://panel-api.survivalhost.org/v1/machines/1/query -k -v
Пример ответа:
{ "status": true, "query_status": 1 }
Возвращаемые ошибки:
- HTTP 404 Machine not found.
- HTTP 400 Machine do not support control.
- HTTP 400 Failed to complete action.
SurvivalHost API
<< SurvivalHost Wiki
| К началу статьи