jira.php¶

Jira integration module for creating support tickets related to 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 server PXE boot if remote management is unavailable.
`request_assistance`	Sales assistance request	Creates a Jira ticket for the sales department with details regarding service cancellation or modification.
`request_check`	Server check request	Creates a Jira ticket to check and boot the server into the OS if remote management is unavailable.
`request_kvm`	KVM connection request	Creates a Jira ticket to connect an IP KVM to the server.
`request_poff`	Power off request	Creates a Jira ticket for manual server power off.
`request_pon`	Power on request	Creates a Jira ticket for manual server power on.
`request_reboot`	Reboot request	Creates a Jira ticket for manual server reboot.

jira/request_PXEboot¶

Creates a Jira ticket for manual server PXE boot if remote management is unavailable.

HTTP Method: POST

Parameters:

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

Example Request

curl -s "https://api.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¶

Creates a Jira ticket for the sales department with details regarding service cancellation or modification.

HTTP Method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `request_assistance`
token	✅	string	User authorization token
id	✅	int	Server identifier
cancellation_type	❌	string	Service cancellation type
cancellation_reason	❌	string	Cancellation reason
terminate_reason_custom	❌	string	Custom problem description
terminate_move_to_provider	❌	string	Desire to switch to another provider
terminate_reorder	❌	string	Desire to reorder the service later
terminate_contact	❌	string	Desire to be contacted by support

Example Request

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

Example of a successful response

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

Failure response

{
"code": -1,
"message": "Jira/request_assistance: invalid server id",
"error_data": {}
}

jira/request_check¶

Creates a Jira ticket to check and boot the server into the OS if remote management 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 identifier

Example Request

curl -s "https://api.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 an 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 identifier

Example Request

curl -s "https://api.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 server power off.

HTTP Method: POST

Parameters:

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

Example Request

curl -s "https://api.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 server power on.

HTTP Method: POST

Parameters:

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

Example Request

curl -s "https://api.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 server reboot.

HTTP Method: POST

Parameters:

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

Example Request

curl -s "https://api.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": {}
}