Skip to content

eq.php

Equipment 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 IPMI interface for a specific server. If the user already exists, returns their data.
add_ipmi_user add_ipmi_user Creates a new user for IPMI access. If the user is an administrator, the provided credentials are used.
announceip announceip Performs IP subnet announcement for the specified server with support for ASN and routing parameters.
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 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 the specified media (PXE or disk) depending on the boot mode.
check_backup_lock check_backup_lock Checks for an active lock for performing backup operations on the server.
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 performed asynchronously.
create_pxe create_pxe Creates a configuration for booting the server via network (PXE) specifying OS, disk, and network settings.
delete_backup delete_backup Deletes the specified server backup. Requires confirmation via callback.
deploy deploy Initiates the deployment process of an existing or new server by ID or preset. Supports various deployment modes, including OpenStack and Bare Metal.
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/power_off) matching IPv4 mask constraints that can be used for IP subnet announcement.
groups groups Returns a list of groups for the specified server
hard_off hard_off Sends a command for forced (hard) power-off of the hardware via IPMI/BMC.
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 Powers off the server.
on on Powers on the server.
order_instance order_instance Starts the process of ordering a new server or reinstalling an existing one (reinstall) with selection of OS, software, and traffic parameters.
reboot reboot Sends a request to reboot the hardware by the specified ID. If the server is in standby mode, authorization may be required.
reinstall reinstall Starts the server reinstallation preparation process, creating an operation key and notifying 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. The method is asynchronous and returns a callback to track task execution.
restore_backup restore_backup Starts the process of restoring the server from the specified backup. The operation is asynchronous.
search search Returns a list of available servers and presets based on given filters (group, location, status, type, IP, MAC, etc.)
sensors sensors Returns sensor status data for the specified server (temperature, RPM, etc.)
show show Returns detailed information about the server, including hardware configuration, operating system, IP addresses, and interfaces
status status Returns the current server status (power_off, rent, TT, etc.) and related data.
suspend suspend Requests suspension (suspend) or unsuspension (unsuspend) of a VPS/server. Requires permission check and may lock the server in case of an error.
unified_server_search unified_server_search Unified search for servers by query.
unit_reset unit_reset Requests an IPMI settings reset for the specified server.
unsuspend unsuspend Unlocks the server (unsuspend) 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 billing data (WHMCS). Returns server IDs, deploy keys, and prebill order 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 ✅ integer Hardware (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": "uabc123",
"password": "secure_password_example"
}
Failure response

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

```

eq/add_ipmi_user

Creates a new user for IPMI access. 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 Authorization token
id ✅ integer Server ID
admin_user ❌ string Administrator name (if applicable)
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" \
--data "admin_user=admin" \
--data "admin_pass=password"
Example of a successful response 
{
"result": "OK",
"action": "add_ipmi_user",
"callback": "string"
}
Failure response

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

```

eq/announceip

Performs IP subnet announcement for the specified server with support for ASN and routing parameters.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: announceip
id ✅ integer Hardware (server) ID
subnet ❌ string IP subnet for announcement
server ❌ string Server identifier
subnetaddr ❌ string Address in the subnet
subnetaddrmask ❌ string Subnet address mask
asn ❌ string|boolean Autonomous system number (can pass 'own')
ownasn ❌ boolean Use own ASN
annonce ❌ boolean Announcement flag
return ❌ boolean Return execution result
route ❌ string Announcement route
cmnt ❌ string Operation 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 "subnet=192.168.1.0/24" \
--data "asn=own" \
--data "token=YOUR_TOKEN"
Example of a successful response 
{
"result": "OK",
"action": "announceip"
}
Failure response

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

```

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 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": -2, "message": "EQ: action required" }

```

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
token ✅ string Authorization token
id ✅ integer Hardware (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": -2, "message": "EQ: action 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 the specified media (PXE or disk) depending on the boot mode.

HTTP-method: POST

Parameters:

Parameter Required Type Description
token ✅ string Authorization token
id ✅ integer Server ID
media ✅ string Bootable media type (e.g., iso, pxe)
boot_mode ❌ string Boot mode: auto (automatic detection), uefi or legacy

Example Request

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

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

```

eq/check_backup_lock

Checks for an active lock for performing backup operations on the server.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: check_backup_lock
token ✅ string Authentication 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 current PXE configuration for the specified host.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: clear_pxe
token ✅ string Authorization token
id ✅ integer Server 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/console

Requests access to the server management console (VNC/NoVNC).

HTTP-method: POST

Parameters:

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

Creates a 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 Callback URL for notification
reinstall_key ❌ string Reinstallation key
email ❌ string User email
os_name ❌ string OS name (alias)
disk_mirror ❌ int 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 usage
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=123" \
--data "root_pass=password" \
--data "os_id=5"
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 confirmation via callback.

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=123" \
--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

Initiates the deployment process of an existing or new server by ID or preset. Supports various deployment modes, including OpenStack and Bare Metal.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: deploy
token ✅ string Authorization token
id ❌ integer Server ID for deployment
preset ❌ string Preset name (if ID is not specified)
location ❌ integer Location/datacenter ID
hostname ❌ string Hostname
root_pass ✅ string Root password (required for non-own OS)
os_id ❌ integer Operating system ID
ssh_key ❌ string SSH key
post_install_script ❌ string Post-installation script
post_install_callback ❌ string Callback URL for deployment completion
deploy_data ✅ string Billing data (invoice ID or email)
deploy_options ✅ string Billing/WHMCS location
deploy_period ❌ string Payment period (hourly, quarterly, semi-annually, annually)
deploy_notify ❌ integer Deployment notification (-1 - disable)
imitate_deploy ❌ integer Dry run mode (0 or 1)
own_os ❌ integer Use own OS (0 or 1)
jenkins_task ❌ integer Jenkins task ID
traffic_plan ❌ integer Traffic plan ID
disk_mirror ❌ string Disk mirroring (e.g., 1 or 2)
custom_domain ❌ string Custom domain
ipv4_amount ❌ integer Number of IPv4 addresses

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=deploy" \
--data "token=YOUR_TOKEN" \
--data "root_pass=YourStrongPassword123!" \
--data "deploy_data=INV-12345" \
--data "deploy_options=DC1"
Example of a successful response 
{
"result": "OK",
"action": "deploy",
"callback": "string",
"id": 123
}
Failure response

``` { "code": -1, "message": "Deploy init for server $id failed: error message" }

```

eq/get_ipmi

Returns the IP address and IPMI interface model for the specified server. May contain multiple interfaces.

HTTP-method: 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 GET \
--data "action=get_ipmi" \
--data "id=VALUE"
Example of a successful response 
{
"result": "OK",
"ipmi": [
{
"IP": "192.168.0.100",
"MAC": "00:1A:4C:B0:58:E7",
"vendor": "Dell iDRAC"
}
]
}
Failure response

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

```

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",
"traffic": [],
"id": 123
}
Failure response

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

```

eq/get_upgrade_key

Returns the upgrade key linked to a specific invoice via hardware tags.

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: get_upgrade_key
invoice_id ✅ int Invoice ID to find the upgrade key
token ✅ string Authentication API token

Example Request

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

``` { "code": -1, "message": "Request error for key" }

```

eq/getserversforannounce

Returns a list of available servers (rent/power_off) matching IPv4 mask constraints that can be used for IP subnet announcement.

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: getserversforannounce
token ✅ string Authorization token
server_id[] ❌ int[] Array of server IDs for filtering by subdocuments/subaccounts

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=getserversforannounce" \
--data "token=HOSTKEY_TOKEN"
--data "server_id[]=123" \
--data "server_id[]=456"
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/getserversforannounce: is disabled for this subaccount." }

```

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

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

```

eq/hard_off

Sends a command for forced (hard) power-off of the hardware via IPMI/BMC.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Action name
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=YOUR_TOKEN"
--data "id=12345"
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[] ❌ array<string> Filter by equipment groups. Accepts multiple values: group[]=1CPU&group[]=2CPU
location[] ❌ array<string> Filter by locations (e.g., NL, US-East). Accepts multiple values: location[]=NL&location[]=US-East
status[] ❌ array<string> Filter by statuses. Accepts multiple values: status[]=rent&status[]=power_off
type[] ❌ array<string> Equipment type (server, switch, etc.). Accepts multiple values: type[]=server&type[]=switch
ip[] ❌ array<string> Filter by IP address. Accepts multiple values: ip[]=1.2.3.4&ip[]=5.6.7.8
email[] ❌ array<string> Filter by owner email. Accepts multiple values: email[][email protected]&email[][email protected]
full ❌ boolean Return full information (for administrators)
mac[] ❌ array<string> Filter by MAC address
account_id[] ❌ array<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[]=NL" \
--data "status[]=rent"
Example of a successful response 
{
"result": "OK",
"servers": [
{
"id": 123,
"status": "rent",
"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

Powers 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

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 the process of ordering a new server or reinstalling an existing one (reinstall) with selection of OS, software, and traffic parameters.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: order_instance
id ❌ int Existing server ID (for reinstallation) or 0 for a new order
preset ❌ string Hardware preset ID
root_pass ✅ string Root password (must not contain @ or #)
os_template ❌ string OS template for deployment from template
soft_id ❌ int Additional software ID
ssh_key ❌ string Public SSH key
hostname ❌ string Hostname
vlan ❌ int Private VLAN ID
root_size ❌ int Root partition size (GB)
ipv4_amount ❌ int Number of IPv4 addresses
custom_domain ❌ string Custom domain
deploy_period ❌ string Payment period (hourly, quarterly, semi-annually, annually)
traffic_plan ❌ int Traffic plan ID
params[os_id] ❌ int Operating system ID
params[os_license_id] ❌ int OS license ID
params[post_install_script] ❌ string Post-installation script
params[deploy_ticket] ❌ string Kayako ticket ID to link to deployment
token ✅ string Authentication API token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=order_instance" \
--data "root_pass=MySecurePass123" \
--data "token=YOUR_API_TOKEN" \
--data "params[os_id]=1" \
--data "params[post_install_script]=apt-get update && apt-get upgrade -y"
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": "Reinstall init for server 123 failed: error message" }

```

eq/ovirt_novnc

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

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: ovirt_novnc
id ✅ integer Hardware 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": "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, authorization may be required.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: 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=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, creating an operation key and notifying the client.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Action (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
token ✅ string Authorization token
id ✅ integer Server ID

Example Request

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

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

```

Requests a temporary link to download a server backup. The method is asynchronous and returns a callback to track task execution.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Action name (request_backup_link)
token ✅ string Authorization token
id ✅ integer 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=12345" \
--data "name=my_backup_name"
Example of a successful response 
{
"result": "OK",
"action": "request_backup_link",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
Failure response

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

```

eq/restore_backup

Starts the process of restoring the server from the specified backup. The operation is asynchronous.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: restore_backup
token ✅ string Authorization token
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 "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 servers and presets based on given filters (group, location, status, type, IP, MAC, etc.)

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: search
token ✅ string Authorization token
id ❌ array<int> Server ID for filtering
group[] ❌ array<string> Accepts multiple values: group[]=1CPU&group[]=2CPU
dc[] ❌ array<int> Datacenter ID. Accepts multiple values: dc[]=1&dc[]=2
location[] ❌ array<string> Location code (NL, US-East, etc.). Accepts multiple values: location[]=NL&location[]=US-East
rack[] ❌ array<string> Rack ID. Accepts multiple values: rack[]=561&rack[]=564
status[] ❌ array<string> Server status (rented, prepare_full, etc.). Accepts multiple values: status[]=sale&status[]=presale
owner[] ❌ array<string> Owner. Accepts multiple values: owner[]=Hostkey&owner[]=colo
component[] ❌ array<int> Hardware component ID. Accepts multiple values: component[]=345&component[]=241
type[] ❌ array<string> Equipment type (server, switch, etc.). Accepts multiple values: type[]=server&type[]=switch
ip[] ❌ array<string> Search by IP. Accepts multiple values: ip[]=1.2.3.4&ip[]=5.6.7.8
mac[] ❌ array<string> Search by MAC address. Accepts multiple values: mac[]=00:11:22&mac[]=33:44:55
account_id[] ❌ array<int> Account ID in billing. Accepts multiple values: account_id[]=1&account_id[]=2
billing[] ❌ array<string> Billing region (en/us). Accepts multiple values: billing[]=en&billing[]=us
email[] ❌ array<string> Search by email. Accepts multiple values: email[][email protected]&email[][email protected]
name_client[] ❌ array<string> Search by client name. Accepts values: name_client[]=John&name_client[]=Doe
full ❌ boolean Return complete data (true/false)
kvm[] ❌ array<string> Filter by KVM availability. Accepts multiple values: kvm[]=1&kvm[]=0
serialNumber[] ❌ array<string> Search by serial number. Accepts multiple values: serialNumber[]=SN1&serialNumber[]=SN2
id[] ❌ array<int> Search by ID. Accepts multiple values: id[]=1&id[]=2

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=search" \
--data "token=YOUR_TOKEN" \
--data "status[]=sale" \
--data "status[]=presale" \
--data "location[]=US-East" \
--data "dc[]=1"
Example of a successful response 
{
"result": "OK",
"module": "eq",
"action": "search",
"servers": [
{
"id": 101,
"name_client": "John Doe",
"status": "rent",
"type": "Server",
"location": {
"dc_location": 1,
"rack_id": 564,
"rack_position": 10
},
"ip": [
{
"IP": "192.168.1.1",
"status": "active"
}
]
}
]
}
Failure response

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

```

eq/sensors

Returns sensor status data for the specified server (temperature, RPM, etc.)

HTTP-method: POST

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 configuration, operating system, IP addresses, and interfaces.

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" \
--data "token=HOSTKEY_TOKEN"
Example of a successful response 
{
"result": "OK",
"server_data": {
"id": 123,
"status": "active",
"owner": "[email protected]",
"type": "Server",
"Condition_Component": "rent",
"ip": [
{
"IP": "192.168.1.1",
"status": "active"
}
],
"os": {
"id": 5,
"name": "Ubuntu 22.04 LTS"
},
"location": {
"dc_location": 1,
"rack_id": 10,
"rack_position": 5
}
},
"hardware": {},
"groups": [],
"licenses": [],
"reinstall": "",
"IP": [
"192.168.1.1"
],
"interfaces": [
{
"id": 10,
"type": "eth0",
"mac": "00:1A:4B:3C:5D:6E",
"IsMain": true,
"upstream_id": null,
"Status": "",
"switch_owner": "",
"switch_model": ""
}
],
"IPMI": {
"model": "none",
"interfaces": []
},
"tags": [],
"preset": null,
"commitment": ""
}
Failure response

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

```

eq/status

Returns the current server status (power_off, rent, TT, etc.) and related data.

HTTP-method: POST

Parameters:

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

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=status" \
--data "token=YOUR_TOKEN" \
--data "id=12345"
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 equipment status (availability, state, etc.)

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 short_location] 'power_off' -> 'rent' for [ticket_id](link) 5 days ago: description"
]
}
Failure response

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

```

eq/suspend

Requests suspension (suspend) or unsuspension (unsuspend) of a VPS/server. Requires permission check and may lock the server in case of an error.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Action: suspend or unsuspend
token ✅ string Authorization token
id ✅ integer Server ID

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=suspend" \
--data "token=HOSTKEY_TOKEN"
--data "id=12345"
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" }

```

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",
"module": "eq",
"action": "unified_server_search",
"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 settings reset for the specified server.

HTTP-method: POST

Parameters:

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

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

```

eq/unsuspend

Unlocks the server (unsuspend) 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": "7bc29eb23fb1b879b21fce509597f07c" }

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