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	Cancels the server reinstallation process, removes associated tags (reinstall_start, autodeploy_start, autodeploy_timeout), and resets VLAN settings.
`add_ipmi_admin`	add_ipmi_admin	Creates a new user with administrator privileges for IPMI management. 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, appropriate permissions are required.
`announceip`	announceip	Performs IP address or subnet announcement for the specified server. Supports permission checks and sub-account operations.
`backup_get_schedule`	backup_get_schedule	Returns a list of scheduled backup tasks for the specified server.
`backup_list`	backup_list	Returns a list of available backups for the specified hardware (server).
`backup_save_schedule`	backup_save_schedule	Saves the configured automatic backup schedule for the specified server.
`boot_dev`	boot_dev	Request to boot the server from the specified media (PXE or disk) depending on the selected boot mode.
`check_backup_lock`	check_backup_lock	Checks for an active lock before performing operations with server backups.
`clear_pxe`	clear_pxe	Clears the PXE configuration for the specified host. If the `full` parameter is 1, all content is deleted; if 0, only the platform remains.
`create_backup`	create_backup	Initiates the backup creation process for the specified server. The operation is performed asynchronously.
`create_pxe`	create_pxe	Prepares configuration for booting the server via network (PXE), specifying OS, disk, and network settings.
`delete_backup`	delete_backup	Deletes the specified server backup. The operation is asynchronous and returns a task tracking key.
`deploy`	deploy	Starts the deployment process of a specific server by its ID or via a preset in the specified location. Supports OS selection, hostname configuration, SSH keys, and post-install scripts.
`get_ipmi`	get_ipmi	Returns the IP address and IPMI interface model for the specified server. May return multiple interfaces.
`get_traffic`	get_traffic	Returns IPv4 traffic usage data for the specified server.
`getserversforannounce`	getserversforannounce	Returns a list of available servers (type Server) in `rent` or `power_off` status that have passed IP announcement limit checks for the current user/sub-account.
`groups`	groups	Returns the list of groups for a specific server.
`hard_off`	hard_off	Sends a request for a forced server shutdown (Hard Off).
`history`	history	Returns the server event history.
`list`	list	Returns a list of available servers and hardware with support for advanced search by various parameters (location, status, type, IP, MAC, etc.).
`off`	off	Shuts down the server.
`on`	on	Powers on the server.
`order_instance`	order_instance	Starts a new server deployment from a preset or reinstallation of an existing server with OS, software, and network parameter selection.
`reboot`	reboot	Sends a request to reboot the hardware. If the server is in rental mode, a notification will be sent to the client.
`reinstall`	reinstall	Starts the server reinstallation preparation process, creates an operation key, and notifies the client.
`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.
`restore_backup`	restore_backup	Starts the server restoration process from the specified backup. The method is asynchronous and returns a callback to track status.
`search`	search	Returns a list of available hardware based on various filters (group, location, status, type, IP, MAC, etc.).
`sensors`	sensors	Returns current sensor readings (temperature, fan speed, etc.) for the specified server.
`show`	show	Returns detailed information about the server, including hardware (`hwconfig`), operating system, IP addresses, interfaces, and IPMI.
`status`	status	Returns the current server status (`power_off`, `rent`, `repair`, etc.).
`suspend`	suspend	Requests suspension (suspend) or unsuspension (unsuspend) of a VPS server. Requires appropriate permissions and no administrator locks.
`unified_server_search`	unified_server_search	Unified search for servers by query.
`unit_reset`	unit_reset	Requests an IPMI module reset for the specified server.
`unsuspend`	unsuspend	Request to remove a suspension (unsuspend) from a server.
`update_servers`	update_servers	Updates the list of available servers for the user, synchronizing data with WHMCS billing and considering payment status.

eq/abort_reinstall¶

Cancels the server reinstallation process, removes associated tags (reinstall_start, autodeploy_start, autodeploy_timeout), and resets 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¶

Creates a new user with administrator privileges for IPMI management. 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	Admin username (if not specified, generated automatically)
admin_pass	❌	string	Admin 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": "uabcde",
"password": "securePassword123!"
}

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, appropriate permissions are required.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `add_ipmi_user`
token	✅	string	Authentication token
id	✅	integer	Server ID
admin_user	❌	string	Admin username (if applicable)
admin_pass	❌	string	Admin password

Example Request

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

Example of a successful response

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

Failure response

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

```

eq/announceip¶

Performs IP address or subnet announcement for the specified server. Supports permission checks and sub-account operations.

HTTP-method: POST|GET

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `announceip`
id	✅	integer	Server ID
subnet	❌	string	Subnet for announcement
server	❌	string	Server (boolean/string)
subnetaddr	❌	string	Subnet address
subnetaddrmask	❌	string	Subnet mask
asn	❌	string\|boolean	Autonomous System Number (can specify 'own')
ownasn	❌	string\|boolean	Use own ASN
annonce	❌	string\|boolean	Announcement flag
return	❌	string\|boolean	Return result
route	❌	string\|boolean	Route
cmnt	❌	string	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=VALUE" \
--data "token=HOSTKEY_TOKEN"

Example of a successful response

{
"result": "OK",
"action": "announceip",
"servers": [
{
"id": 123,
"location": "NL",
"mask_23": "255.255.254.0",
"mask_24": "255.255.255.0"
}
]
}

Failure response

``` { "code": -1, "message": "Announcement operation failed" }

```

eq/backup_get_schedule¶

Returns a list of scheduled backup tasks 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	Hardware (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 hardware (server).

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `backup_list`
id	✅	integer	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",
"files": []
}
]
}

Failure response

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

```

eq/backup_save_schedule¶

Saves the configured automatic backup schedule for the specified server.

HTTP-method: POST|GET

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>`	Array with schedule settings. Contains: days (0/1 array), time (string HH:mm), timezone (string)

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][0]=1" \
--data "backup_schedule[0][days][1]=0" \
--data "backup_schedule[0][time]=03:00" \
--data "backup_schedule[0][timezone]=Europe/London"

Example of a successful response

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

Failure response

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

```

eq/boot_dev¶

Request to boot the server from the specified media (PXE or disk) depending on the selected boot 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	Bootable 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 before performing operations with server backups.

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": "7bc29eb23fb1b879b21fce509597f07c"
}

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 PXE configuration for the specified host. If the full parameter is 1, all content is deleted; if 0, only the platform remains.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Action name (clear_pxe)
token	✅	string	Authorization token
id	✅	integer	Hardware ID
hostname	❌	string	Hostname for PXE configuration clearing

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=clear_pxe" \
--data "token=YOUR_TOKEN" \
--data "id=12345" \
--data "hostname=my-host"

Example of a successful response

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

Failure response

``` { "code": -1, "message": "Execution error or invalid ID" }

```

eq/console¶

Requests the launch of the server management console via IPMI/NoVNC.

HTTP-method: POST

Parameters:

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

Example Request

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

Example of a successful response

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

Failure response

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

```

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" }

```

eq/create_pxe¶

Prepares configuration for booting the server via network (PXE), specifying OS, disk, 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	❌	string	Disk mirroring
activate_windows	❌	int	Windows activation (0/1)
activation_key	❌	string	Activation key
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	❌	int	Without LVM (0/1)
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 message" }

```

eq/delete_backup¶

Deletes the specified server backup. The operation is asynchronous and returns a task tracking key.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `delete_backup`
token	✅	string	Authorization token
id	✅	int	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": "Request failed: error_details" }

```

eq/deploy¶

Starts the deployment process of a specific server by its ID or via a preset in the specified location. Supports OS selection, hostname configuration, SSH keys, and post-install scripts.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `deploy`
token	✅	string	Authorization token
id	❌	integer	Specific server ID for deployment. If not specified, a preset is used.
preset	❌	string	Preset name (if id is not specified)
location	✅	integer	Location/datacenter ID
hostname	❌	string	Desired hostname
root_pass	✅	string	Root password (minimum 8 characters for non-own OS)
os_id	❌	integer	Operating system ID
ssh_key	❌	string	Public SSH key
post_install_script	❌	string	Script to execute after installation
post_install_callback	❌	string	URL/method for callback upon completion
deploy_data	✅	string	Billing data (invoice ID or email)
deploy_options	✅	string	Billing/location options
os_name	❌	string	OS name (alias)
deploy_period	❌	string	Payment period (hourly, quarterly, semi-annually, annually)
traffic_plan	❌	integer	Traffic plan ID
ipv4_amount	❌	integer	Number of IPv4 addresses
custom_domain	❌	string	Custom domain

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=SecurePassword123!" \
--data "deploy_data=INV-12345" \
--data "deploy_options=some_option_value"

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 the IP address and IPMI interface model for the specified server. May return multiple interfaces.

HTTP-method: GET|POST

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|POST \
--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": "No IPMI interfaces found" }

```

eq/get_traffic¶

Returns IPv4 traffic usage data for the specified server.

HTTP-method: GET

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `get_traffic`
token	✅	string	Authentication token
id	✅	int	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,
"data": [
{
"ip": "1.2.3.4",
"volume": 50.5,
"updated": "2023-10-01",
"billed": 1,
"direction": "out"
}
]
}

Failure response

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

```

eq/get_upgrade_key¶

Returns a key to perform an upgrade operation, linked to a specific invoice (invoice_id).

HTTP-method: POST|GET

Parameters:

Parameter	Required	Type	Description
action	✅	string	Action name
token	✅	string	Authorization token
id	❌	int	Server ID (used for permission check)
invoice_id	✅	int	Invoice ID to which the upgrade is linked

Example Request

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

Example of a successful response

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

Failure response

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

```

eq/getserversforannounce¶

Returns a list of available servers (type Server) in rent or power_off status that have passed IP announcement limit checks for the current user/sub-account.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Action 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": "255.255.254.0",
"mask_24": "255.255.255.0"
}
]
}

Failure response

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

```

eq/groups¶

Returns the list of groups for a specific server.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `groups`
token	✅	string	Authorization token
id	✅	integer	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¶

Sends a request for a forced server shutdown (Hard Off).

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `hard_off`
token	✅	string	Authorization token
id	✅	int	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>`	Event type filter
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 available servers and hardware with support for advanced search by various parameters (location, status, type, IP, MAC, etc.).

HTTP-method: POST|GET

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `list` or `search`
token	❌	string	Authorization token
id	❌	int[]	Server ID filter. Accepts multiple values: `id[]=1&id[]=2`
group	❌	string[]	Hardware group filter. Accepts multiple values: `group[]=1CPU&group[]=2CPU`
location	❌	string[]	Location filter (e.g., US-East, EU-Central). Accepts multiple values: `location[]=US-East&location[]=EU-Central`
status	❌	string[]	Status filter. Accepts multiple values: `status[]=rented&status[]=power_off`
type	❌	string[]	Hardware type (server, switch, etc.). Accepts multiple values: `type[]=server&type[]=switch`
ip	❌	string[]	IP address filter. Accepts multiple values: `ip[]=1.2.3.4&ip[]=5.6.7.8`
email	❌	string[]	Owner email filter. Accepts multiple values: `email[][email protected]&email[][email protected]`
full	❌	boolean	Return full information (for administrators)
mac	❌	string[]	MAC address filter
account_id	❌	int[]	Billing account ID filter

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=list" \
--data "id[]=123" \
--data "location[]=US-East" \
--data "status[]=rented"

Example of a successful response

{
"result": "OK",
"servers": [
{
"id": 123,
"status": "rented",
"hostname": "server-01.hostkey.com",
"is_prebill": true,
"prebill_service_id": 456,
"prebill_rate": 10.5,
"prebill_period": "monthly",
"project_ids": [
1,
2
],
"mounted_iso": ""
}
]
}

Failure response

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

```

eq/off¶

Shuts down 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¶

Powers 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 a new server deployment from a preset or reinstallation of an existing server with OS, software, and network parameter selection.

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	Public SSH key
post_install_script	❌	string	Post-installation script
post_install_callback	❌	string	URL for callback notification
hostname	❌	string	Hostname
reinstall_key	❌	string	Reinstallation key
email	❌	string	User email
deploy_data	❌	string	Deployment data (e.g., client email)
deploy_options	❌	string	Deployment options (WHMCS location)
deploy_period	✅	string	Payment period (hourly, quarterly, semi-annually, annually)
deploy_notify	❌	integer	Notify about deployment (-1 - no, 0 - yes)
deploy_comment	❌	string	Deployment comment
own_os	❌	integer	Use own OS (0 or 1)
jenkins_task	❌	integer	Jenkins task ID
jenkins_tests	❌	integer	Jenkins tests (-1 - no)
traffic_plan	❌	integer	Traffic plan ID
disk_mirror	❌	string	Disk mirroring (0 or 1)
custom_domain	❌	string	Custom domain
vlan	❌	integer	Private VLAN ID
ipv4_amount	❌	integer	Number of IPv4 addresses (default 1)
no_lvm	❌	integer	Disable LVM (0 or 1)
imitate_deploy	❌	integer	Deployment simulation mode (0 - real, 1 - dry run)
imitate_error	❌	integer	Simulate error during deployment

Example Request

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

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": "Plesk Obsidian"
}

Failure response

``` { "code": -3, "message": "eq_reinstall_overdue" }

```

eq/ovirt_novnc¶

Requests the launch of an oVirt noVNC console for the specified server. Returns a callback key to track task execution.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `ovirt_novnc`
token	✅	string	Authorization token
id	✅	integer	Server ID
white_ip	❌	string	White IP for console access

Example Request

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

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. If the server is in rental mode, a notification will be sent to the client.

HTTP-method: POST

Parameters:

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

Example Request

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

Example of a successful response

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

Failure response

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

```

eq/reinstall¶

Starts the server reinstallation preparation process, creates an operation key, and notifies the client.

HTTP-method: POST

Parameters:

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

Example Request

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

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	✅	integer	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": "key_from_eq_del_ipmi_user"
}

Failure response

``` { "code": -1, "message": "action: error message" }

```

eq/request_backup_link¶

Requests a temporary link to download a server backup.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `request_backup_link`
token	✅	string	Authorization token
id	✅	integer	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"
--data "name=VALUE"

Example of a successful response

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

Failure response

``` { "code": -1, "message": "Request failed: error_message" }

```

eq/restore_backup¶

Starts the server restoration process from the specified backup. The method is asynchronous and returns a callback to track status.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `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=VALUE"
--data "name=VALUE"

Example of a successful response

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

Failure response

``` { "code": -1, "message": "Request failed: error_message" }

```

eq/search¶

Returns a list of available hardware based on various filters (group, location, status, type, IP, MAC, etc.).

HTTP-method: POST|GET

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `search`
group[]	❌	`array<string>`	Hardware groups (comma-separated)
dc	❌	int	Datacenter ID
location[]	❌	`array<string>`	Locations (comma-separated)
rack[]	❌	`int[]`	Rack ID
status[]	❌	`string[]`	Hardware statuses: rented, prepare_full, etc.
owner[]	❌	`string[]`	Owner (Hostkey, colo, etc.)
component[]	❌	`int[]`	Hardware component ID
type[]	❌	`string[] \| Type of hardware (server, switch, etc.). Accepts multiple values:`type[]=server&type[]=switch`
ip[]	❌	`string[]`	Search by IP address. Accepts multiple values: `ip[]=1.2.3.4&ip[]=5.6.7.8`
mac[]	❌	`string[]`	Search by MAC address
account_id[]	❌	`int[]`	Billing account ID filter
billing[]	❌	`string[]`	Billing region (en/us)
email[]	❌	`string[]`	Search by client email
id[]	❌	`int[]`	Hardware ID
token	✅	string	Authentication API token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=search" \
--data "token=HOSTKEY_TOKEN" \
--data "status[]=rented" \
--data "status[]=prepare_full" \
--data "type[]=server"

Example of a successful response

{
"result": "OK",
"module": "eq",
"action": "search",
"servers": [
{
"id": 123,
"status": "rented",
"hostname": "srv-01.hostkey.com",
"type": "Server",
"location": {
"dc_location": 1,
"rack_id": 564
},
"ip": [
{
"IP": "192.168.1.10",
"status": "active"
}
],
"project_ids": [],
"mounted_iso": "",
"ipmi_model": "none",
"is_prebill": false,
"prebill_service_id": null,
"prebill_rate": 0.0,
"prebill_rate_total": 0.0,
"prebill_period": "",
"tags": [],
"preset": ""
}
]
}

Failure response

``` { "code": -1, "message": "EQ/search: error message" }

```

eq/sensors¶

Returns current sensor readings (temperature, fan speed, etc.) for the specified server.

HTTP-method: POST|GET

Parameters:

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

Example Request

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

Example of a successful response

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

Failure response

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

```

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 information about the server, including hardware (hwconfig), operating system, IP addresses, interfaces, and IPMI.

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=VALUE"

Example of a successful response

{
"result": "OK",
"server_data": {},
"hardware": {},
"groups": [],
"licenses": [],
"reinstall": "",
"location": {},
"OS": {},
"IP": [],
"interfaces": [],
"IPMI": {
"model": "none",
"interfaces": []
},
"tags": [],
"preset": "",
"commitment": ""
}

Failure response

``` { "code": -1, "message": "Nothing found for [id]" }

```

eq/status¶

Returns the current server status (power_off, rent, repair, etc.).

HTTP-method: POST|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 POST \
--data "id=VALUE"

Example of a successful response

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

Failure response

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

```

eq/status_check¶

Returns the current hardware status via eq_status_check call.

HTTP-method: POST|GET

Parameters:

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

Example Request

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

Example of a successful response

{
"result": "OK",
"data": [
"User @admin changed [Hostkey RENT Server US NL] 'status' -> 'power_off' for [ticket-123] (no ticket) 5 days ago: manual change"
]
}

Failure response

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

```

eq/suspend¶

Requests suspension (suspend) or unsuspension (unsuspend) of a VPS server. Requires appropriate permissions and no administrator locks.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `suspend`
id	✅	int	Server ID for the operation
token	✅	string	Authorization token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=suspend" \
--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	Hardware (server) ID
new_limit	✅	int	New traffic limit in TB
token	✅	string	Authentication API 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",
"module": "eq",
"action": "traffic_add",
"invoice": 12345,
"status": "Unpaid"
}

Failure response

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

```

eq/unified_server_search¶

Unified search for servers 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¶

Requests an IPMI module reset for the specified server.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `unit_reset`
id	✅	int	Hardware/server ID
token	✅	string	Authorization token

Example Request

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

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 suspension (unsuspend) from a server.

HTTP-method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `unsuspend`
id	✅	integer	Server ID
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"