跳转至

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 a specific IP address for the server.
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 switching the server boot mode (PXE or disk) to use bootable media.
check_backup_lock check_backup_lock Checks if there is an active lock on performing backup operations for the specified server.
clear_pxe clear_pxe Clears the current PXE configuration for the specified host. If the hostname parameter is not provided, the server ID is used.
create_backup create_backup Initiates the backup creation process for the specified server. The operation is performed asynchronously.
create_pxe create_pxe Initiates the PXE configuration creation process for server reinstallation. Supports configuring hostname, SSH keys, and post-install scripts.
delete_backup delete_backup Deletes the specified server backup by its name.
deploy deploy Starts the deployment process of an existing server by its ID or from a preset. Supports OS selection, disk parameter configuration, SSH keys, and custom domains.
get_ipmi get_ipmi Returns a list of available IPMI interfaces for the specified server, including IP address and vendor model.
get_traffic get_traffic Returns IPv4 traffic usage data for the specified server.
getserversforannounce getserversforannounce Returns a list of available servers (status rent or power_off) matching IPv4 mask constraints, belonging to the current owner or their subaccount.
groups groups Returns a list of groups for the specified server.
hard_off hard_off Sends a request for a hard stop or reboot of the hardware via IPMI/OpenStack.
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 deployment process of a new server from a preset or reinstallation of an existing server with OS, software, and network parameter selection.
reboot reboot Sends a request to reboot the hardware. If the server is in standby mode, confirmation via callback may be required.
reinstall reinstall Starts the server reinstallation preparation process (PXE configuration creation). Returns an operation key and stage status.
remove_ipmi_user remove_ipmi_user Removes an additional IPMI user for the specified server.
request_backup_link request_backup_link Requests generation of a temporary link to download a server backup.
restore_backup restore_backup Starts the server restoration process from a specified backup. The operation is asynchronous and returns a callback for status tracking.
search search Returns a list of available servers and instances based on various filtering criteria (group, location, status, IP, MAC, type, etc.).
sensors sensors Returns current sensor readings (temperature, fan speed, etc.) for the specified server.
show show Returns detailed information about the server, including hardware (hwconfig), operating system, IP addresses, interfaces, and IPMI.
status status Returns the current equipment status, including state data (power_off, rent, etc.), hardware configuration, IP addresses, interfaces, and IPMI.
suspend suspend Requests suspension (suspend) or resumption (unsuspend) of server maintenance. Requires access rights and, in some cases, an administrator lock check.
unified_server_search unified_server_search Unified server search by query.
unit_reset unit_reset Requests a reset of the IPMI module for the specified server. If the request is successful, a callback key is returned to track the task.
unsuspend unsuspend Unlocks the server (unsuspend) if it was previously locked by an administrator.
update_servers update_servers Updates the list of available servers linked to the client account in WHMCS, including active, suspended, and pending payment services.

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 Action name (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

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 ✅ int Server ID
admin_user ❌ string Administrator name (if not specified, generated automatically)
admin_pass ❌ string Administrator password
token ✅ string API authentication 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

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 Administrator name (if applicable)
admin_pass ❌ string Administrator password
require_proxy_credentials ❌ boolean Use proxy credentials

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=secret" \
--data "require_proxy_credentials=true"
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 a specified subnet or a specific IP address for the server.

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: announceip
id ✅ integer Equipment (server) ID
subnet ❌ string Subnet for announcement
server ❌ boolean Flag to use the server as a source
subnetaddr ❌ string Subnet address
subnetaddrmask ❌ string Subnet mask
asn ❌ string|boolean ASN (can specify '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)
token ✅ string API authentication token

Example Request

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

``` { "code": -2, "message": "Authentication 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=123"
Example of a successful response 
{
"result": "OK",
"action": "backup_get_schedule",
"days": [0, 0, 0, 0, 0, 0, 0],
"time": "",
"timezone": ""
}
Failure response

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

```

eq/backup_list

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

HTTP-method: POST|GET

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|GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: backup_save_schedule
token ✅ string Authorization token
id ✅ integer Equipment (server) ID
backup_schedule ✅ array Array with backup schedule settings. Contains fields: days (0/1 array), time (string HH:mm), timezone (string)

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=backup_save_schedule" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "backup_schedule[0][days][]=1" \
--data "backup_schedule[0][days][]=3" \
--data "backup_schedule[0][time]=03:00" \
--data "backup_schedule[0][timezone]=Europe/London"
Example of a successful response 
{
"result": "OK",
"action": "backup_save_schedule"
}
Failure response

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

```

eq/boot_dev

Requests switching the server boot mode (PXE or disk) to use bootable media.

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: boot_dev
token ✅ string Authorization token
id ✅ integer Server ID
media ✅ string Bootable media type (e.g., iso, pxe)
boot_mode ❌ string Boot mode: auto (determined 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: invalid server id" }

```

eq/check_backup_lock

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

HTTP-method: POST

Parameters:

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

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=check_backup_lock" \
--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. If the hostname parameter is not provided, the server ID is used.

HTTP-method: POST

Parameters:

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

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 the launch of the server management console via IPMI/NoVNC.

HTTP-method: POST

Parameters:

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

Example Request

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

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

```

eq/create_backup

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

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: create_backup
id ✅ int 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": "Error during backup creation" }

```

eq/create_pxe

Initiates the PXE configuration creation process for server reinstallation. Supports configuring hostname, SSH keys, and post-install scripts.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: create_pxe
id ✅ int Server ID
root_pass ✅ string Root password
os_id ✅ int Operating system ID
hostname ❌ string Hostname
ssh_key ❌ string SSH public key
post_install_script ❌ string Post-install script
post_install_callback ❌ string URL for callback notification
email ❌ string User email
os_name ❌ string OS name (alias)
disk_mirror ❌ int Disk mirroring
activate_windows ❌ int Windows activation (0/1)
uefi ❌ int UEFI boot mode (0/1/-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 ❌ 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 "id=VALUE" \
--data "root_pass=VALUE" \
--data "os_id=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 by its name.

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

```

eq/deploy

Starts the deployment process of an existing server by its ID or from a preset. Supports OS selection, disk parameter configuration, SSH keys, and custom domains.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: deploy
token ✅ string Authorization token
id ❌ integer Specific server ID for deployment. If not specified, a preset is used.
preset ❌ string Preset name or ID for deploying a new instance
location ✅ integer Location (datacenter) ID
hostname ❌ string Hostname for the server
root_pass ✅ string Root password (minimum 8 characters)
os_id ❌ integer Operating system ID to install
ssh_key ❌ string Public SSH key
post_install_script ❌ string Post-install script
post_install_callback ❌ string Callback URL after deployment completion
deploy_data ✅ string Billing data (invoice ID or email)
deploy_options ✅ string Billing/location options
deploy_price ❌ number Deployment price
deploy_period ❌ string Payment period (hourly, quarterly, semi-annually, annually)
deploy_notify ❌ integer Notify client about deployment (-1 - no, 0 - yes)
imitate_deploy ❌ integer Simulation mode (dry run) (1 - enabled)
custom_domain ❌ string Custom domain for the server
ipv4_amount ❌ integer Number of IPv4 addresses
no_lvm ❌ integer Disable LVM (0 or 1)

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=deploy" \
--data "token=YOUR_TOKEN" \
--data "location=1" \
--data "root_pass=SecurePassword123!" \
--data "deploy_data=INV-12345" \
--data "deploy_options=some_option_value"
Example of a successful response 
{
"result": "OK",
"action": "deploy",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
Failure response

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

```

eq/get_ipmi

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

HTTP-method: GET

Parameters:

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

Example Request

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

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

```

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 ✅ 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": [
{
"ip": "1.2.3.4",
"volume": 50.5,
"updated": "2023-10-01",
"billed": 1,
"direction": "out"
}
]
}
Failure response

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

```

eq/get_upgrade_key

Returns an upgrade key for the server, linked to a specific invoice via tags.

HTTP-method: POST|GET

Parameters:

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

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

```

eq/getserversforannounce

Returns a list of available servers (status rent or power_off) matching IPv4 mask constraints, belonging to the current owner or their subaccount.

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: getserversforannounce
token ✅ string Authorization token
subaccount ❌ mixed Subaccount data or flag to use subaccount data
server_id[] ❌ int[] Array of server IDs for filtering (if provided)

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 ✅ integer 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": []
}
Failure response

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

```

eq/hard_off

Sends a request for a hard stop or reboot of the hardware via IPMI/OpenStack.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Action name (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=YOUR_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 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 admins)
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": "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

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

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: order_instance
token ✅ string Authorization token
id ❌ integer Existing server ID (for reinstallation)
preset ✅ string Preset ID or name for deploying a new instance
root_pass ✅ string Root password (must not contain @ or #)
os_template ❌ string OS template for deployment from template
soft_id ❌ integer Additional software ID
ssh_key ❌ string Public SSH key
post_install_script ❌ string Post-install script
post_install_callback ❌ string URL for callback notification
hostname ❌ string Hostname
reinstall_key ❌ string Reinstallation key
email ❌ string User email
deploy_data ❌ string Deployment data (e.g., client email)
deploy_options ❌ string Deployment options (WHMCS location)
deploy_period ✅ string Payment period (hourly, quarterly, semi-annually, annually)
deploy_notify ❌ integer Notify about deployment (-1 - no, 0 - yes)
deploy_comment ❌ string Deployment comment
own_os ❌ integer Use own OS (0 or 1)
jenkins_task ❌ integer Jenkins task ID
jenkins_tests ❌ integer Jenkins tests (-1 - no)
traffic_plan ❌ integer Traffic plan ID
disk_mirror ❌ string Disk mirroring (0 or 1)
custom_domain ❌ string Custom domain
vlan ❌ integer Private VLAN ID
ipv4_amount ❌ integer Number of IPv4 addresses (default is 1)
no_lvm ❌ integer Disable LVM (0 or 1)
imitate_deploy ❌ integer Deployment simulation mode (0 - real, 1 - dry run)
imitate_error ❌ integer Simulate error during deployment

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=order_instance" \
--data "token=HOSTKEY_TOKEN" \
--data "preset=VALUE" \
--data "root_pass=VALUE" \
--data "deploy_period=VALUE"
Example of a successful response 
{
"result": "OK",
"action": "order_instance",
"callback": "7bc29eb23fb1b879b21fce509597f07c",
"deploy_status": "install",
"id": 123,
"os_name": "Ubuntu 22.04 LTS",
"soft_name": "Plesk Obsidian"
}
Failure response

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

```

eq/ovirt_novnc

Requests the launch of a noVNC console for the server via the oVirt interface. Requires access rights to the server.

HTTP-method: POST

Parameters:

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

Example Request

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

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

```

eq/reboot

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

HTTP-method: POST

Parameters:

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

Example Request

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

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

```

eq/reinstall

Starts the server reinstallation preparation process (PXE configuration creation). Returns an operation key and stage status.

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=VALUE"
Example of a successful response 
{
"result": "OK",
"action": "reinstall",
"stage": "create_pxe",
"callback": "string"
}
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": "key_from_eq_del_ipmi_user"
}
Failure response

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

```

Requests 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 Authentication token
id ✅ integer Equipment (server) ID
name ❌ string Backup name for the request

Example Request

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

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

```

eq/restore_backup

Starts the server restoration process from a specified backup. The operation is asynchronous and returns a callback for status tracking.

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

```

eq/search

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

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
params[group] ❌ array<string> Accepts multiple values: group[]=1CPU&group[]=2CPU
params[dc] ❌ array<int> Datacenter ID
params[location] ❌ array<string> Location code (US-East, NL, etc.)
params[rack] ❌ array<string> Rack ID
params[status] ❌ array<string> Server status (rented, prepare_full, etc.)
params[owner] ❌ array<string> Equipment owner
params[component] ❌ array<int> Hardware component ID
params[type] ❌ array<string> Equipment type (server, switch, etc.)
params[ip] ❌ array<string> Search by IP address
params[mac] ❌ array<string> Search by MAC address
params[account_id] ❌ array<int> Account ID in billing
params[billing] ❌ array<string> Billing region (en/us)
params[email] ❌ array<string> Search by client email
params[name_client] ❌ array<string> Client name
params[full] ❌ boolean Return full data (for admins)
params[kvm] ❌ boolean Filter by KVM availability
params[serialNumber] ❌ array<string> Search by serial number
params[id] ❌ array<int> Equipment ID filter
token ✅ string API authentication token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "token=HOSTKEY_TOKEN" \
--data "params[group][]=1CPU" \
--data "params[group][]=2CPU" \
--data "params[status][]=rented" \
--data "params[ip][]=192.168.1.1"
Example of a successful response 
{
"result": "OK",
"servers": [
{
"id": 123,
"status": "rent",
"hostname": "srv-01.hostkey.com",
"location": {
"dc_location": 1,
"rack_id": 564
},
"ip": [
{
"IP": "192.168.1.1",
"status": "active"
}
],
"is_prebill": false,
"project_ids": [],
"mounted_iso": "",
"ipmi_model": "none",
"prebill_service_id": null,
"prebill_rate": 0.0,
"prebill_rate_total": 0.0,
"prebill_period": ""
}
]
}
Failure response

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

```

eq/sensors

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

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: sensors
id ✅ integer Server 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 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
action ✅ string Method identifier: show
id ✅ int Equipment ID
token ❌ string Authorization token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X GET \
--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": "Server",
"hostname": "srv-01",
"is_prebill": true,
"days_left": "",
"due_date": "",
"project_ids": [],
"prebill_service_id": 123,
"prebill_rate": 0.0,
"prebill_rate_total": 0.0,
"prebill_period": "monthly",
"name_client": "",
"last_backup": {
"date": "",
"size": ""
},
"server_contacts": "",
"sla_level": ""
},
"hardware": {
"components": [
{
"Type": "CPU",
"Count": 2,
"Cores": 8,
"model": "Intel Xeon E5-2690"
}
],
"ram": 32768,
"hdd": 1000
},
"groups": [
1,
2
],
"location": {
"rack_id": 5,
"dc_name": "Amsterdam",
"rack_position": -1,
"rack_name": "unknown",
"dc_location": -1,
"location_id": -1
},
"OS": {
"id": 10,
"name": "Ubuntu 22.04 LTS",
"active": 1
},
"IP": [
{
"IP": "192.168.1.10",
"status": "active",
"tags": []
}
],
"interfaces": [],
"IPMI": {
"model": "Dell iDRAC",
"interfaces": [],
"user": "",
"password": "",
"white_ip": "",
"ip_acl": "",
"rule_id": ""
},
"tags": [
{
"tag": "server_name",
"value": "web-srv"
}
],
"preset": null,
"commitment": "",
"licenses": [],
"reinstall": ""
}
Failure response

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

```

eq/status

Returns the current equipment status, including state data (power_off, rent, etc.), hardware configuration, IP addresses, interfaces, and IPMI.

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

Returns the current equipment status (availability, state, etc.) without requiring authorization.

HTTP-method: POST

Parameters:

Parameter Required Type Description
token ✅ string Token for verification (if required)

Example Request

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

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

```

eq/suspend

Requests suspension (suspend) or resumption (unsuspend) of server maintenance. Requires access rights and, in some cases, an administrator lock check to perform the operation.

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": "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
new_limit ✅ int New traffic limit (in TB)
id ✅ int Server ID
token ✅ string API authentication token

Example Request

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

Requests a reset of the IPMI module for the specified server. If the request is successful, a callback key is returned to track the task.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: unit_reset
id ✅ int 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 previously locked by an administrator.

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"

??? success "Example of a successful response

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