Skip to content

eq.php

Equipment Management Module (eq.php): API for server deployment, power management, IPMI, backups, and searching/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 IPMI interface for a specific server. 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, the provided credentials are used.
announceip announceip Performs announcement of the specified subnet for a server with a specific ASN.
backup_get_schedule backup_get_schedule Returns the current automatic backup schedule for the specified server.
backup_list backup_list Returns a list of available backups for the specified equipment (server).
backup_save_schedule backup_save_schedule Saves the configured backup schedule for the specified server.
boot_dev boot_dev Requests booting the server from a specified media type (PXE or disk) in UEFI or Legacy mode.
check_backup_lock check_backup_lock Checks for an active lock to perform operations with server backups.
clear_pxe clear_pxe Clears the current PXE configuration for the specified host.
create_backup create_backup Initiates the backup creation process for the specified server. The operation is executed asynchronously via a queue.
create_pxe create_pxe Creates a Preboot Execution Environment (PXE) configuration to install a selected OS on the server. Supports configuring hostname, SSH keys, and post-install scripts.
delete_backup delete_backup Deletes the specified server backup. The backup name is required.
deploy deploy Initiates the deployment process of a new server by ID or preset. Supports OS selection, hostname configuration, SSH keys, and disk parameters.
get_ipmi get_ipmi Returns the IP address and IPMI interface model for the specified server. May contain multiple interfaces.
get_traffic get_traffic Returns IPv4 traffic data for the specified server.
getserversforannounce getserversforannounce Returns a list of available servers (rent or power_off) that match IP subnet and mask constraints to perform the announcement procedure.
groups groups Returns a list of groups for the specified server.
hard_off hard_off Performs a forced shutdown of the server (Hard Off). If the server is in OpenStack, a forced reboot is performed.
history history Returns the server event history.
list list Returns a list of available servers and equipment with support for advanced search by various parameters (location, status, type, IP, MAC, etc.).
off off Turns off the server.
on on Turns on the server.
order_instance order_instance Starts the process of ordering a new server by preset or performs a reinstallation (reinstall) of an existing server with OS and additional software selection.
reboot reboot Sends a request to reboot the hardware. If the server is in standby mode, execution via IPMI may be required.
reinstall reinstall Creates a key to start the server reinstallation process and adds the task to the queue.
remove_ipmi_user remove_ipmi_user Deletes additional IPMI user accounts for the specified server.
request_backup_link request_backup_link Requests a temporary link to download a server backup.
restore_backup restore_backup Initiates the server restoration process from the specified backup. The method is asynchronous and returns a callback to track task execution.
search search Returns a list of available or active equipment based on various filters (group, location, status, IP, MAC, etc.).
sensors sensors Returns sensor status data 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, state data, and available management parameters.
suspend suspend Requests suspension (suspend) or unsuspension (unsuspend) of a VPS/server. Operation requires access rights and, in some cases, administrator lock checks.
unified_server_search unified_server_search Unified server search by query.
unit_reset unit_reset Request to reset the device via IPMI interface for the specified server.
unsuspend unsuspend Unsuspends a server if it was temporarily suspended.
update_servers update_servers Updates the list of active and pending payment servers for the current user, synchronizing them with WHMCS data.

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
token ✅ string Authorization token
id ✅ integer Server ID

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=abort_reinstall" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"
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 IPMI interface for a specific server. If the user already exists, returns their data.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: add_ipmi_admin
id ✅ int Equipment (server) ID
admin_user ❌ string IPMI administrator name
admin_pass ❌ string IPMI 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": "uabcde",
"password": "secure_password_123"
}
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, the provided credentials are used.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: add_ipmi_user
token ✅ string Authentication token
id ✅ int Equipment (server) ID
admin_user ❌ string IPMI administrator name
admin_pass ❌ string IPMI 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=VALUE"
Example of a successful response 
{
"result": "OK",
"action": "add_ipmi_user",
"callback": "string",
"user": "string",
"password": "string"
}
Failure response

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

```

eq/announceip

Performs announcement of the specified subnet for a server with a specific ASN.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: announceip
id ✅ integer Equipment/server ID
subnet ❌ string Subnet for announcement
server ❌ string Server (optional)
subnetaddr ❌ string Subnet address
subnetaddrmask ❌ string Subnet mask
asn ❌ string|boolean Autonomous System Number (ASN). If 'own', passed as false
ownasn ❌ string Flag to use own ASN
annonce ❌ boolean Announcement flag
return ❌ boolean Return result
route ❌ string 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 "checkboxes=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": "Ошибка выполнения операции анонсирования" }

```

eq/backup_get_schedule

Returns the current automatic backup schedule for the specified server.

HTTP-method: GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: backup_get_schedule
token ✅ string Authentication token
id ✅ integer Equipment (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 
{
"days": [0, 0, 0, 0, 0, 0, 0],
"time": "",
"timezone": ""
}
Failure response

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

```

eq/backup_list

Returns a list of available backups for the specified equipment (server).

HTTP-method: POST

Parameters:

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

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=backup_list" \
--data "token=HOSTKEY_TOKEN" \
--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 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 Server ID
backup_schedule ✅ array Array with 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": "Ошибка при сохранении расписания" }

```

eq/boot_dev

Requests booting the server from a specified media type (PXE or disk) in UEFI or Legacy 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 (e.g., pxe)
boot_mode ❌ string Boot mode: auto (detected automatically), 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 server backups.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: check_backup_lock
token ✅ string Authentication token
id ✅ integer Equipment (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": "Request failed" }

```

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 host.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: clear_pxe
token ✅ string Authentication token
id ✅ integer Server ID
hostname ❌ string Hostname for clearing PXE config

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

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

```

eq/console

Requests access to 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 executed asynchronously via a queue.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: create_backup
id ✅ int Equipment (server) ID for which the backup is being created
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-v4-string",
"traceKey": "uuid-v4-string"
}
Failure response

``` { "code": -1, "message": "Ошибка при инициации создания бэкапа" }

```

eq/create_pxe

Creates a Preboot Execution Environment (PXE) configuration to install a selected OS on the server. Supports configuring hostname, SSH keys, and post-install scripts.

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 Public SSH key
post_install_script ❌ string Post-install script
post_install_callback ❌ string Callback URL
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)
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 (0/1)

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

```

eq/delete_backup

Deletes the specified server backup. The backup name is required.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: delete_backup
token ✅ string Authorization token
id ✅ int Equipment (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=VALUE"
--data "name=VALUE"
Example of a successful response 
{
"result": "OK",
"module": "eq",
"action": "delete_backup",
"callback": "string"
}
Failure response

``` { "code": -1, "message": "Ошибка удаления бэкапа" }

```

eq/deploy

Initiates the deployment process of a new server by ID or preset. Supports OS selection, hostname configuration, SSH keys, and disk parameters.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: deploy
id ❌ int Specific server ID for deployment. If not specified, a preset is used.
preset ❌ string Hardware preset name or ID
location ✅ int Location (datacenter) ID
hostname ❌ string Desired hostname
root_pass ✅ string Root user password (minimum 8 characters)
os_id ✅ int Operating system ID for installation
ssh_key ❌ string Public SSH key
post_install_script ❌ string Script to execute after installation
post_install_callback ❌ string Callback URL after installation completion
root_size ❌ int Root partition size in GB
ipv4_amount ❌ int Number of IPv4 addresses
custom_domain ❌ string Custom domain for the server
deploy_data ✅ string Billing data (invoice ID or email)
deploy_options ✅ string Billing/location parameters
traffic_plan ❌ int Traffic plan ID
disk_mirror ❌ string Disk mirroring configuration (e.g., raid1)
deploy_period ❌ string Payment period (hourly, monthly, quarterly, semi-annually, annually)
imitate_deploy ❌ int Deployment simulation mode (1 - dry run)
token ✅ string Authentication API token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=deploy" \
--data "location=1" \
--data "root_pass=SecurePassword123!" \
--data "os_id=5" \
--data "deploy_data=INV-12345" \
--data "deploy_options=some_option" \
--data "token=YOUR_API_TOKEN"
Example of a successful response 
{
"result": "OK",
"action": "deploy",
"callback": "7bc29eb23fb1b879b21fce509597f07c",
"id": 567
}
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 contain multiple interfaces.

HTTP-method: POST|GET

Parameters:

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

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=get_ipmi" \
--data "id=VALUE"
Example of a successful response 
{
"result": "OK",
"ipmi": [
{
"IP": "192.168.0.100",
"MAC": "00:1A:4C:00:11:22",
"vendor": "Supermicro"
}
]
}
Failure response

``` { "code": -1, "message": "No IPMI interfaces found" }

```

eq/get_traffic

Returns IPv4 traffic data for the specified server.

HTTP-method: POST

Parameters:

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

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=get_traffic" \
--data "id=123"
Example of a successful response 
{
"result": "OK",
"module": "eq",
"action": "get_traffic",
"id": 123,
"traffic": []
}
Failure response

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

```

eq/get_upgrade_key

Returns the upgrade key linked to a specific invoice (invoice_id).

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: get_upgrade_key
token ✅ string Authorization token
id ❌ int Server ID
invoice_id ✅ int Invoice ID to find 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=VALUE"
Example of a successful response 
{
"result": "OK",
"module": "eq",
"action": "get_upgrade_key",
"key": ""
}
Failure response

``` { "code": -1, "message": "Ошибка запроса" }

```

eq/getserversforannounce

Returns a list of available servers (rent or power_off) that match IP subnet and mask constraints to perform the announcement procedure.

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 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 Equipment ID

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=groups" \
--data "token=HOSTKEY_TOKEN"
--data "id=VALUE"
Example of a successful response 
{
"result": "OK",
"groups": [
{
"tag": "example_group",
"value": "1"
}
]
}
Failure response

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

```

eq/hard_off

Performs a forced shutdown of theserver (Hard Off). If the server is in OpenStack, a forced reboot is performed.

HTTP-method: POST

Parameters:

Parameter Required Type Description
id ✅ integer 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": "hard_off",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
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 available servers and equipment 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[] Filter by server IDs. Accepts multiple values: id[]=1&id[]=2
group ❌ string[] Filter by equipment groups. Accepts multiple values: group[]=1CPU&group[]=2CPU
location ❌ string[] Filter by locations (e.g., US-East, NL). Accepts multiple values: location[]=US-East&location[]=NL
status ❌ string[] Filter by statuses. Accepts multiple values: status[]=rented&status[]=power_off
type ❌ string[] Equipment type (server, switch, etc.). Accepts multiple values: type[]=server&type[]=switch
ip ❌ string[] Filter by IP address. Accepts multiple values: ip[]=1.2.3.4&ip[]=5.6.7.8
email ❌ string[] Filter by owner email. Accepts multiple values: email[][email protected]&email[][email protected]
full ❌ boolean Return full information (for administrators)
mac ❌ string[] Filter by MAC address
account_id ❌ int[] Filter by Account ID (billing identity)

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

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 by preset or performs a reinstallation (reinstall) of an existing server with OS and additional software selection.

HTTP-method: POST

Parameters:

Parameter Required Type Description
id ❌ int Existing server ID for reinstallation. If not specified, a new instance is created by preset.
preset ❌ string Preset name or ID for ordering a new server.
root_pass ✅ string Root password. Must not contain @ or # characters.
os_template ❌ string OS template for deployment from template (for admins).
soft_id ❌ int Additional software ID.
ssh_key ❌ string Public SSH key.
post_install_script ❌ string Post-install script.
hostname ❌ string Hostname.
root_size ❌ int Root partition size (GB).
ipv4_amount ❌ int Number of IPv4 addresses.
vlan ❌ int Private VLAN ID.
custom_domain ❌ string Custom domain (checked for prohibited words).
deploy_period ❌ string Payment period (hourly, quarterly, semi-annually, annually).
traffic_plan ❌ int Traffic plan ID.
token ✅ string Authentication API token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "id=123" \
--data "preset=standard_vps" \
--data "root_pass=StrongPass123!" \
--data "token=YOUR_API_TOKEN"
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": -1, "message": "Reinstall init for server 123 failed: error message" }

```

eq/ovirt_novnc

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

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: ovirt_novnc
id ✅ integer Equipment (server) ID
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=VALUE"
Example of a successful response 
{
"result": "OK",
"action": "ovirt_novnc",
"callback": "key_from_eq_ovirt_novnc"
}
Failure response

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

```

eq/reboot

Sends a request to reboot the hardware. If the server is in standby mode, execution via IPMI may be required.

HTTP-method: POST

Parameters:

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

Creates a key to start the server reinstallation process and adds the task to the queue.

HTTP-method: POST

Parameters:

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

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 additional IPMI user accounts 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"
--data "token=HOSTKEY_TOKEN"
Example of a successful response 
{
"result": "OK",
"action": "remove_ipmi_user",
"callback": "key"
}
Failure response

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

```

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 Equipment (server) ID
name ❌ string Backup name

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": "Request failed: error_message" }

```

eq/restore_backup

Initiates the server restoration process from the specified backup. The method is asynchronous and returns a callback to track task execution.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: restore_backup
id ✅ int 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 "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_details" }

```

eq/search

Returns a list of available or active equipment based on various filters (group, location, status, IP, MAC, etc.).

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: search
group ❌ array<string> Filter by groups (e.g.: 1CPU, 2CPU)
dc ❌ array<int> Datacenter ID
location ❌ array<string> Location code (US-East, NL, etc.)
rack ❌ array<int> Rack ID
status ❌ array<string> Server status (rented, power_off, etc.)
owner ❌ array<string> Equipment owner
component ❌ array<int> Hardware component ID
type ❌ array<string> Equipment type (server, switch)
ip ❌ array<string> Filter by IP address
mac ❌ array<string> Filter by MAC address
account_id ❌ array<int> Billing Account ID
billing ❌ array<string> Billing region (en/us)
email ❌ array<string> Filter by client email
name_client ❌ array<string> Client name
full ❌ int|boolean Return complete data
kvm ❌ array<string> Filter by KVM
serialNumber ❌ array<string> Serial number
id ❌ array<int> Equipment ID filter
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 "group[]=1CPU" \
--data "group[]=2CPU" \
--data "status[]=rented" \
--data "ip[]=192.168.1.1"
Example of a successful response 
{
"result": "OK",
"servers": [
{
"id": 123,
"hostname": "srv-01.hostkey.com",
"status": "rented",
"ip": [],
"location": {},
"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": []
}
]
}
Failure response

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

```

eq/sensors

Returns sensor status data for the specified server.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: sensors
id ✅ int Equipment 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 Equipment 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",
"hostname": "srv-01.hostkey.com",
"owner": "[email protected]",
"Condition_Component": "power_off",
"ip": [
{
"IP": "192.168.1.1",
"status": "active"
}
],
"os": {
"id": 5,
"name": "Ubuntu 22.04 LTS"
},
"location": {
"dc_location": "NL",
"rack_id": 10,
"rack_position": 5
}
},
"hardware": {
"cpu": "Intel Xeon E-2388G",
"ram": "64GB",
"hdd": "2x960GB SSD"
},
"groups": [
{
"tag": "group1",
"value": "val"
}
],
"licenses": [],
"reinstall": null,
"IP": [
"192.168.1.1"
],
"interfaces": [
{
"id": 1,
"type": "eth0",
"mac": "AA:BB:CC:DD:EE:FF",
"IsMain": true,
"Status": "up"
}
],
"IPMI": {
"model": "Dell iDRAC 9",
"interfaces": []
},
"tags": [
{
"tag": "server_name",
"value": "my-server"
}
]
}
Failure response

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

```

eq/status

Returns the current server status, state data, and available management parameters.

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
id ✅ int Equipment 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 equipment status (availability/status check).

HTTP-method: POST

Parameters:

Parameter Required Type Description
token ✅ string Authentication token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "token=HOSTKEY_TOKEN"
Example of a successful response 
{
"result": "OK",
"data": [
"User @admin changed [Hostkey RENT Server US 123](https://host.com/admin/?eq:123)'s status `power_off` -> `rent` for [ticket-123](https://help.com/ticket-123) 5 days ago: manual change"
]
}
Failure response

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

```

eq/suspend

Requests suspension (suspend) or unsuspension (unsuspend) of a VPS/server. Operation requires access rights and, in some cases, administrator lock checks.

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 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": "\(module/\)action: invalid new_limit" }

```

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 device via IPMI interface for the specified server.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: unit_reset
id ✅ int Equipment/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": "7bc29eb23fb1b879b21fce509597f07c"
}
Failure response

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

```

eq/unsuspend

Unsuspends a server if it was temporarily suspended.

HTTP-method: POST

Parameters:

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

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=unsuspend" \
--data "id=VALUE"
--data "token=HOSTKEY_TOKEN"
Example of a successful response 
{
"result": "OK",
"action": "unsuspend",
"callback": "string"
}
Failure response

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

```

eq/update_servers

Updates the list of active and pending payment servers for the current user, synchronizing them with WHMCS data.

HTTP-method: POST

question_mark
Is there anything I can help you with?
question_mark
AI Assistant ×