eq.php¶

Hardware Management Module (eq.php): API for server deployment, power management, IPMI, backups, searching, and retrieving detailed hardware configuration information.

API Methods¶

Method	Action	Description
`abort_reinstall`	abort_reinstall	Interrupts the server reinstallation process, removes associated tags (reinstall_start, autodeploy_start, autodeploy_timeout), and restores VLAN settings.
`add_ipmi_admin`	add_ipmi_admin	Adds a user with administrator privileges to the server's IPMI. If the user already exists, returns their data.
`add_ipmi_user`	add_ipmi_user	Creates a new IPMI user for the server. If the user is an administrator, permission management parameters are passed via admin_user.
`announceip`	announceip	Requests announcement of a specified subnet or a specific IP address for the server.
`backup_get_schedule`	backup_get_schedule	Returns the current backup schedule for the specified server.
`backup_list`	backup_list	Returns a list of available backups for the specified server.
`backup_save_schedule`	backup_save_schedule	Saves the configured backup schedule for the specified server.
`boot_dev`	boot_dev	Requests a server reboot to boot from a specified media (PXE or disk) depending on the mode.
`check_backup_lock`	check_backup_lock	Checks for an active lock for performing operations with the server backup.
`clear_pxe`	clear_pxe	Clears the current PXE configuration for the specified server.
`create_backup`	create_backup	Initiates the backup creation process for the specified server. The operation is performed asynchronously.
`create_pxe`	create_pxe	Creates a configuration for booting the server via network (PXE), specifying OS parameters, disks, and network settings.
`delete_backup`	delete_backup	Deletes the specified server backup. Requires passing the backup name.
`deploy`	deploy	Starts the deployment process of a specific server by its ID or via a preset in the specified location. Supports various modes: from standard to dry-run.
`get_ipmi`	get_ipmi	Returns a list of available IPMI interfaces for the server, including IP address and device model.
`get_traffic`	get_traffic	Returns IPv4 traffic data for the specified server.
`getserversforannounce`	getserversforannounce	Returns a list of active or powered off (power_off) user servers that have passed the IPv4 subnet mask limit check (/23 and /24).
`groups`	groups	Returns a list of groups for the specified server.
`hard_off`	hard_off	Performs a forced (hard) shutdown of the hardware by the specified ID. Requires permission check and resource locking if the request comes from a client.
`history`	history	Returns the server event history.
`list`	list	Returns a list of hardware based on various search criteria.
`off`	off	Turns off the server.
`on`	on	Turns on the server.
`order_instance`	order_instance	Starts the process of ordering a new server from a preset or initiates a reinstallation (reinstall) of an existing server with selection of OS, software, and network parameters.
`reboot`	reboot	Sends a request to reboot the hardware by the specified ID. If the server is in standby mode, permission verification may be required.
`reinstall`	reinstall	Initiates the process of creating a key for server reinstallation and queues the task (stage: create_pxe).
`remove_ipmi_user`	remove_ipmi_user	Deletes an additional IPMI user for the specified server.
`request_backup_link`	request_backup_link	Requests a temporary link to download a server backup. Returns a callback key to track task execution.
`restore_backup`	restore_backup	Starts the process of restoring a server from an existing backup. The operation is asynchronous.
`search`	search	Returns a list of available hardware (servers, VPS) based on specified filters: group, location, status, type, etc.
`sensors`	sensors	Returns server sensor data.
`show`	show	Returns detailed data about the server, including hardware configuration, IP addresses, interfaces, IPMI, and tags.
`status`	status	Returns the current hardware status, including hardware data, IP addresses, and interfaces.
`suspend`	suspend	Requests suspension (suspend) or unsuspension (unsuspend) of a VPS/server.
`unified_server_search`	unified_server_search	Unified server search by query.
`unit_reset`	unit_reset	Request to reset the server management module (IPMI). If the request requires confirmation, a callback is returned.
`unsuspend`	unsuspend	Request to remove the suspension (unsuspend) from a server. If the request is successful, the server will be unsuspended.
`update_servers`	update_servers	Updates the list of available servers linked to the client account in WHMCS, including active, suspended, and services awaiting payment.

eq/abort_reinstall¶

Interrupts the server reinstallation process, removes associated tags (reinstall_start, autodeploy_start, autodeploy_timeout), and restores VLAN settings.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `abort_reinstall`
id	✅	integer	Server ID
token	❌	string	Authorization token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=abort_reinstall" \
--data "id=VALUE"

Example of a successful response

{
"result": "OK",
"action": "abort_reinstall",
"id": 123
}

Failure response

``` { "code": -1, "message": "\(module/\)action: invalid server id" }

```

eq/add_ipmi_admin¶

Adds a user with administrator privileges to the server's IPMI. If the user already exists, returns their data.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `add_ipmi_admin`
id	✅	integer	Server ID
admin_user	❌	string	Administrator name (if not specified, generated automatically)
admin_pass	❌	string	Administrator password
token	✅	string	Authentication API token

Example Request

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

Example of a successful response

{
"result": "OK",
"action": "add_ipmi_admin",
"user": "uabc123",
"password": "secure_password_here"
}

Failure response

``` { "code": -1, "message": "Add IPMI user request failed" }

```

eq/add_ipmi_user¶

Creates a new IPMI user for the server. If the user is an administrator, permission management parameters are passed via admin_user.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `add_ipmi_user` or `add_ipmi_admin`
token	✅	string	Authorization token
id	✅	integer	Server ID
admin_user	❌	string	Administrator name (for admin rights)
admin_pass	❌	string	Administrator password

Example Request

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

Example of a successful response

{
"result": "OK",
"action": "add_ipmi_user",
"callback": "some_callback_key"
}

Failure response

``` { "code": -1, "message": "Add IPMI user request failed" }

```

eq/announceip¶

Requests announcement of a specified subnet or a specific IP address for the server.

HTTP-method: POST|GET

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `announceip`
id	✅	integer	Hardware (server) ID
subnet	❌	string	Subnet for announcement
server	❌	boolean	Flag to use the server as a source
subnetaddr	❌	string	Subnet address
subnetaddrmask	❌	string	Subnet mask
asn	❌	string\|boolean	Autonomous System Number (ASN). If 'own', passed as false
ownasn	❌	boolean	Use own ASN
annonce	❌	boolean	Announcement flag
return	❌	boolean	Return execution result
route	❌	boolean	Routing flag
cmnt	❌	string	Request comment
checkboxes	❌	boolean	Terms confirmation (ASRegistered, RKPIValid, SubNetNotSpamhaus, DataIsCorrect)
token	✅	string	Authentication API token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=announceip" \
--data "id=123" \
--data "token=YOUR_TOKEN"

Example of a successful response

{
"result": "OK",
"action": "announceip"
}

Failure response

``` { "code": -2, "message": "EQ: action required" }

```

eq/backup_get_schedule¶

Returns the current backup schedule for the specified server.

HTTP-method: GET

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `backup_get_schedule`
token	✅	string	Authorization token
id	✅	integer	Server ID

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X GET \
--data "action=backup_get_schedule" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

Example of a successful response

{
"result": "OK",
"action": "backup_get_schedule",
"days": [0, 0, 0, 0, 0, 0, 0],
"time": "",
"timezone": ""
}

Failure response

``` { "code": -1, "message": "EQ/backup_get_schedule: invalid server id" }

```

eq/backup_list¶

Returns a list of available backups for the specified server.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `backup_list`
id	✅	int	Server ID
token	❌	string	Authorization token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=backup_list" \
--data "id=VALUE"

Example of a successful response

{
"result": "OK",
"module": "eq",
"action": "backup_list",
"data": [
{
"bucket_name": "example-bucket",
"id": 123,
"name": "backup_2024-05-20"
}
]
}

Failure response

``` { "code": -2, "message": "Authentication required" }

```

eq/backup_save_schedule¶

Saves the configured backup schedule for the specified server.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `backup_save_schedule`
token	✅	string	Authorization token
id	✅	integer	Hardware (server) ID
backup_schedule	✅	array	Array with backup schedule settings (days, time, timezone)

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=backup_save_schedule" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "backup_schedule[0][days]=mon,wed,fri" \
--data "backup_schedule[0][time]=03:00" \
--data "backup_schedule[0][timezone]=UTC"

Example of a successful response

{
"result": "OK",
"action": "backup_save_schedule"
}

Failure response

``` { "code": -1, "message": "Error saving schedule" }

```

eq/boot_dev¶

Requests a server reboot to boot from specified media (PXE or disk) depending on the mode.

HTTP-method: POST|GET

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `boot_dev`
token	✅	string	Authorization token
id	✅	int	Server ID
media	✅	string	Boot media type
boot_mode	❌	string	Boot mode (auto, uefi or legacy)

Example Request

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

Example of a successful response

{
"result": "OK",
"action": "boot_dev",
"callback": "string"
}

Failure response

``` { "code": -1, "message": "Bootable media change request failed" }

```

eq/check_backup_lock¶

Checks for an active lock to perform operations with the server backup.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `check_backup_lock`
token	✅	string	Authorization token
id	✅	integer	Hardware (server) ID

Example Request

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

Example of a successful response

{
"result": "OK",
"action": "check_backup_lock",
"callback": "string"
}

Failure response

``` { "code": -1, "message": "EQ/check_backup_lock: invalid server id" }

```

eq/check_pin¶

Checks the PIN code for operations.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `check_pin`
token	✅	string	Authorization token
pin	✅	string	PIN code for verification

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=check_pin" \
--data "token=HOSTKEY_TOKEN" \
--data "pin=VALUE"

Example of a successful response

{
"result": "OK",
"action": "check_pin",
"callback": "pin_disabled"
}

Failure response

{
"code": -1,
"message": "PIN validation failed"
}

eq/clear_pxe¶

Clears the current PXE configuration for the specified server.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `clear_pxe`
token	✅	string	Authentication token
id	✅	integer	Hardware ID
hostname	❌	string	Hostname to clear

Example Request

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

Example of a successful response

{
"result": "OK",
"callback": "string"
}

Failure response

``` { "code": -1, "message": "Failed to submit clear PXE config request" }

```

eq/create_backup¶

Initiates the backup creation process for the specified server. The operation is performed asynchronously.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `create_backup`
id	✅	int	Hardware (server) ID
token	❌	string	Authorization token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=create_backup" \
--data "id=VALUE"

Example of a successful response

{
"result": "OK",
"module": "eq",
"action": "create_backup",
"callback": "uuid-string",
"traceKey": "uuid-string"
}

Failure response

``` { "code": -1, "message": "Operation execution error or insufficient permissions" }

```

eq/create_pxe¶

Creates a configuration for booting the server via network (PXE), specifying OS parameters, disks, and network settings.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `create_pxe`
token	✅	string	Authorization token
id	✅	int	Server ID
root_pass	✅	string	Root password
os_id	✅	int	Operating system ID
hostname	❌	string	Hostname
ssh_key	❌	string	SSH key
post_install_script	❌	string	Post-installation script
post_install_callback	❌	string	URL for callback notification
reinstall_key	❌	string	Reinstallation key
email	❌	string	User email
os_name	❌	string	OS name (alias)
disk_mirror	❌	int	Disk mirroring (-1 - none)
activate_windows	❌	int	Windows activation (0/1)
uefi	❌	int	UEFI boot mode (0/1/-1)
attendedInstall	❌	string	Automated installation
root_size	❌	int	Root partition size
deploy_ticket	❌	string	Kayako ticket ID
ignore_duplicated_install	❌	int	Ignore duplicate installations
no_lvm	❌	string	Disable LVM
custom_domain	❌	string	Custom domain
manual_choice_dsk	❌	int	Manual disk selection

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=create_pxe" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "root_pass=VALUE" \
--data "os_id=VALUE"

Example of a successful response

{
"result": "OK",
"action": "create_pxe",
"callback": "string"
}

Failure response

``` { "code": -1, "message": "Create PXE config request failed: error_text" }

```

eq/delete_backup¶

Deletes the specified server backup. Requires passing the backup name.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `delete_backup`
token	✅	string	Authorization token
id	✅	int	Hardware (server) ID
name	✅	string	Backup name to delete

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=delete_backup" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345" \
--data "name=my_backup_name"

Example of a successful response

{
"result": "OK",
"module": "eq",
"action": "delete_backup",
"callback": "string"
}

Failure response

``` { "code": -1, "message": "Backup deletion error" }

```

eq/deploy¶

Starts the deployment process of a specific server by its ID or via a preset in the specified location. Supports various modes: from standard to dry-run.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `deploy`
token	✅	string	Authorization token
id	❌	integer	Specific server ID for deployment
preset	❌	string	Preset name (if ID is not specified)
location	✅	integer	Location/datacenter ID
hostname	❌	string	Hostname for the server
root_pass	✅	string	Root password (minimum 8 characters if own_os=0)
os_id	❌	integer	Operating system ID
ssh_key	❌	string	SSH key
post_install_script	❌	string	Post-installation script
post_install_callback	❌	string	URL for callback notification
deploy_data	✅	string	Invoice data (WHMCS)
deploy_options	✅	string	WHMCS location for deployment
deploy_period	❌	string	Payment period (hourly, quarterly, semi-annually, annually)
deploy_notify	❌	integer	Client notification flag
imitate_deploy	❌	integer	Simulation mode (dry run)
custom_domain	❌	string	Custom domain
traffic_plan	✅	integer	Traffic plan ID
ipv4_amount	❌	integer	Number of IPv4 addresses
disk_mirror	❌	string	Disk mirroring (RAID)
deploy_comment	❌	string	Deployment comment

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=deploy" \
--data "token=YOUR_TOKEN" \
--data "location=1" \
--data "root_pass=SecurePass123!" \
--data "deploy_data=INVOICE_DATA" \
--data "deploy_options=WHMCS_LOCATION" \
--data "traffic_plan=5"

Example of a successful response

{
"result": "OK",
"action": "deploy",
"callback": "7bc29eb23fb1b879b21fce509597f07c",
"ticket": 12345,
"id": 101
}

Failure response

``` { "code": -1, "message": "EQ/deploy: Empty billing data." }

```

eq/get_ipmi¶

Returns a list of available IPMI interfaces for the server, including IP address and device model.

HTTP-method: GET

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `get_ipmi`
id	✅	integer	Server ID
token	❌	string	Authorization token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X GET \
--data "action=get_ipmi" \
--data "id=VALUE"

Example of a successful response

{
"result": "OK",
"ipmi": [
{
"IP": "192.168.1.100",
"MAC": "00:1A:4C:B0:58:E7",
"vendor": "Supermicro"
}
]
}

Failure response

``` { "code": -1, "message": "EQ/get_ipmi: invalid server id" }

```

eq/get_traffic¶

Returns IPv4 traffic data for the specified server.

HTTP-method: GET

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `get_traffic`
token	✅	string	Authentication token
id	✅	integer	Server ID

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X GET \
--data "action=get_traffic" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Example of a successful response

{
"result": "OK",
"module": "eq",
"action": "get_traffic",
"id": 123,
"traffic": [
{
"ip": "1.2.3.4",
"volume": 500,
"updated": "2023-10-01",
"billed": 1,
"direction": "out"
}
]
}

Failure response

``` { "code": -1, "message": "EQ/get_traffic: invalid server id" }

```

eq/get_upgrade_key¶

Returns an upgrade key linked to a specific invoice (invoice_id) via hardware tags.

HTTP-method: POST|GET

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `get_upgrade_key`
token	✅	string	Authorization token
invoice_id	❌	int	Invoice ID to search for the upgrade key

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=get_upgrade_key" \
--data "token=HOSTKEY_TOKEN" \
--data "invoice_id=12345"

Example of a successful response

{
"result": "OK",
"module": "eq",
"action": "get_upgrade_key",
"key": ""
}

Failure response

``` { "code": -1, "message": "Request error or key not found" }

```

eq/getserversforannounce¶

Returns a list of active or powered off (power_off) user servers that have passed the IPv4 subnet mask limit check (/23 and /24).

HTTP-method: POST|GET

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method name: `getserversforannounce`
token	✅	string	Authorization token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=getserversforannounce" \
--data "token=HOSTKEY_TOKEN"

Example of a successful response

{
"result": "OK",
"module": "eq",
"action": "getserversforannounce",
"servers": [
{
"id": 123,
"location": "NL",
"mask_23": "1.2.3.0/23",
"mask_24": "1.2.3.0/24"
}
]
}

Failure response

``` { "code": -2, "message": "Authentication required" }

```

eq/groups¶

Returns a list of groups for the specified server.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `groups`
token	✅	string	Authorization token
id	✅	int	Server ID

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=groups" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Example of a successful response

{
"result": "OK",
"groups": [
{
"tag": "example_group",
"value": "123"
}
]
}

Failure response

``` { "code": -1, "message": "EQ/groups: invalid server id" }

```

eq/hard_off¶

Performs a forced (hard) shutdown of the hardware by the specified ID. Requires permission check and resource locking if the request comes from a client.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `hard_off`
token	✅	string	Authorization token
id	✅	integer	Server ID

Example Request

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

Example of a successful response

{
"result": "OK",
"action": "hard_off",
"callback": "string"
}

Failure response

``` { "code": -1, "message": "Stop request failed" }

```

eq/history¶

Returns the server event history.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `history`
id	✅	int	Server ID
token	✅	string	Authorization token
type	❌	`array<string>`	Filter by event types
date_from	❌	string	Start date (YYYY-MM-DD)
date_to	❌	string	End date (YYYY-MM-DD)

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=history" \
--data "id=VALUE" \
--data "token=HOSTKEY_TOKEN" \
--data "type[]=ACTION" \
--data "type[]=ERROR" \
--data "date_from=2023-10-01" \
--data "date_to=2023-10-31"

Example of a successful response

{
"result": "OK",
"module": "eq",
"action": "history",
"id": 12345,
"history": [
{
"id": 1,
"date": "2023-10-01 12:00:00",
"message": "Server rebooted",
"type": "ACTION"
}
]
}

Failure response

{
"code": 400,
"message": "Invalid server id"
}

eq/list¶

Returns a list of hardware based on various search criteria.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `list`
token	✅	string	Authorization token
group	❌	string	Hardware group
dc	❌	string	Datacenter
location	❌	string	Location
rack	❌	string	Rack
status	❌	string	Status
owner	❌	string	Owner
component	❌	string	Component
type	❌	string	Hardware type
ip	❌	string	IP address
mac	❌	string	MAC address
account_id	❌	string	Account ID
billing	❌	string	Billing region (en/ru)
email	❌	string	Client email
name_client	❌	string	Client name
full	❌	int	Full information
kvm	❌	string	KVM
serialNumber	❌	string	Serial number
id	❌	string	ID

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=list" \
--data "token=HOSTKEY_TOKEN"

Example of a successful response

{
"result": "OK",
"servers": [
{
"id": 123,
"name": "Server 1",
"status": "rent",
"location": "NL",
"project_ids": [
1,
2
]
}
]
}

Failure response

{
"code": -1,
"message": "invalid request"
}

eq/off¶

Turns off the server.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `off`
id	✅	int	Server ID
token	✅	string	Authorization token

Example Request

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

Example of a successful response

{
"result": "OK",
"action": "off",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

Failure response

{
"code": -1,
"message": "EQ/off: invalid server id"
}

eq/on¶

Turns on the server.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `on`
id	✅	int	Server ID
token	✅	string	Authorization token

Example Request

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

Example of a successful response

{
"result": "OK",
"action": "on",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

Failure response

{
"code": -1,
"message": "EQ/on: invalid server id"
}

eq/order_instance¶

Starts the process of ordering a new server from a preset or initiates a reinstallation (reinstall) of an existing server with selection of OS, software, and network parameters.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `order_instance`
token	✅	string	Authorization token
id	❌	integer	Existing server ID for reinstallation
preset	❌	string	Preset ID or name for ordering a new instance
root_pass	✅	string	Root password (must not contain @ or #)
os_template	❌	string	OS template for deployment from template
soft_id	❌	integer	Additional software ID
ssh_key	❌	string	SSH public key
post_install_script	❌	string	Post-installation script
hostname	❌	string	Hostname
vlan	❌	integer	Private VLAN ID
root_size	❌	integer	Root partition size (GB)
ipv4_amount	❌	integer	Number of IPv4 addresses
custom_domain	❌	string	Custom domain
deploy_period	❌	string	Payment period (hourly, quarterly, semi-annually, annually)
traffic_plan	❌	integer	Traffic plan ID

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=order_instance" \
--data "token=HOSTKEY_TOKEN" \
--data "root_pass=MySecurePass123!"

Example of a successful response

{
"result": "OK",
"action": "order_instance",
"callback": "7bc29eb23fb1b879b21fce509597f07c",
"deploy_status": "install",
"id": 123,
"os_name": "Ubuntu 22.04 LTS",
"soft_name": "Docker"
}

Failure response

``` { "code": -1, "message": "EQ/order_instance: invalid instance name" }

```

eq/ovirt_novnc¶

Requests access to the oVirt noVNC console for the specified server.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
id	✅	integer	Server ID
action	❌	string	Action (ovirt_novnc)
token	❌	string	Authorization token
white_ip	❌	string	Public IP for console access

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=ovirt_novnc" \
--data "id=12345"

Example of a successful response

{
"result": "OK",
"action": "ovirt_novnc",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

Failure response

``` { "code": -1, "message": "oVirt noVNC console request failed" }

```

eq/reboot¶

Sends a request to reboot the hardware by the specified ID. If the server is in standby mode, permission verification may be required.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Action name (reboot)
token	✅	string	Authorization token
id	✅	integer	Hardware ID

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=reboot" \
--data "token=YOUR_TOKEN" \
--data "id=123"

Example of a successful response

{
"result": "OK",
"action": "reboot",
"callback": "string"
}

Failure response

``` { "code": -1, "message": "Reboot request failed" }

```

eq/reinstall¶

Initiates the process of creating a key for server reinstallation and queues the task (stage: create_pxe).

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `reinstall`
token	✅	string	Authorization token
id	✅	integer	Server ID

Example Request

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

Example of a successful response

{
"result": "OK",
"action": "reinstall",
"stage": "create_pxe",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

Failure response

``` { "code": -1, "message": "EQ/reinstall: invalid server id" }

```

eq/remove_ipmi_user¶

Deletes an additional IPMI user for the specified server.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `remove_ipmi_user`
id	✅	int	Server ID
token	❌	string	Authorization token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=remove_ipmi_user" \
--data "id=VALUE"

Example of a successful response

{
"result": "OK",
"action": "remove_ipmi_user",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

Failure response

``` { "code": -1, "message": "\(module/\)action: invalid server id" }

```

eq/request_backup_link¶

Requests a temporary link to download a server backup. Returns a callback key to track task execution.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `request_backup_link`
token	✅	string	Authorization token
id	✅	int	Hardware (server) ID
name	❌	string	Backup name for link request

Example Request

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

Example of a successful response

{
"result": "OK",
"action": "request_backup_link",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

Failure response

``` { "code": -1, "message": "Error requesting backup link" }

```

eq/restore_backup¶

Starts the process of restoring a server from an existing backup. The operation is asynchronous.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Action name (restore_backup)
token	✅	string	Authorization token
id	✅	integer	Server ID
name	✅	string	Backup name for restoration

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=restore_backup" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"
--data "name=backup_name"

Example of a successful response

{
"result": "OK",
"module": "eq",
"action": "restore_backup",
"callback": "string"
}

Failure response

``` { "code": -1, "message": "Operation execution error during restoration" }

```

eq/search¶

Returns a list of available hardware (servers, VPS) based on specified filters: group, location, status, type, etc.

HTTP-method: POST|GET

Parameters:

Parameter	Required	Type	Description
params[group]	❌	`array<string>`	Accepts multiple values: group[]=1CPU&group[]=2CPU
params[dc]	❌	`array<int>`	Datacenter ID
params[location]	❌	`array<string>`	Location code (e.g., US-East, NL)
params[rack]	❌	`array<int>`	Rack ID
params[status]	❌	`array<string>`	Hardware status (e.g., sale, prepare_full)
params[owner]	❌	`array<string>`	Hardware owner
params[component]	❌	`array<int>`	Hardware component ID
params[type]	❌	`array<string>`	Hardware type (server, switch, etc.)
params[ip]	❌	`array<string>`	Search by IP address
params[mac]	❌	`array<string>`	Search by MAC address
params[account_id]	❌	`array<int>`	Billing account ID
params[billing]	❌	`array<string>`	Billing region (en/ru)
params[email]	❌	`array<string>`	Search by client email
params[name_client]	❌	`array<string>`	Search by client name
params[full]	❌	boolean	Return full data (true/false)
params[kvm]	❌	`array<string>`	Filter by KVM availability
params[serialNumber]	❌	`array<string>`	Search by serial number
params[id]	❌	`array<int>`	Search by specific hardware IDs
token	✅	string	Authentication API token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "token=HOSTKEY_TOKEN" \
--data "params[group][]=1CPU" \
--data "params[group][]=2CPU" \
--data "params[location][]=US-East" \
--data "params[status][]=sale"

Example of a successful response

{
"result": "OK",
"servers": [
{
"id": 123,
"status": "sale",
"location": "NL",
"hostname": "srv-01.hostkey.com",
"ip": [
"192.168.1.1"
],
"is_prebill": false,
"project_ids": []
}
]
}

Failure response

```json { "code": -1, "message": "Search request execution error" }

```

eq/sensors¶

Returns server sensor data.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `sensors`
id	✅	int	Server ID
token	✅	string	Authorization token

Example Request

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

Example of a successful response

{
"result": "OK",
"action": "sensors",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

Failure response

{
"code": -1,
"message": "EQ/sensors: invalid server id"
}

eq/set_pin¶

Sets a PIN code for operations.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `set_pin`
token	✅	string	Authorization token
new_pin	✅	string	New PIN code (4-10 characters)
old_pin	❌	string	Old PIN code
no_pin_req	❌	string	Skip PIN check flag (true/false)

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=set_pin" \
--data "token=HOSTKEY_TOKEN" \
--data "new_pin=VALUE"

Example of a successful response

{
"result": "OK",
"action": "set_pin",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

Failure response

{
"code": -1,
"message": "invalid PIN length"
}

eq/show¶

Returns detailed data about the server, including hardware configuration, IP addresses, interfaces, IPMI, and tags.

HTTP-method: GET

Parameters:

Parameter	Required	Type	Description
id	✅	int	Hardware ID
token	❌	string	Authorization token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X GET \
--data "id=123"

Example of a successful response

{
"result": "OK",
"server_data": {
"id": 123,
"status": "rent",
"type": "Server",
"owner": "[email protected]",
"Condition_Component": "power_off",
"is_prebill": false,
"days_left": "",
"due_date": "",
"project_ids": []
},
"hardware": {
"components": [
{
"Type": "CPU",
"Count": 2,
"Cores": 8,
"Name": "Intel Xeon E5-2670"
}
],
"ram": 32,
"hdd": 1000
},
"groups": [
{
"tag": "group_name",
"value": "val"
}
],
"licenses": [],
"reinstall": "",
"location": {
"rack_id": 1,
"dc_location": 5
},
"OS": {
"id": 10,
"name": "Ubuntu 22.04"
},
"IP": [
{
"IP": "192.168.1.1",
"status": "active"
}
],
"interfaces": [],
"IPMI": {
"model": "none",
"interfaces": []
},
"tags": [
{
"tag": "server_name",
"value": "srv-01"
}
],
"preset": "",
"commitment": ""
}

Failure response

``` { "code": -1, "message": "Nothing found for 123" }

```

eq/status¶

Returns the current hardware status, including hardware data, IP addresses, and interfaces.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method name (status)
token	❌	string	Authorization token
id	✅	integer	Server ID

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=status" \
--data "id=123"

Example of a successful response

{
"result": "OK",
"action": "status",
"callback": "string"
}

Failure response

``` { "code": -1, "message": "Status request failed" }

```

eq/status_check¶

Returns the current hardware health check status.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `status_check`
token	✅	string	Authentication token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=status_check" \
--data "token=HOSTKEY_TOKEN"

Example of a successful response

{
"result": "OK",
"module": "eq",
"action": "status_check",
"data": [
"string (formatted status change message)"
]
}

Failure response

``` { "code": -2, "message": "Authentication required" }

```

eq/suspend¶

Requests suspension (suspend) or unsuspension (unsuspend) of a VPS/server.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
id	✅	int	Server ID
token	✅	string	Authorization token

Example Request

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

Example of a successful response

{
"result": "OK",
"action": "suspend",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

Failure response

``` { "code": -1, "message": "Suspend request failed" }

```

eq/traffic_add¶

Increases the outbound traffic limit for the server and creates a corresponding invoice in WHMCS.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `traffic_add`
id	✅	int	Server ID
new_limit	✅	int	New traffic limit in TB
token	✅	string	API authentication token

Example Request

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

Example of a successful response

{
"result": "OK",
"invoice": 12345,
"status": "Unpaid"
}

Failure response

``` { "code": -1, "message": "EQ/traffic_add: invalid new_limit" }

```

eq/unified_server_search¶

Unified server search by query.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `unified_server_search`
token	✅	string	Authorization token
query	✅	string	Search query (string or numeric ID)

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=unified_server_search" \
--data "token=HOSTKEY_TOKEN" \
--data "query=VALUE"

Example of a successful response

{
"result": "OK",
"results": {
"servers": [
{
"id": 123,
"name": "Server 1",
"owner": "[email protected]",
"status": "rent",
"billing": "en",
"type": "server"
}
]
},
"limited": {
"servers": false
},
"category": "servers"
}

Failure response

{
"code": -2,
"message": "Authentication required"
}

eq/unit_reset¶

Request to reset the server management module (IPMI). If the request requires confirmation, a callback is returned.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `unit_reset`
token	✅	string	Authorization token
id	✅	integer	Server ID

Example Request

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

Example of a successful response

{
"result": "OK",
"action": "unit_reset",
"callback": "string"
}

Failure response

``` { "code": -1, "message": "IPMI unit reset request failed: error_details" }

```

eq/unsuspend¶

Request to remove the suspension (unsuspend) from a server. If the request is successful, the server will be unsuspended.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
id	✅	integer	Server ID
action	❌	string	Action (unsuspend)
token	❌	string	Authorization token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=unsuspend" \
--data "id=VALUE"

Example of a successful response

{
"result": "OK",
"action": "unsuspend",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

Failure response

``` { "code": -1, "message": "Unsuspend request failed" }

```

eq/update_servers¶

Updates the list of available servers linked to the client account in WHMCS, including active, suspended, and services awaiting payment.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `update_servers`
token	✅	string	Authorization token
show_products	❌	int	Show products (1 - yes)
load_servers_only	❌	string	Load only servers (true/false)

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=update_servers" \
--data "token=HOSTKEY_TOKEN" \
--data "show_products=1" \
--data "load_servers_only=false"

Example of a successful response