jira.php¶

В этой статье

Методы API

jira/request_PXEboot

jira/request_assistance

jira/request_check

jira/request_kvm

jira/request_poff

jira/request_pon

jira/request_reboot

Модуль интеграции с Jira для создания тикетов поддержки: управление питанием серверов (on/off/reboot), запуск PXE, подключение KVM и отправка запросов на техническую помощь.

Методы API¶

Метод	Действие	Описание
`request_PXEboot`	запрос на загрузку с PXE	Создает тикет в Jira для ручной загрузки сервера через PXE.
`request_assistance`	запрос технической помощи	Создает тикет в Jira для получения технической или коммерческой помощи по серверу.
`request_check`	запрос проверки сервера	Создает тикет в Jira для проверки работоспособности и загрузки сервера.
`request_kvm`	запрос подключения KVM	Создает тикет в Jira для подключения IP KVM к серверу.
`request_poff`	запрос выключения сервера	Создает тикет в Jira для ручного выключения сервера.
`request_pon`	запрос включения сервера	Создает тикет в Jira для ручного включения сервера.
`request_reboot`	запрос перезагрузки сервера	Создает тикет в Jira для ручной перезагрузки сервера.

jira/request_PXEboot¶

Создает тикет в Jira для ручной загрузки сервера через PXE.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `request_PXEboot`
token	✅	string	Токен авторизации
id	❌	integer	Идентификатор сервера для выполнения операции

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

curl -s "https://invapi.hostkey.ru/jira.php" -X POST \
--data "action=request_PXEboot" \
--data "token=YOUR_TOKEN" \
--data "id=12345"

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

{
"result": "OK",
"action": {
"permission": "eq/reinstall",
"subject": "CP request: Manual boot the server $id from PXE please",
"message": "Dear HOSTKEY support, please boot the server $id from PXE since it doesn't have remote control. \n This is automated message from INVAPI, no extra verification required."
},
"jira_url": "https://jira.hostkey.com/browse/REQ-123",
"jira_issue": "REQ-123"
}

Примеры ошибок

{
"code": -1,
"message": "RH request failed, please contact support@hostkey.com directly."
}

jira/request_assistance¶

Создает тикет в Jira для получения технической или коммерческой помощи по серверу.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `request_assistance`
token	✅	string	Токен авторизации
cancellation_type	❌	string	Тип отмены услуги. По умолчанию '-'.
cancellation_reason	❌	string	Причина отмены.
terminate_reason_custom	✅	string	Подробное описание проблемы (обязательно).
terminate_move_to_provider	❌	string	Желание перейти к другому провайдеру.
terminate_reorder	❌	string	Желание переоформить услугу позже.
terminate_contact	❌	string	Контактная информация для связи с отделом продаж/поддержки.

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

curl -s "https://invapi.hostkey.ru/jira.php" -X POST \
--data "action=request_assistance" \
--data "token=HOSTKEY_TOKEN" \
--data "terminate_reason_custom=VALUE"

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

{
"result": "OK",
"action": "request_assistance",
"jira_url": "https://jira.hostkey.com/browse/HELP-456",
"jira_issue": "HELP-456"
}

Примеры ошибок

{
"code": -1,
"message": "Problem description is required.",
"details": {
"code": "ASSISTANCE_DESCRIPTION_REQUIRED"
}
}

jira/request_check¶

Создает тикет в Jira для проверки работоспособности и загрузки сервера.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `request_check`
token	✅	string	Токен авторизации

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

curl -s "https://invapi.hostkey.ru/jira.php" -X POST \
--data "action=request_check" \
--data "token=HOSTKEY_TOKEN"

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

{
"result": "OK",
"action": "request_check",
"jira_url": "https://jira.hostkey.com/browse/CHK-789",
"jira_issue": "CHK-789"
}

Примеры ошибок

{
"code": -1,
"message": "RH request failed, please contact support@hostkey.com directly."
}

jira/request_kvm¶

Создает тикет в Jira для подключения IP KVM к серверу.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `request_kvm`
token	✅	string	Токен авторизации
id	❌	integer	Идентификатор сервера для подключения KVM

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

curl -s "https://invapi.hostkey.ru/jira.php" -X POST \
--data "action=request_kvm" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345"

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

{
"result": "OK",
"action": {
"permission": "eq/console",
"subject": "CP request: Connect IP KVM to the server $id please",
"message": "Dear HOSTKEY support, please connect KVM to the server $id since it doesn't have remote control. \n This is automated message from INVAPI, no extra verification required."
},
"jira_url": "https://jira.hostkey.com/browse/KVM-101",
"jira_issue": "KVM-101"
}

Примеры ошибок

{
"code": -2,
"message": "Jira/request_kvm: invalid server id"
}

jira/request_poff¶

Создает тикет в Jira для ручного выключения сервера.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `request_poff`
token	✅	string	Токен авторизации
id	❌	integer	Идентификатор сервера для выполнения операции

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

curl -s "https://invapi.hostkey.ru/jira.php" -X POST \
--data "action=request_poff" \
--data "token=YOUR_TOKEN" \
--data "id=123"

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

{
"result": "OK",
"action": {
"permission": "eq/off",
"subject": "CP request: Manual power OFF the server $id please",
"message": "Dear HOSTKEY support, please power off the server $id since it doesn't have remote control. \n This is automated message from INVAPI, no extra verification required."
},
"jira_url": "https://jira.hostkey.com/browse/OFF-202",
"jira_issue": "OFF-202"
}

Примеры ошибок

{
"code": -1,
"message": "RH request failed, please contact support@hostkey.com directly."
}

jira/request_pon¶

Создает тикет в Jira для ручного включения сервера.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `request_pon`
token	✅	string	Токен авторизации
id	❌	integer	Идентификатор сервера для выполнения операции

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

curl -s "https://invapi.hostkey.ru/jira.php" -X POST \
--data "action=request_pon" \
--data "token=YOUR_TOKEN" \
--data "id=12345"

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

{
"result": "OK",
"action": {
"permission": "eq/on",
"subject": "CP request: Manual power ON the server $id please",
"message": "Dear HOSTKEY support, please power on the server $id since it doesn't have remote control. \n This is automated message from INVAPI, no extra verification required."
},
"jira_url": "https://jira.hostkey.com/browse/ON-303",
"jira_issue": "ON-303"
}

Примеры ошибок

{
"code": -1,
"message": "RH request failed, please contact support@hostkey.com directly."
}

jira/request_reboot¶

Создает тикет в Jira для ручной перезагрузки сервера.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `request_reboot`
token	✅	string	Токен авторизации
id	❌	integer	Идентификатор сервера для выполнения операции перезагрузки

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

curl -s "https://invapi.hostkey.ru/jira.php" -X POST \
--data "action=request_reboot" \
--data "token=YOUR_TOKEN" \
--data "id=12345"

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

{
"result": "OK",
"action": {
"permission": "eq/reboot",
"subject": "CP request: Manual reboot the server $id please",
"message": "Dear HOSTKEY support, please reboot the server $id since it doesn't have remote control. \n This is automated message from INVAPI, no extra verification required."
},
"jira_url": "https://jira.hostkey.com/browse/REB-404",
"jira_issue": "REB-404"
}

Примеры ошибок

{
"code": -1,
"message": "RH request failed, please contact support@hostkey.com directly."
}