Ga naar inhoud

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 Stops the server reinstallation process, removes associated tags (reinstall_start, autodeploy_start, autodeploy_timeout), and restores 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 Adds a new user to the IPMI management system for a specific server. If the user is an administrator, parameters may be overridden.
announceip announceip Performs announcement of a specified subnet or IP address via BGP. Supports permission checks and sub-account handling.
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 a server reboot to boot from the specified media (PXE or disk) depending on the boot mode.
check_backup_lock check_backup_lock Checks if there is an active lock on backup operations for the specified 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 Requests the creation of a PXE configuration for subsequent OS reinstallation on the server. Returns a callback to track the process.
delete_backup delete_backup Deletes the specified server backup. Requires execution of an asynchronous task.
deploy deploy Starts the deployment process for the selected server or preset. 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 (rent/power_off) user servers that match IPv4 mask restrictions (/23 and /24) which can be used for IP address announcement.
groups groups Returns the list of groups for a specific server.
hard_off hard_off Performs a forced (hard) power-off of the equipment by the specified ID.
history history Returns the server event history.
list list Returns a list of available equipment with filtering options by various parameters (location, status, type, etc.).
off off Powers off the server.
on on Powers on the server.
order_instance order_instance Starts the deployment process for a new server from a preset or reinstallation of an existing server with OS and additional software selection.
reboot reboot Sends a request to reboot the specified server. If the server belongs to a client, a lock (lock) is checked.
reinstall reinstall Creates a key to start the server reinstallation process and sets the initial stage (create_pxe).
remove_ipmi_user remove_ipmi_user Removes an additional IPMI user for the specified server.
request_backup_link request_backup_link Requests the generation of a temporary link to download a server backup.
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 instances based on various filtering criteria (location, status, type, IP, MAC, etc.).
sensors sensors Returns current sensor readings for the specified server.
show show Returns full data about the server, including hardware configuration (hwconfig), operating system, IP addresses, interfaces, and IPMI.
status status Returns the current equipment status (power_off, rent, TT, etc.) and related data.
suspend suspend Requests suspension (suspend) or unsuspension (unsuspend) of a VPS/server. If the action is suspend, the server will be locked.
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 lock (unsuspend) from a server. If the request is successful, the server will be unlocked.
update_servers update_servers Updates the list of available servers linked to the client account in WHMCS, including checking active services and prebill servers.

eq/abort_reinstall

Stops 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 ✅ int 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

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 Username (if empty, generated automatically)
admin_pass ❌ string Administrator password
token ✅ string Authentication API token

Example Request

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

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

```

eq/add_ipmi_user

Adds a new user to the IPMI management system for a specific server. If the user is an administrator, parameters may be overridden.

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 Username (if administrative access is required)
admin_pass ❌ string Password for administrative access

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 announcement of a specified subnet or IP address via BGP. Supports permission checks and sub-account handling.

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: announceip
token ❌ string Authorization token
id ✅ integer Server/object ID
subnet ❌ string Subnet for announcement
server ❌ string Server (boolean/string)
subnetaddr ❌ string Address in the subnet
subnetaddrmask ❌ string Subnet address mask
asn ❌ string Autonomous System number (can be 'own')
ownasn ❌ boolean Use own ASN
annonce ❌ boolean Announcement flag
return ❌ boolean Return result
route ❌ boolean Routing flag
cmnt ❌ string Announcement comment
checkboxes ❌ boolean Terms confirmation (ASRegistered, RKPIValid, SubNetNotSpamhaus, DataIsCorrect)

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=announceip" \
--data "id=123" \
--data "subnet=1.2.3.0/24" \
--data "asn=own"
Example of a successful response 
{
"result": "OK",
"module": "eq",
"action": "announceip"
}
Failure response

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

```

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 Authorization token
id ✅ int 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 
{
"result": "OK",
"module": "eq",
"action": "backup_get_schedule",
"days": [0, 0, 0, 0, 0, 0, 0],
"time": "",
"timezone": ""
}
Failure response

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

```

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

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=backup_list" \
--data "id=VALUE"
Example of a successful response 
{
"result": "OK",
"module": "eq",
"action": "backup_list",
"data": [
{
"bucket_name": "example-bucket",
"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 of 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": "Request execution error" }

```

eq/boot_dev

Requests a server reboot to boot from the specified media (PXE or disk) depending on the 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 Boot media type
boot_mode ❌ string Boot mode (auto, uefi or legacy). If auto, it is determined automatically based on hardware configuration.

Example Request

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

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

```

eq/check_backup_lock

Checks if there is an active lock on backup operations for the specified server.

HTTP-method: POST

Parameters:

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

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

```

eq/create_backup

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

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: create_backup
id ✅ integer Equipment (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": "Request execution error" }

```

eq/create_pxe

Requests the creation of a PXE configuration for subsequent OS reinstallation on the server. Returns a callback to track the process.

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
ssh_key ❌ string SSH key
post_install_script ❌ string Post-installation script
post_install_callback ❌ string Callback URL for script completion
hostname ✅ string Hostname
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)
attendedInstall ❌ string Attended installation
root_size ❌ int Root partition size
deploy_ticket ❌ string Kayako ticket ID
ignore_duplicated_install ❌ int Ignore duplicate installations
no_lvm ❌ string Disable LVM
custom_domain ❌ string Custom domain
manual_choice_dsk ❌ int Manual disk selection

Example Request

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

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

```

eq/delete_backup

Deletes the specified server backup. Requires execution of an asynchronous task.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: delete_backup
token ✅ string Authorization token
id ✅ integer 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": "Error during backup deletion" }

```

eq/deploy

Starts the deployment process for the selected server or preset. 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, the preset is used.
preset ❌ string Preset name for deploying a new server
location ✅ integer Location (datacenter) ID
hostname ❌ string Desired hostname
os_id ✅ integer Operating system ID to install
root_pass ✅ string Root password (minimum 8 characters)
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 Invoice data (WHMCS ID or email)
deploy_options ✅ string Deployment parameters (e.g., billing type)
traffic_plan ❌ integer Traffic plan ID
ipv4_amount ❌ integer Number of IPv4 addresses
custom_domain ❌ string Custom domain for the server

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=deploy" \
--data "token=YOUR_TOKEN" \
--data "location=1" \
--data "os_id=5" \
--data "root_pass=StrongPassword123!" \
--data "deploy_data=INV-12345" \
--data "deploy_options=billing_type=auto"
Example of a successful response 
{
"result": "OK",
"action": "deploy",
"callback": "7bc29eb23fb1b879b21fce509597f07c",
"ticket": "123456"
}
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: 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.1.100",
"MAC": "00:1A:4C:B3:00:01",
"vendor": "Supermicro"
}
]
}
Failure response

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

```

eq/get_traffic

Returns IPv4 traffic usage data for the specified server.

HTTP-method: POST|GET

Parameters:

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

Example Request

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

``` { "code": -1, "message": "\(module/\)action: 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 Method identifier: get_upgrade_key
token ✅ string Authorization token
invoice_id ✅ int Invoice ID to get 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",
"action": "get_upgrade_key",
"key": ""
}
Failure response

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

```

eq/getserversforannounce

Returns a list of available (rent/power_off) user servers that match IPv4 mask restrictions (/23 and /24), which can be used for IP address announcement.

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: getserversforannounce
token ✅ string Authentication API token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=getserversforannounce" \
--data "token=HOSTKEY_TOKEN"
Example of a successful response 
{
"result": "OK",
"module": "eq",
"action": "getserversforannounce",
"servers": [
{
"id": 123,
"location": "NL",
"mask_23": "1.2.3.0/23",
"mask_24": "1.2.3.0/24"
}
]
}
Failure response

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

```

eq/groups

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

```

eq/hard_off

Performs a forced (hard) power-off of the equipment by the specified ID.

HTTP-method: POST

Parameters:

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

Example Request

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

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

```

eq/history

Returns the server event history.

HTTP-method: POST

Parameters:

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

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=history" \
--data "id=VALUE" \
--data "token=HOSTKEY_TOKEN" \
--data "type[]=ACTION" \
--data "type[]=ERROR" \
--data "date_from=2023-10-01" \
--data "date_to=2023-10-31"
Example of a successful response 
{
"result": "OK",
"module": "eq",
"action": "history",
"id": 12345,
"history": [
{
"id": 1,
"date": "2023-10-01 12:00:00",
"message": "Server rebooted",
"type": "ACTION"
}
]
}
Failure response 
{
"code": 400,
"message": "Invalid server id"
}

eq/list

Returns a list of available equipment with filtering options by various parameters (location, status, type, etc.).

HTTP-method: GET|POST

Parameters:

Parameter Required Type Description
action ✅ string Action name (list)
token ✅ string Authorization token
group[] ❌ string[] Equipment groups
dc[] ❌ int[] Datacenter ID
location[] ❌ string[] Location code (NL, etc.)
rack[] ❌ int[] Rack ID
status[] ❌ string[] Server status (rented, prepare_full, etc.)
owner[] ❌ string[] Equipment owner
component[] ❌ int[] Hardware component ID
type[] ❌ string[] Equipment type (server, switch, etc.)
ip[] ❌ string[] IP address
mac[] ❌ string[] MAC address
account_id[] ❌ int[] Billing account ID
billing[] ❌ string[] Billing region (en/ru)
email[] ❌ string[] User email
id[] ❌ int[] Equipment ID
full ❌ boolean Return full data (for admins)
kvm ❌ string KVM parameters
serialNumber ❌ string Serial number

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X GET \
--data "action=list" \
--data "token=HOSTKEY_TOKEN" \
--data "status[]=rented" \
--data "location[]=NL"
Example of a successful response 
{
"result": "OK",
"servers": [
{
"id": 123,
"status": "rent",
"hostname": "srv-01.hostkey.com",
"ip": [
"1.2.3.4"
],
"is_prebill": false,
"project_ids": [],
"is_owner": "Colocation"
}
]
}
Failure response

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

```

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 deployment process for a new server from a preset or reinstallation of an existing server with OS and additional software selection.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: order_instance
token ✅ string Authorization token
id ❌ int 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 ❌ int Additional software ID
os_id ❌ int Operating system ID
ssh_key ❌ string Public SSH key
post_install_script ❌ string Post-installation script
hostname ❌ string Hostname
root_size ❌ int Root partition size (GB)
email ❌ string Email for notifications/deployment
deploy_period ❌ string Payment period (hourly, quarterly, semi-annually, annually)
ipv4_amount ❌ int Number of IPv4 addresses
custom_domain ❌ string Custom domain
vlan ❌ int Private VLAN ID
deploy_data ❌ string Deployment data (for admin)
deploy_options ❌ string Deployment options (for admin)
traffic_plan ❌ int Traffic plan ID

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=order_instance" \
--data "token=YOUR_TOKEN" \
--data "root_pass=SecurePass123!" \
--data "preset=ubuntu-docker-preset"
Example of a successful response 
{
"result": "OK",
"action": "order_instance",
"callback": "7bc29eb23fb1b879b21fce509597f07c",
"deploy_status": "install",
"id": 123,
"os_name": "Ubuntu 22.04",
"soft_name": "Docker"
}
Failure response

``` { "code": -1, "message": "Reinstall init for server 123 failed: error message" }

```

eq/ovirt_novnc

Requests the launch of a NoVNC console for the server via the oVirt interface. Requires access permissions to the server.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: ovirt_novnc
id ✅ int 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"
--data "token=HOSTKEY_TOKEN"
Example of a successful response 
{
"result": "OK",
"action": "ovirt_novnc",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
Failure response

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

```

eq/reboot

Sends a request to reboot the specified server. If the server belongs to a client, a lock (lock) is checked.

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=VALUE"
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 sets the initial stage (create_pxe).

HTTP-method: POST

Parameters:

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

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--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

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

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

```

Requests the generation of 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 for the 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": "string"
}
Failure response

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

```

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": "Restore request failed: error_details" }

```

eq/search

Returns a list of available servers and instances based on various filtering criteria (location, status, type, IP, MAC, etc.).

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: search
group[] ❌ array<string> Equipment groups
dc[] ❌ array<int> Datacenter ID
location[] ❌ array<string> Location code (NL, etc.)
rack[] ❌ array<int> Rack ID
status[] ❌ array<string> Server status (rented, prepare_full, etc.)
owner[] ❌ array<string> Equipment owner
component[] ❌ array<int> Hardware component ID
type[] ❌ array<string> Equipment type (server, switch, etc.)
ip[] ❌ array<string> Search by IP address
mac[] ❌ array<string> Search by MAC address
account_id[] ❌ array<int> Billing account ID
billing[] ❌ array<string> Billing region (en/ru)
email[] ❌ array<string> Search by client email
id[] ❌ array<int> Search by Equipment ID
full ❌ boolean Return full data (for admins)
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 "location[]=NL" \
--data "status[]=rented"
Example of a successful response 
{
"result": "OK",
"servers": [
{
"id": 123,
"status": "rented",
"location": "NL",
"hostname": "srv-01.hostkey.com",
"is_prebill": true
}
]
}
Failure response

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

```

eq/sensors

Returns current sensor readings 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": "EQ/sensors: invalid server id" }

```

eq/set_pin

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

HTTP-method: POST|GET

Parameters:

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

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=show" \
--data "id=123"
Example of a successful response 
{
"result": "OK",
"server_data": {
"id": 123,
"status": "rent",
"Condition_Component": "power_on",
"owner": "[email protected]",
"type_billing": "Server",
"hostname": "srv-01.example.com"
},
"hardware": {
"cpu": "Intel Xeon E5-2680",
"ram": 64,
"hdd": 1000,
"components": []
},
"groups": [
{
"tag": "group_name",
"value": "val"
}
],
"location": {
"rack_id": 5,
"dc_location": 10,
"dc_name": "Amsterdam"
},
"OS": {
"id": 312,
"name": "Ubuntu 22.04 LTS",
"active": 1
},
"IP": [
{
"IP": "192.168.1.1",
"status": "active"
}
],
"interfaces": [],
"IPMI": {
"model": "Dell iDRAC",
"interfaces": []
},
"tags": [
{
"tag": "server_name",
"value": "my-server"
}
],
"reinstall": "",
"licenses": [],
"preset": null,
"commitment": ""
}
Failure response

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

```

eq/status

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

HTTP-method: POST|GET

Parameters:

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

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=status" \
--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

Performs a check of the current equipment state (eq_status_check).

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: status_check
token ✅ string Authentication token
id ✅ int Server ID

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=status_check" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Example of a successful response 
{
"result": "OK",
"data": [
"string (status change message)"
]
}
Failure response

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

```

eq/suspend

Requests suspension (suspend) or unsuspension (unsuspend) of a VPS/server. If the action is suspend, the server will be locked.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: suspend
id ✅ int Server ID
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": "\(module/\)action: invalid server id" }

```

eq/traffic_add

Increases the outbound traffic limit for the server and generates an invoice in WHMCS.

HTTP-method: POST|GET

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 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 Equipment ID
token ❌ string Authorization token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=unit_reset" \
--data "id=VALUE"
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 a lock (unsuspend) from a server. If the request is successful, the server will be unlocked.

HTTP-method: POST

Parameters:

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

Example Request

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

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

```

eq/update_servers

Updates the list of available servers linked to the client account in WHMCS, including checking active services and prebill servers.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: update_servers
token ✅ string Authorization token
show_products ❌ int Show products flag
load_servers_only ❌ string Filter: only servers (true)

Example Request

``` curl -s "https://invapi.hostkey.com/eq

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