Saltar a contenido

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 user with administrator privileges for management via IPMI. If the user already exists, returns their data.
add_ipmi_user add IPMI user Adds a new user or administrator to the server's IPMI management system. If admin_user is specified, an account with administrator privileges is created.
announceip announce IP subnet Performs announcement of the specified subnet or specific IP address for the server via BGP.
backup_get_schedule get backup schedule Returns a list of scheduled backup tasks for the specified server.
backup_list get backup list Returns a list of available backups for the specified server.
backup_save_schedule save backup schedule Saves the configured backup schedule for the specified server.
boot_dev boot from media Request to boot the server from specific media (PXE or disk) depending on the selected mode.
check_backup_lock check backup lock Checks for an active lock on backup operations for the specified server.
clear_pxe clear PXE configuration 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 via a task queue.
create_pxe create PXE configuration for reinstallation Prepares the configuration for OS installation via PXE. Includes setting boot parameters, SSH keys, and post-install scripts.
delete_backup delete backup Deletes the specified server backup. Requires access rights to the server.
deploy deploy server Starts the deployment process of selected equipment or a preset based on provided configuration parameters.
get_ipmi get IPMI interfaces Returns a list of available IPMI interfaces for the server, including their IP addresses and vendor model.
get_traffic get traffic data Returns IPv4 traffic usage data for the specified server.
getserversforannounce get servers for announcement Returns a list of active (rent, power_off) user servers that have passed subnet mask limit validation (/23 and /24).
groups get groups Returns a list of groups for the specified server.
hard_off hard off server Sends a request for forced (hard) shutdown of equipment by the specified ID.
history history Returns the server event history.
list list Returns a list of equipment based on various search criteria.
off off Turns off the server.
on on Turns on the server.
order_instance order instance Starts the process of ordering a new server or reinstalling an existing one (reinstall) with selection of OS, software, and network parameters.
reboot reboot server Sends a request to reboot the equipment by the specified ID. If the request is successful, a callback is returned for task tracking.
reinstall initialize reinstallation Creates a key for the server reinstallation process and prepares the PXE configuration stage.
remove_ipmi_user remove IPMI user Removes additional IPMI user accounts for the specified server.
request_backup_link request backup link Requests generation of a temporary link to download a server backup.
restore_backup restore from backup Starts the process of restoring the server from the specified backup. The operation is asynchronous and returns a callback for status tracking.
search search equipment Returns a list of available equipment (servers, VPS, etc.) based on specified filters. Supports searching by ID, IP, MAC address, owner, location, type, and other parameters.
sensors get sensor data Returns current sensor readings for the specified server.
show get server data Returns full server data, including hardware configuration (hardware), operating system, IP addresses, interfaces, and IPMI.
status get equipment status Returns the current server status and its state via IPMI/console.
suspend suspend server Requests suspension (suspend) or unsuspension (unsuspend) of a VPS/server. Requires access rights and lock checks.
unified_server_search unified server search Unified search for servers by query.
unit_reset reset IPMI module Requests an IPMI reset for the specified server.
unsuspend unsuspend server Request to remove a lock (unsuspend) from the server. If the request is successful, the server will be unlocked.
update_servers update servers list Updates the list of active and pending deployment servers for the user, including pre-billing data and deploy keys.

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 ✅ 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 user with administrator privileges for management via IPMI. If the user already exists, returns their data.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: add_ipmi_admin
token ✅ string Authorization token
id ✅ integer Server ID
admin_user ❌ string Administrator name (if not specified, generated automatically)
admin_pass ❌ string Administrator password (if not specified, generated automatically)

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=add_ipmi_admin" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345" \
--data "admin_user=my_admin" \
--data "admin_pass=MySecretPass!"
Example of a successful response 
{
"result": "OK",
"action": "add_ipmi_admin",
"user": "uabcde",
"password": "SecurePassword123!"
}
Failure response

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

```

eq/add_ipmi_user

Adds a new user or administrator to the server's IPMI management system. If admin_user is specified, an account with administrator privileges is created.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Action (add_ipmi_user or add_ipmi_admin)
token ✅ string Authorization token
id ✅ integer Server ID
admin_user ❌ string Administrator name (if applicable)
admin_pass ❌ string Administrator password

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=add_ipmi_user" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345" \
--data "admin_user=new_admin" \
--data "admin_pass=secure_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 the specified subnet or specific IP address for the server via BGP.

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
id ✅ integer Equipment (server) ID
subnet ❌ string Subnet for announcement
server ❌ boolean Announce as a server address
subnetaddr ❌ string Address in the subnet
subnetaddrmask ❌ string Subnet mask
asn ❌ string|boolean Autonomous system number (or 'own')
ownasn ❌ boolean Use own ASN
annonce ❌ boolean Announcement flag
return ❌ boolean Return execution result
cmnt ❌ string Operation comment
route ✅ string route parameter (required for validation)
checkboxes ✅ boolean Checkbox verification result (ASRegistered, RKPIValid, SubNetNotSpamhaus, DataIsCorrect)
token ✅ string API authentication token

Example Request

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

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

```

eq/backup_get_schedule

Returns 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",
"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 server.

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: backup_list
id ✅ int Equipment (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 (days, time, timezone)

Example Request

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

``` { "code": -1, "message": "Error saving schedule" }

```

eq/boot_dev

Request to boot the server from specific media (PXE or disk) depending on the selected mode.

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: boot_dev
token ✅ string Authorization token
id ✅ int Server ID
media ✅ string Bootable media type
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: error_details" }

```

eq/check_backup_lock

Checks for 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 ✅ integer Equipment (server) ID

Example Request

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

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

```

eq/check_pin

Checks the PIN code for operations.

HTTP-method: POST

Parameters:

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

Example Request

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

eq/clear_pxe

Clears the current PXE configuration for the specified host.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: clear_pxe
token ✅ string Authorization token
id ✅ integer Server ID
hostname ❌ string Hostname to clear

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=clear_pxe" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Example of a successful response 
{
"result": "OK",
"callback": "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 via a task queue.

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" \
--data "token=HOSTKEY_TOKEN"
Example of a successful response 
{
"result": "OK",
"module": "eq",
"action": "create_backup",
"callback": "7bc29eb23fb1b879b21fce509597f07c",
"traceKey": "550e8400-e29b-41d4-a716-446655440000"
}
Failure response

``` { "code": -1, "message": "Access denied or invalid server id" }

```

eq/create_pxe

Prepares the configuration for OS installation via PXE. Includes setting boot parameters, 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
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
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"
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 access rights to the server.

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=12345" \
--data "name=my_backup_name"
Example of a successful response 
{
"result": "OK",
"module": "eq",
"action": "delete_backup",
"callback": "string"
}
Failure response

``` { "code": -1, "message": "Error deleting backup or insufficient access rights" }

```

eq/deploy

Starts the deployment process of selected equipment or a preset based on provided configuration parameters.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: deploy
token ❌ string Authorization token
id ✅ integer Server or preset ID
preset ❌ string Preset name for deployment
location ❌ integer Location (datacenter) ID
hostname ❌ string Hostname for the server
root_pass ✅ string Root password
os_id ❌ integer Operating system ID
ssh_key ❌ string SSH public key
post_install_script ❌ string Post-install script
post_install_callback ❌ string Callback URL
deploy_data ✅ string Billing/invoice data
deploy_options ✅ string Deployment options (e.g., WHMCS location)
os_name ❌ string OS name
deploy_period ❌ string Payment period (hourly, quarterly, semi-annually, annually)
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 "id=123" \
--data "root_pass=MySecurePassword123!" \
--data "deploy_data=some_billing_data" \
--data "deploy_options=location_whmcs_value"
Example of a successful response 
{
"result": "OK",
"action": "deploy",
"callback": "7bc29eb23fb1b879b21fce509597f07c",
"ticket": 12345,
"id": 101
}
Failure response

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

```

eq/get_ipmi

Returns a list of available IPMI interfaces for the server, including their IP addresses 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",
"action": "get_ipmi",
"ipmi": [
{
"IP": "192.168.1.100",
"MAC": "00:1A:4C:00:11:22",
"vendor": "Supermicro"
}
]
}
Failure response

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

```

eq/get_traffic

Returns IPv4 traffic usage data for the specified server.

HTTP-method: 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 GET \
--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": "in"
}
]
}
Failure response

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

```

eq/get_upgrade_key

Returns an upgrade key (upgrade_key) linked to a specific invoice via equipment tags.

HTTP-method: POST|GET

Parameters:

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

Example Request

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

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

```

eq/getserversforannounce

Returns a list of active (rent, power_off) user servers that have passed subnet mask limit validation (/23 and /24).

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: getserversforannounce
token ❌ string Authorization token

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": "1.2.3.0/23",
"mask_24": "1.2.3.0/24"
}
]
}
Failure response

``` { "result": -2, "error": "EQ: action required" }

```

eq/groups

Returns a list of groups for the specified server.

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
action ✅ string Action name: 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/groups: invalid server id" }

```

eq/hard_off

Sends a request for forced (hard) shutdown of 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 equipment based on various search criteria.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: list
token ✅ string Authorization token
group ❌ string Equipment group
dc ❌ string Data center
location ❌ string Location
rack ❌ string Rack
status ❌ string Status
owner ❌ string Owner
component ❌ string Component
type ❌ string Equipment type
ip ❌ string IP address
mac ❌ string MAC address
account_id ❌ string Account ID
billing ❌ string Billing
email ❌ ❌ Email
name_client ❌ string Client name
full ❌ int Full information
kvm ❌ string KVM
serialNumber ❌ string Serial number
id ❌ string ID

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=list" \
--data "token=HOSTKEY_TOKEN"
Example of a successful response 
{
"result": "OK",
"servers": [
{
"id": 123,
"name": "Server 1",
"status": "rent",
"location": "NL",
"project_ids": [
1,
2
]
}
]
}
Failure response 
{
"code": -1,
"message": "invalid request"
}

eq/off

Turns off the server.

HTTP-method: POST

Parameters:

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

Example Request

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

eq/on

Turns on the server.

HTTP-method: POST

Parameters:

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

Example Request

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

eq/order_instance

Starts the process of ordering a new server or reinstalling an existing one (reinstall) with selection of OS, software, and network parameters.

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
ssh_key ❌ string User SSH key
post_install_script ❌ string Post-install 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
vlan ❌ int Private VLAN ID
custom_domain ❌ string Custom domain
traffic_plan ❌ int Traffic plan ID

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=order_instance" \
--data "token=HOSTKEY_TOKEN" \
--data "root_pass=SecurePass123!"
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 opening the NoVNC console for a server running on an oVirt hypervisor. Requires access rights to the server.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: ovirt_novnc
token ❌ string 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 "id=VALUE"
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 equipment by the specified ID. If the request is successful, a callback is returned for task tracking.

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

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

```

eq/reinstall

Creates a key for the server reinstallation process and prepares the PXE configuration stage.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Action: reinstall
token ✅ string Authorization token
id ✅ int Server ID

Example Request

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

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

```

eq/remove_ipmi_user

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

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

```

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 Authorization token
id ✅ int Equipment (server) ID
name ✅ string Backup name for link request

Example Request

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

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

```

eq/restore_backup

Starts the process of restoring the server from the 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
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": "Error executing restoration operation" }

```

eq/search

Returns a list of available equipment (servers, VPS, etc.) based on specified filters. Supports searching by ID, IP, MAC address, owner, location, type, and other parameters.

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
action ✅ string Action name (search)
token ❌ string Authorization token
id[] ❌ int[] Filter by server IDs
location ❌ string|int Location (code or ID)
status[] ❌ string[] Filter by status (e.g.: sale, presale, prepare_full, rent, power_off, TT)
type[] ❌ string[] Equipment type (server, switch, etc.)
ip[] ❌ string[] Search by IP address
email[] ❌ string[] Filter by client email
full ❌ boolean Return full server data (true/false)
mac[] ❌ string[] Search by MAC address
owner[] ❌ string[] Filter by owner (Hostkey, colo, etc.)

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=search" \
--data "token=YOUR_TOKEN" \
--data "status[]=sale" \
--data "status[]=rent" \
--data "id[]=123" \
--data "id[]=456"
Example of a successful response 
{
"result": "OK",
"servers": [
{
"id": 123,
"name_server": "example-host",
"owner": "Hostkey",
"status": "sale",
"type": "Server",
"location": "NL",
"is_prebill": false,
"project_ids": []
}
]
}
Failure response

```json { "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 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 full server data, including hardware configuration (hardware), 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",
"type": "Server",
"owner": "[email protected]",
"Condition_Component": "rent",
"hostname": "srv-01",
"is_prebill": false,
"days_left": "",
"due_date": "",
"project_ids": [],
"name_client": ""
},
"hardware": {
"cpu": 8,
"ram": 32,
"hdd": 500,
"components": [
{
"Type": "CPU",
"Count": 1,
"Cores": 8
}
]
},
"groups": [],
"location": {
"rack_id": 10,
"rack_position": 5,
"rack_name": "Rack-A",
"dc_name": "DataCenter-1",
"dc_location": 1,
"location_id": 1
},
"OS": {
"id": 312,
"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": "srv-01"
}
],
"preset": null,
"commitment": "",
"licenses": [],
"reinstall": ""
}
Failure response

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

```

eq/status

Returns the current server status and its state via IPMI/console.

HTTP-method: POST

Parameters:

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

Example Request

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

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

```

eq/status_check

Returns the current equipment status (availability, component state).

HTTP-method: POST|GET

Parameters:

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

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=status_check" \
--data "token=HOSTKEY_TOKEN"
Example of a successful response 
{
"result": "OK",
"data": [
"User @admin changed [Server Name]('https://host/admin/?eq:123')'s status `POWER_OFF` -> `RESERVE` for [Ticket #123](https://ticket.link) 5 days ago: description"
]
}
Failure response

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

```

eq/suspend

Requests suspension (suspend) or unsuspension (unsuspend) of a VPS/server. Requires access rights and lock checks.

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

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: traffic_add
id ✅ int Equipment (server) ID
new_limit ✅ int New traffic limit in TB
token ✅ string API authentication token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=traffic_add" \
--data "id=VALUE"
--data "new_limit=VALUE"
--data "token=HOSTKEY_TOKEN"
Example of a successful response 
{
"result": "OK",
"module": "eq",
"action": "traffic_add",
"invoice": 12345,
"status": "Unpaid"
}
Failure response

``` { "code": -1, "message": "EQ/traffic_add: invalid new_limit" }

```

Unified search for servers by query.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: unified_server_search
token ✅ string Authorization token
query ✅ string Search query (string or numeric ID)

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=unified_server_search" \
--data "token=HOSTKEY_TOKEN" \
--data "query=VALUE"
Example of a successful response 
{
"result": "OK",
"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 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": "7bc29eb23fb1b879b21fce509597f07c"
}
Failure response

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

```

eq/unsuspend

Request to remove a lock (unsuspend) from the server. If the request is successful, the server will be unlocked.

HTTP-method: POST

Parameters:

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

Example Request

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