jira.php¶

Jira integration module for creating support tickets for server management (power, reboot, KVM) and sales assistance requests.

API Methods¶

Method	Action	Description
`request_PXEboot`	PXE boot request	Creates a Jira ticket for manual PXE booting of the server if remote control is unavailable.
`request_assistance`	Request assistance in Jira	Sends a request for technical or commercial assistance by creating a Jira ticket for a specific server. Includes a check for duplicate open requests.
`request_check`	Server check request	Creates a Jira ticket to check and boot the server into an OS if remote control is unavailable.
`request_kvm`	KVM connection request	Creates a Jira ticket to connect IP KVM to the server.
`request_poff`	Power off request	Creates a Jira ticket for manual power off of the server.
`request_pon`	Power on request	Creates a Jira ticket for manual power on of the server.
`request_reboot`	Reboot request	Creates a Jira ticket for manual reboot of the server.

jira/request_PXEboot¶

Creates a Jira ticket for manual PXE booting of the server if remote control is unavailable.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `request_PXEboot`
token	✅	string	User authorization token
id	✅	int	Server ID

Example Request

curl -s "https://invapi.hostkey.com/jira.php" -X POST \
--data "action=request_PXEboot" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

Example of a successful response

{
"result": "OK",
"action": "request_PXEboot",
"jira_url": "https://jira.hostkey.com/browse/SUP-12345",
"jira_issue": "SUP-12345"
}

Failure response

{
"code": -2,
"message": "token required",
"description": "Authorization token is missing"
}

jira/request_assistance¶

Sends a request for technical or commercial assistance by creating a Jira ticket for a specific server. Includes a check for duplicate open requests.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `request_assistance`
token	✅	string	User authorization token
id	✅	integer	Server ID
cancellation_type	❌	string	Cancellation type (default: -)
cancellation_reason	❌	string	Reason for cancellation (default: -)
terminate_reason_custom	❌	string	Custom description of the problem/reason
terminate_move_to_provider	❌	string	Desire to switch to another provider (default: -)
terminate_reorder	❌	string	Desire to reorder the service later (default: -)
terminate_contact	❌	string	Need to contact support/sales (default: -)

Example Request

curl -s "https://invapi.hostkey.com/jira.php" -X POST \
--data "action=request_assistance" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345" \
--data "terminate_reason_custom=My custom reason"

Example of a successful response

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

Failure response

{
"ASSISTANCE_TICKET_EXISTS": {
"result": -1,
"action": "request_assistance",
"error": "There is already an open assistance request for this server: TASK-123",
"code": "ASSISTANCE_TICKET_EXISTS",
"jira_url": "https://jira.hostkey.com/browse/TASK-123",
"jira_issue": "TASK-123"
},
"ASSISTANCE_TICKET_SEARCH_FAILED": {
"result": -1,
"action": "request_assistance",
"error": "Unable to check existing assistance request, please try again later.",
"code": "ASSISTANCE_TICKET_SEARCH_FAILED"
},
"INVALID_SERVER": {
"result": -1,
"action": "request_assistance",
"error": "Jira/request_assistance: invalid server id 0"
}
}

jira/request_check¶

Creates a Jira ticket to check and boot the server into an OS if remote control is unavailable.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Action name (must be `request_check`)
token	✅	string	User authorization token
id	✅	int	Server ID

Example Request

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

Example of a successful response

{
"result": "OK",
"action": {
  "permission": "eq/console",
  "subject": "CP request: Check the server $id please",
  "message": "Dear HOSTKEY support, please check and boot the server $id into OS since it doesn't have remote control - something is wrong. \n This is automated message from INVAPI, no extra verification required."
},
"jira_url": "https://jira.hostkey.com/browse/SUP-11111",
"jira_issue": "SUP-11111"
}

Failure response

{
"code": -2,
"message": "token required",
"error_data": {}
}

jira/request_kvm¶

Creates a Jira ticket to connect IP KVM to the server.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Action name (must be 'request_kvm')
token	✅	string	User authorization token
id	✅	int	Server ID

Example Request

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

Example of a successful response

{
"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/SUP-22222",
"jira_issue": "SUP-22222"
}

Failure response

{
"code": -2,
"message": "token required",
"error_data": {}
}

jira/request_poff¶

Creates a Jira ticket for manual power off of the server.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Action name (must be 'request_poff')
token	✅	string	User authorization token
id	✅	int	Server ID

Example Request

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

Example of a successful response

{
"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/SUP-33333",
"jira_issue": "SUP-33333"
}

Failure response

{
"code": -2,
"message": "token required",
"error_data": {}
}

jira/request_pon¶

Creates a Jira ticket for manual power on of the server.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Action name: `request_pon`
token	✅	string	User authorization token
id	✅	int	Server ID

Example Request

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

Example of a successful response

{
"result": "OK",
"action": "request_pon",
"jira_url": "https://jira.hostkey.com/browse/SUP-44444",
"jira_issue": "SUP-44444"
}

Failure response

{
"code": -2,
"message": "token required",
"error_data": {}
}

jira/request_reboot¶

Creates a Jira ticket for manual reboot of the server.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Action name: `request_reboot`
token	✅	string	User authorization token
id	✅	int	Server ID

Example Request

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

Example of a successful response

{
"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/SUP-55555",
"jira_issue": "SUP-55555"
}

Failure response

{
"code": -2,
"message": "token required",
"error_data": {}
}