Անցնել պարունակությանը

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 Creates a new IPMI administrative user for the specified equipment. If the user already exists, returns their credentials.
add_ipmi_user add_ipmi_user Creates a new IPMI user for the server. If the user is an administrator, appropriate permissions are required.
announceip announceip Performs the announcement procedure of the specified subnet range for the server.
backup_get_schedule backup_get_schedule Returns a list of scheduled backup tasks for the specified server.
backup_list backup_list Returns a list of available backups for the specified equipment (server).
backup_save_schedule backup_save_schedule Saves the configured automatic 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 selected mode.
check_backup_lock check_backup_lock Checks for an active lock for performing operations with server backups.
clear_pxe clear_pxe Clears the PXE configuration for the specified host. If the full parameter is 1, all content is deleted.
create_backup create_backup Initiates the backup creation process for the specified equipment. The operation is performed asynchronously.
create_pxe create_pxe Creates a PXE boot configuration for subsequent OS reinstallation on the server. Supports OS selection, hostname configuration, SSH keys, and post-install scripts.
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 disk parameters.
get_ipmi get_ipmi Returns a list of available IPMI interfaces of the server, including IP address and vendor model.
get_traffic get_traffic Returns IPv4 traffic data for the specified server.
getserversforannounce getserversforannounce Returns a list of available servers (type Server) in rent or power_off status that have passed subnet mask restriction checks and are available for IP address announcement.
groups groups Returns the list of groups for the specified server.
hard_off hard_off Sends a request for immediate (hard) power-off of the equipment via IPMI/controller.
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 selection of OS, software, and network parameters.
reboot reboot Sends a request to reboot the equipment by the specified ID. If the server is in standby mode, execution via IPMI may be required.
reinstall reinstall Starts the server reinstallation preparation process, creating a task key and notifying the client.
remove_ipmi_user remove_ipmi_user Deletes additional IPMI user accounts for the specified server.
request_backup_link request_backup_link Requests a temporary link to download a server backup. The method is asynchronous and returns a callback key.
restore_backup restore_backup Starts the server restoration process from an existing backup by backup name.
search search Returns a list of available servers and equipment matching the specified filters (group, location, status, type, IP, MAC, etc.).
sensors sensors Returns current sensor readings for the specified server (e.g., temperature or disk status).
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 and related data (IP, interfaces, IPMI, tags).
suspend suspend Requests suspension or unsuspension of a VPS/server. If the action is unsuspend, the server will be unblocked.
unified_server_search unified_server_search Unified search for servers by query.
unit_reset unit_reset Requests a reset operation for the IPMI interface of the specified server.
unsuspend unsuspend Request to unblock (unsuspend) a server. If the server was blocked by an administrator, the action is performed immediately.
update_servers update_servers Returns the current list of user servers, including data from WHMCS and deployment information.

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

Example Request

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

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

```

eq/add_ipmi_admin

Creates a new IPMI administrative user for the specified equipment. If the user already exists, returns their credentials.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: add_ipmi_admin
id ✅ integer Server/equipment ID
admin_user ❌ string Administrator name (if not specified, generated automatically)
admin_pass ❌ string Administrator password (if not specified, generated automatically)
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": "uabcde1",
"password": "SecurePassword123!"
}
Failure response

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

```

eq/add_ipmi_user

Creates a new IPMI user for the server. If the user is an administrator, appropriate permissions are required.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: add_ipmi_user
token ✅ string Authentication token
id ✅ integer Server ID
admin_user ❌ string Username (if administrative access is required)
admin_pass ❌ string IPMI administrator password

Example Request

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

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

```

eq/announceip

Performs the announcement procedure of the specified subnet range for the server.

HTTP-method: POST

Parameters:

Parameter Required Type Description
id ✅ integer Equipment/server ID
subnet ❌ string Subnet to announce
server ❌ boolean Server flag
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 result
route ❌ boolean Routing flag
cmnt ❌ string Announcement 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 "id=123" \
--data "checkboxes=true" \
--data "token=YOUR_TOKEN"
Example of a successful response 
{
"result": "OK",
"action": "announceip",
"servers": [
{
"id": 123,
"location": "NL",
"mask_24": "1.2.3.0/24",
"server_mask_23": "1.2.3.0/23"
}
]
}
Failure response

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

```

eq/backup_get_schedule

Returns a list of scheduled backup tasks for the specified server.

HTTP-method: GET

Parameters:

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

Parameters:

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

Example Request

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

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

```

eq/backup_save_schedule

Saves the configured automatic backup schedule for the specified server.

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: backup_save_schedule
token ✅ string Authorization token
id ✅ integer Equipment (server) ID
backup_schedule ✅ object Object with schedule settings: days (array), time (string), 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[days][]=monday" \
--data "backup_schedule[days][]=tuesday" \
--data "backup_schedule[time]=03:00" \
--data "backup_schedule[timezone]=Europe/Amsterdam"
Example of a successful response 
{
"result": "OK",
"module": "eq",
"action": "backup_save_schedule"
}
Failure response

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

```

eq/boot_dev

Requests a server reboot to boot from the specified media (PXE or disk) depending on the selected mode.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: boot_dev
token ✅ string Authorization token
id ✅ integer Server ID
media ✅ string Bootable media type
boot_mode ❌ string Boot mode (auto, uefi or legacy)

Example Request

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

``` { "code": -1, "message": "Bootable media change request failed: invalid server id" }

```

eq/check_backup_lock

Checks for an active lock for performing operations with server backups.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: check_backup_lock
token ✅ string Authentication 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": "unknown"
}
Failure response

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

```

eq/check_pin

Checks the PIN code for operations.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: check_pin
token ✅ string Authorization token
pin ✅ string PIN code for verification

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=check_pin" \
--data "token=HOSTKEY_TOKEN" \
--data "pin=VALUE"
Example of a successful response 
{
"result": "OK",
"action": "check_pin",
"callback": "pin_disabled"
}
Failure response 
{
"code": -1,
"message": "PIN validation failed"
}

eq/clear_pxe

Clears the PXE configuration for the specified host. If the full parameter is 1, all content is deleted.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: clear_pxe
token ✅ string Authentication token
id ✅ integer Server ID
hostname ❌ string Hostname 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",
"action": "clear_pxe",
"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 Method identifier: 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 "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 equipment. The operation is performed asynchronously.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: create_backup
id ✅ int Server/equipment ID for backup creation
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-example",
"traceKey": "uuid-string-example"
}
Failure response

``` { "code": -1, "message": "Error during backup creation or access denied" }

```

eq/create_pxe

Creates a PXE boot configuration for subsequent OS reinstallation on the server. Supports OS selection, hostname configuration, SSH keys, and post-install scripts.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: create_pxe
token ✅ string Authorization token
id ✅ int Server ID
root_pass ✅ string Root password
os_id ✅ int Operating system ID (Foreman ID)
hostname ❌ string Hostname
ssh_key ❌ string SSH public key
post_install_script ❌ string Post-install script
post_install_callback ❌ string URL for callback after completion
reinstall_key ❌ string Reinstallation key
email ❌ string User email
os_name ❌ string OS alias
disk_mirror ❌ int Disk mirroring (0 or 1)
activate_windows ❌ int Windows activation (0/1)
uefi ❌ int UEFI boot mode (0/-1/1)
attendedInstall ❌ string Automated installation attribute
root_size ❌ int Root partition size (GB)
deploy_ticket ❌ string Kayako ticket ID for admin version
ignore_duplicated_install ❌ int Ignore duplicate installations (for admins)
no_lvm ❌ int Disable LVM (0/1)
custom_domain ❌ string Custom domain
manual_choice_dsk ❌ int Manual disk selection (0/1)

Example Request

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

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

```

eq/delete_backup

Deletes the specified server backup. 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": "7bc29eb23fb1b879b21fce509597f07c"
}
Failure response

``` { "code": -1, "message": "Backup deletion error" }

```

eq/deploy

Starts the deployment process for the selected server or preset. Supports OS selection, hostname configuration, SSH keys, and disk parameters.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: deploy
token ✅ string Authorization token
id ❌ integer Specific server ID for deployment
preset ❌ string Preset name (if id is not specified)
location ✅ integer Location/datacenter ID
hostname ❌ string Hostname for the server
os_id ❌ integer Operating system ID
root_pass ✅ string Root password (minimum 8 characters)
ssh_key ❌ string SSH public key
post_install_script ❌ string Post-install script
post_install_callback ❌ string URL for callback notification
deploy_data ✅ string Billing data (invoice ID or email)
deploy_options ✅ string Deployment options (e.g., whmcs location)
deploy_price ❌ number Deployment price
deploy_period ✅ string Payment period (hourly, monthly, quarterly, semi-annually, annually)
imitate_deploy ❌ integer Simulation mode (dry run) (0 or 1)
imitate_error ❌ integer Deployment error simulation
own_os ❌ integer Use own OS (0 or 1)
activate_windows ❌ integer Windows activation (0/1)
os_activation_code ❌ string OS activation code
uefi ❌ integer UEFI boot mode (0 or 1)
attendedInstall ❌ integer Automated installation
jenkins_task ❌ integer Jenkins task ID
jenkins_tests ❌ integer Jenkins tests
traffic_plan ✅ integer Traffic plan ID
disk_mirror ❌ string Disk mirroring (RAID)
deploy_comment ❌ string Deployment comment
invoice_relid ❌ integer Related invoice ID
no_lvm ❌ integer Disable LVM (0 or 1)
ipv4_amount ✅ integer Number of IPv4 addresses
custom_domain ❌ string Custom domain

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=deploy" \
--data "token=YOUR_TOKEN" \
--data "location=1" \
--data "root_pass=SecurePassword123!" \
--data "deploy_data=INV-12345" \
--data "deploy_options=whmcs" \
--data "deploy_period=monthly" \
--data "traffic_plan=10" \
--data "ipv4_amount=1"
Example of a successful response 
{
"result": "OK",
"action": "deploy",
"callback": "key_value",
"ticket": "ticket_id"
}
Failure response

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

```

eq/get_ipmi

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

HTTP-method: GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: get_ipmi
id ✅ integer Equipment 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:00:01",
"vendor": "Supermicro"
}
]
}
Failure response

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

```

eq/get_traffic

Returns IPv4 traffic data for the specified server.

HTTP-method: POST|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": "EQ/get_traffic: invalid server id" }

```

eq/get_upgrade_key

Returns the upgrade key linked to a specific invoice (invoice_id), if a corresponding upgrade_key tag is found for it.

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: get_upgrade_key
token ✅ string Authorization token
invoice_id ✅ integer Invoice ID to search for 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": 0, "message": "EQ/get_upgrade_key: invalid invoice id or no upgrade key found" }

```

eq/getserversforannounce

Returns a list of available servers (type Server) in rent or power_off status that have passed subnet mask restriction checks and are available for IP address announcement.

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
action ✅ string Action name: getserversforannounce
token ❌ string Authorization token
subaccount ❌ mixed Subaccount ID or array of IDs to filter servers

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=getserversforannounce"
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 the 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 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": []
}
Failure response

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

```

eq/hard_off

Sends a request for immediate (hard) power-off of the equipment via IPMI/controller.

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=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 ❌ 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[]=rent&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's email. Accepts multiple values: email[][email protected]&email[][email protected]
full ❌ boolean Return full information (for administrators)
mac ❌ string[] Filter by MAC address
account_id ❌ int[] Filter by account ID (billing identity)

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=list" \
--data "id[]=123" \
--data "location[]=US-East" \
--data "status[]=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

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 selection of OS, software, and network parameters.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Action name (order_instance)
token ✅ string Authorization token
id ❌ integer Existing server ID (for reinstallation/reinstall)
preset ❌ string Preset ID or name for a new order
root_pass ✅ string Root password (must not contain @ or #)
os_template ❌ string OS template for deployment from a template
soft_id ❌ integer Additional software ID
ssh_key ❌ string SSH public 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., email or invoice ID)
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)
os_name ❌ string OS alias
deploy_ticket ❌ string Kayako ticket ID to link to deployment
imitate_error ❌ integer Error simulation (0 - no)
imitate_deploy ❌ integer Dry run mode (1 - yes)
own_os ❌ integer Use own OS (1 - yes)
jenkins_task ❌ integer Jenkins task ID
jenkins_tests ❌ integer Number of Jenkins tests
traffic_plan ❌ integer Traffic plan ID
disk_mirror ❌ string Disk mirroring (e.g., 1)
deploy_comment ❌ string Deployment comment
custom_domain ❌ string Custom domain
vlan ❌ integer Private VLAN ID
ipv4_amount ❌ integer Number of IPv4 addresses
no_lvm ❌ integer Do not use LVM (1 - yes)
promocode ❌ string Promocode

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=standard_ubuntu"
Example of a successful response 
{
"result": "OK",
"action": "order_instance",
"callback": "7bc29eb23fb1b879b21fce509597f07c",
"deploy_status": "install",
"id": 123,
"os_name": "Ubuntu 22.04 LTS",
"soft_name": "Plesk Obsidian"
}
Failure response

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

```

eq/ovirt_novnc

Requests the launch of a NoVNC console for a server in an oVirt environment. Requires authorization and equipment management permissions.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Action name (ovirt_novnc)
token ✅ string User authorization token
id ✅ integer Server ID
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 "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 equipment by the specified ID. If the server is in standby mode, execution via IPMI may be required.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: reboot
token ✅ string Authorization token
id ✅ integer 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, creating a task key and notifying the client.

HTTP-method: POST

Parameters:

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

Example Request

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

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

```

eq/remove_ipmi_user

Deletes additional IPMI user accounts for the specified server.

HTTP-method: POST

Parameters:

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

Example Request

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

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

```

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

HTTP-method: POST

Parameters:

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

Example Request

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

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

```

eq/restore_backup

Starts the server restoration process from an existing backup by backup name.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: restore_backup
id ✅ int Equipment (server) ID
name ✅ string Backup name for restoration

Example Request

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

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

```

eq/search

Returns a list of available servers and equipment matching the specified filters (group, location, status, type, IP, MAC, etc.).

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
params[group] ❌ array<string> Filter by group (e.g.: 1CPU, 2CPU)
params[location] ❌ array<string> Location code (e.g., US-East, NL)
params[rack] ❌ array<string> Rack ID
params[status] ❌ array<string> Server status (e.g.: sale, prepare_full)
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 (true/false)
params[kvm] ❌ array<string> Filter by KVM availability
params[serialNumber] ❌ array<string> Search by serial number
params[id] ❌ array<int> Filter by equipment ID
token ✅ string Authentication API token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "params[group][]=1CPU" \
--data "params[location][]=US-East" \
--data "token=HOSTKEY_TOKEN"
Example of a successful response 
{
"result": "OK",
"servers": [
{
"id": 123,
"name_server": "srv-01",
"owner": "Hostkey",
"status": "sale",
"billing": "en",
"type": "Server",
"location": "NL",
"ip": [
{
"IP": "1.2.3.4",
"Status": "active"
}
],
"project_ids": [],
"mounted_iso": "",
"is_prebill": false,
"prebill_service_id": null,
"prebill_rate": 0.0,
"prebill_period": ""
}
]
}
Failure response

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

```

eq/sensors

Returns current sensor readings for the specified server (e.g., temperature or disk status).

HTTP-method: POST

Parameters:

Parameter Required Type Description
id ✅ integer Server ID
action ❌ string Action (sensors)
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": "string"
}
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",
"hostname": "srv-01.hostkey.com",
"owner": "[email protected]",
"type": "Server",
"is_prebill": false,
"project_ids": [
1,
2
],
"days_left": "",
"due_date": "",
"server_contacts": null,
"sla_level": null,
"last_backup": {
"date": "string",
"size": "string"
},
"prebill_service_id": null,
"name_client": "string"
},
"hardware": {
"cpu": "Intel Xeon E5-2680 v4",
"ram": "64GB",
"hdd": "2x960GB SSD"
},
"groups": [
{
"tag": "group_name",
"value": "premium"
}
],
"licenses": [],
"reinstall": "",
"location": {
"rack_id": 10,
"rack_position": 5,
"rack_name": "Rack-A",
"dc_name": "Amsterdam",
"dc_location": 2,
"location_id": 45
},
"OS": {
"id": 10,
"name": "Ubuntu 22.04 LTS",
"active": 1
},
"IP": [
{
"IP": "192.168.1.1",
"mac": "00:1A:2B:3C:4D:5E",
"type": "IPv4"
}
],
"interfaces": [
{
"id": 1,
"type": "eth0",
"mac": "00:1A:2B:3C:4D:5E",
"IsMain": true,
"Status": "up",
"port_of_virt_node": 0,
"tags": []
}
],
"IPMI": {
"model": "",
"interfaces": [],
"user": "",
"password": "",
"white_ip": "",
"ip_acl": "",
"rule_id": ""
},
"tags": [
{
"tag": "server_name",
"value": "my-server"
}
],
"preset": null,
"commitment": ""
}
Failure response

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

```

eq/status

Returns the current equipment status and related data (IP, interfaces, IPMI, tags).

HTTP-method: POST

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

```

eq/status_check

Returns the current equipment status (available for checking without authorization).

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: status_check
- - - No other parameters

Example Request

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

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

```

eq/suspend

Requests suspension or unsuspension of a VPS/server. If the action is unsuspend, the server will be unblocked.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: suspend or unsuspend
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 generates an invoice in WHMCS.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: traffic_add
token ❌ string Authorization token
id ✅ integer Server ID
new_limit ✅ integer New traffic limit (in TB)

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=traffic_add" \
--data "token=YOUR_TOKEN" \
--data "id=12345" \
--data "new_limit=2"
Example of a successful response 
{
"result": "OK",
"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 a reset operation for the IPMI interface of the specified server.

HTTP-method: POST

Parameters:

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

Example Request

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

Request to unblock (unsuspend) a server. If the server was blocked by an administrator, the action is performed immediately.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: unsuspend
id ✅ int
question_mark
Is there anything I can help you with?
question_mark
AI Assistant ×