SurvivalHost API - История изменений

Swidh: /* Работа с машинами */

2023-11-07T17:14:23Z

Работа с машинами

← Предыдущая		Версия 17:14, 7 ноября 2023
Строка 88:		Строка 88:
	Возвращаемые ошибки:		Возвращаемые ошибки:
	* HTTP 404 Machine not found.		* HTTP 404 Machine not found.

			== Запуск машины ==
			'''POST [baseUrl]/v1/machines/<machine_id>/start'''

			Пример запроса:
			curl -H "Authorization: Bearer nv73MHPHw3!eEVzuHAlAhSZH/CenIgAN=/eccBIuK2AlwHF4aYSrsV3EZnMkmo-V" -X POST https://panel-api.survivalhost.org/v1/machines/1/start -k -v

			Пример ответа:
			{
			"status": true
			}

			Возвращаемые ошибки:
			* HTTP 404 Machine not found.
			* HTTP 400 Machine do not support control.
			* HTTP 400 Failed to complete action.
			* HTTP 400 The machine rental service is suspended.

			== Остановка машины ==
			'''POST [baseUrl]/v1/machines/<machine_id>/stop'''

			Пример запроса:
			curl -H "Authorization: Bearer nv73MHPHw3!eEVzuHAlAhSZH/CenIgAN=/eccBIuK2AlwHF4aYSrsV3EZnMkmo-V" -X POST https://panel-api.survivalhost.org/v1/machines/1/stop -k -v

			Пример ответа:
			{
			"status": true
			}

			Возвращаемые ошибки:
			* HTTP 404 Machine not found.
			* HTTP 400 Machine do not support control.
			* HTTP 400 Failed to complete action.
			* HTTP 400 The machine rental service is suspended.

			== Перезапуск машины ==
			'''POST [baseUrl]/v1/machines/<machine_id>/restart'''

			Пример запроса:
			curl -H "Authorization: Bearer nv73MHPHw3!eEVzuHAlAhSZH/CenIgAN=/eccBIuK2AlwHF4aYSrsV3EZnMkmo-V" -X POST https://panel-api.survivalhost.org/v1/machines/1/restart -k -v

			Пример ответа:
			{
			"status": true
			}

			Возвращаемые ошибки:
			* HTTP 404 Machine not found.
			* HTTP 400 Machine do not support control.
			* HTTP 400 Failed to complete action.
			* HTTP 400 The machine rental service is suspended.

	== Переустановка дистрибутива на машине ==		== Переустановка дистрибутива на машине ==

Swidh: /* Основные параметры */

2023-11-07T17:00:41Z

Основные параметры

← Предыдущая		Версия 17:00, 7 ноября 2023
Строка 8:		Строка 8:

	'''<machine_id>''': Идентификатор машины		'''<machine_id>''': Идентификатор машины


	= Доступ и авторизация =		= Доступ и авторизация =

Swidh: /* Работа с машинами */

2023-11-07T17:00:18Z

Работа с машинами

← Предыдущая		Версия 17:00, 7 ноября 2023
Строка 25:		Строка 25:
	[		[
	{		{
	"id": "1",		"id": 1,
	"alias": "SH-VM10",		"alias": "SH-VM10",
	"main_ip": "10.20.30.1",		"main_ip": "10.20.30.1",
Строка 31:		Строка 31:
	},		},
	{		{
	"id": "2",		"id": 2,
	"alias": "SH-VM15",		"alias": "SH-VM15",
	"main_ip": "10.20.30.2",		"main_ip": "10.20.30.2",
Строка 45:		Строка 45:
	Пример ответа:		Пример ответа:
	{		{
	"id": "1",		"id": 1,
	"alias": "SH-VM10",		"alias": "SH-VM10",
	"main_ip": "10.20.30.1",		"main_ip": "10.20.30.1",
Строка 78:		Строка 78:
	[		[
	{		{
	"id": "4",		"id": 4,
	"name": "Windows Server 2019"		"name": "Windows Server 2019"
	},		},
	{		{
	"id": "10",		"id": 10,
	"name": "Ubuntu-18-Standard-KVM"		"name": "Ubuntu-18-Standard-KVM"
	}		}
Строка 89:		Строка 89:
	Возвращаемые ошибки:		Возвращаемые ошибки:
	* HTTP 404 Machine not found.		* HTTP 404 Machine not found.

			== Переустановка дистрибутива на машине ==
			'''POST [baseUrl]/v1/machines/<machine_id>/reinstall'''
			Тело запроса:
			{
			"os":4
			}

			Пример запроса:
			curl -d '{"os":4}' -H "Content-Type: application/json" -H "Authorization: Bearer nv73MHPHw3!eEVzuHAlAhSZH/CenIgAN=/eccBIuK2AlwHF4aYSrsV3EZnMkmo-V" -X POST https://panel-api.survivalhost.org/v1/machines/1/reinstall -k -v

			Пример ответа:
			{
			"status": true
			}

			Возвращаемые ошибки:
			* HTTP 404 Machine not found.
			* HTTP 400 Body must contain valid json.
			* HTTP 400 The os field is required.
			* HTTP 400 The os field must contain an integer.
			* HTTP 400 Machine do not support control.
			* HTTP 400 Failed to complete action.
			* HTTP 400 The machine rental service is suspended.

	{{nav foot}}		{{nav foot}}

Swidh: /* Работа с машинами */

2023-11-07T16:42:34Z

Работа с машинами

← Предыдущая		Версия 16:42, 7 ноября 2023
Строка 70:		Строка 70:
	* HTTP 400 Failed to complete action.		* HTTP 400 Failed to complete action.

			== Доступные дистрибутивы для машины ==
			'''GET [baseUrl]/v1/machines/<machine_id>/os'''
			Пример запроса:
			curl -H "Authorization: Bearer nv73MHPHw3!eEVzuHAlAhSZH/CenIgAN=/eccBIuK2AlwHF4aYSrsV3EZnMkmo-V" -X GET https://panel-api.survivalhost.org/v1/machines/1/os-k -v

			Пример ответа:
			[
			{
			"id": "4",
			"name": "Windows Server 2019"
			},
			{
			"id": "10",
			"name": "Ubuntu-18-Standard-KVM"
			}
			]

			Возвращаемые ошибки:
			* HTTP 404 Machine not found.

	{{nav foot}}		{{nav foot}}

Swidh: /* Работа с машинами */

2023-11-07T16:34:51Z

Работа с машинами

← Предыдущая		Версия 16:34, 7 ноября 2023
Строка 52:		Строка 52:

	Возвращаемые ошибки:		Возвращаемые ошибки:
	* HTTP 400 Machine not ~~found~~.		* 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}}

Swidh: /* Просмотр данных машины */

2023-11-07T16:29:38Z

Просмотр данных машины

← Предыдущая		Версия 16:29, 7 ноября 2023
Строка 51:		Строка 51:
	}		}

			Возвращаемые ошибки:
			* HTTP 400 Machine not found.

	{{nav foot}}		{{nav foot}}

Swidh в 16:19, 7 ноября 2023

2023-11-07T16:19:54Z

← Предыдущая		Версия 16:19, 7 ноября 2023
Строка 6:		Строка 6:

	'''<token>''': Токен доступа к сервисам (выдается сервисом при подключении)		'''<token>''': Токен доступа к сервисам (выдается сервисом при подключении)

			'''<machine_id>''': Идентификатор машины


Строка 35:		Строка 37:
	}		}
	]		]

			== Просмотр данных машины ==
			'''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"
			}


	{{nav foot}}		{{nav foot}}

Swidh в 11:34, 7 ноября 2023

2023-11-07T11:34:09Z

← Предыдущая		Версия 11:34, 7 ноября 2023
Строка 1:		Строка 1:
	{{TOCRIGHT}}		{{TOCRIGHT}}
	{{nav head~~\|'''SurvivalHost API'''~~}}		{{nav head}}

	= Основные параметры =		= Основные параметры =

Swidh в 11:33, 7 ноября 2023

2023-11-07T11:33:44Z

← Предыдущая		Версия 11:33, 7 ноября 2023
Строка 1:		Строка 1:
	{{TOCRIGHT}}		{{TOCRIGHT}}
	{{nav head~~\|Поддерживаемые игры~~\|'''~~Castles Pro~~''' ~~- API защиты серверов\|Castles:ApiReference~~}}		{{nav head\|'''SurvivalHost API'''}}

	= Основные параметры =		= Основные параметры =

Swidh: Новая страница: «{{TOCRIGHT}} {{nav head|Поддерживаемые игры|'''Castles Pro''' - API защиты серверов|Castles:ApiReference}} = Основные п...»

2023-11-07T11:32:22Z

Новая страница: «{{TOCRIGHT}} {{nav head|Поддерживаемые игры|'''Castles Pro''' - API защиты серверов|Castles:ApiReference}} = Основные п...»

Новая страница

{{TOCRIGHT}}
{{nav head|Поддерживаемые игры|'''Castles Pro''' - API защиты серверов|Castles:ApiReference}}

= Основные параметры =
'''[baseUrl]''': Главный URL сервиса (https://panel-api.survivalhost.org)

'''<token>''': Токен доступа к сервисам (выдается сервисом при подключении)

= Доступ и авторизация =
'''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"
}
]

{{nav foot}}