Ga naar inhoud

eq.php

Equipment Management Module (eq.php): API for server deployment, power management, IPMI, backups, searching, and retrieving detailed hardware configuration information.

API Methods

Method Action Description
abort_reinstall abort_reinstall 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 user with administrator privileges for IPMI management. If admin_user is specified, a user with the given name is created.
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 IP subnet announcement for the specified server with support for ASN and routing parameters.
backup_get_schedule backup_get_schedule Returns the current automatic backup schedule for the specified server.
backup_list backup_list Returns a list of available backups for the specified server (id).
backup_save_schedule backup_save_schedule Saves the configured backup schedule for the specified server.
boot_dev boot_dev Requests a server reboot to boot from the specified media (PXE or disk) in UEFI or Legacy mode.
check_backup_lock check_backup_lock Checks if the backup process is locked for the specified server. Returns a callback key for asynchronous operation.
clear_pxe clear_pxe Clears the PXE configuration for the specified host. If the full parameter is 1, the entire configuration is deleted; otherwise, only the platform is cleared.
create_backup create_backup Initiates the backup creation process for the specified server. The operation is performed asynchronously.
create_pxe create_pxe Requests the creation of a configuration for OS reinstallation via PXE. Supports configuring hostname, SSH keys, and post-install scripts.
delete_backup delete_backup Deletes the specified server backup. Requires execution through an asynchronous queue.
deploy deploy Starts the deployment process for a specific server by its ID or selects a suitable server from those available for the specified preset in the selected location.
get_ipmi get_ipmi Returns the IP address and IPMI interface model for the specified server. May contain multiple interfaces.
get_traffic get_traffic Returns IPv4 traffic usage data for the specified server.
getserversforannounce getserversforannounce Returns a list of available servers (status rent or power_off) that match IP subnet restrictions and user access rights.
groups groups Returns the list of groups for a specific server.
hard_off hard_off Sends a request for a forced server shutdown (Hard Stop). If the server is in OpenStack, a reboot is performed.
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 performs a reinstallation (reinstall) of an existing server with OS and additional software selection.
reboot reboot Sends a request to reboot the specified equipment via IPMI or system tools.
reinstall reinstall Starts the server reinstallation preparation process, creating a key to execute the operation.
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 operation is asynchronous and returns a callback to track status.
restore_backup restore_backup Starts the server restoration process from the specified backup. The operation is asynchronous.
search search Returns a list of available or active equipment based on various filters (group, location, status, IP, MAC, 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 configuration (hwconfig), current status, IP addresses, interfaces, and IPMI data.
status status Returns the current server status, state data, and associated tags.
suspend suspend Requests suspension (suspend) or unsuspension (unsuspend) of a VPS/server. Execution 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 server's IPMI controller. If the operation requires time, a callback is returned to track status.
unsuspend unsuspend Unsuspends a server if it was temporarily suspended by an administrator.
update_servers update_servers Updates the list of active and pending payment servers for the current user, synchronizing data with WHMCS billing.

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 ✅ int 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 user with administrator privileges for IPMI management. If admin_user is specified, a user with the given name is created.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: add_ipmi_admin
id ✅ integer Server ID
admin_user ❌ string Administrator name (if not specified, a random one is generated)
admin_pass ❌ string Administrator password
token ✅ string Authentication API token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=add_ipmi_admin" \
--data "id=VALUE" \
--data "token=HOSTKEY_TOKEN"
Example of a successful response 
{
"result": "OK",
"action": "add_ipmi_admin",
"user": "uabcde123",
"password": "secure_password_example"
}
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 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=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 IP subnet announcement for the specified server with support for ASN and routing parameters.

HTTP-method: POST

Parameters:

Parameter Required Type Description
id ✅ integer Equipment (server) ID
subnet ❌ string IP subnet to announce
server ❌ string Server name
subnetaddr ❌ string Address in the subnet
subnetaddrmask ❌ string Subnet address mask
asn ❌ string|boolean Autonomous System number (can be 'own')
ownasn ❌ string|boolean Use own ASN
annonce ❌ string|boolean Announcement flag
return ❌ string|boolean Return result
route ❌ string|boolean Route parameter
cmnt ❌ string Announcement comment
checkboxes ❌ boolean Data validity 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 "subnet=192.168.1.0/24" \
--data "asn=own" \
--data "token=YOUR_TOKEN"
Example of a successful response 
{
"result": "OK",
"action": "announceip"
}
Failure response

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

```

eq/backup_get_schedule

Returns the current automatic backup schedule for the specified server.

HTTP-method: GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: backup_get_schedule
token ✅ string 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",
"module": "eq",
"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 server (id).

HTTP-method: POST

Parameters:

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

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 ✅ int Equipment (server) ID
backup_schedule ❌ array Array with backup schedule settings. Contains keys: 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][]=2" \
--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": "EQ: action required" }

```

eq/boot_dev

Requests a server reboot to boot from the specified media (PXE or disk) in UEFI or Legacy mode.

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: boot_dev
token ✅ string Authorization token
id ✅ int Server ID
media ✅ string Boot media type (PXE or disk)
boot_mode ❌ string Boot mode (auto, uefi or legacy). If auto, it is determined automatically based on hardware configuration.

Example Request

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

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

```

eq/check_backup_lock

Checks if the backup process is locked for the specified server. Returns a callback key for asynchronous operation.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: check_backup_lock
id ✅ integer 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 PXE configuration for the specified host. If the full parameter is 1, the entire configuration is deleted; otherwise, only the platform is cleared.

HTTP-method: POST

Parameters:

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

Example Request

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

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

```

eq/console

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

HTTP-method: POST

Parameters:

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

Example Request

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

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

```

eq/create_backup

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

HTTP-method: POST

Parameters:

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

Example Request

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

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

```

eq/create_pxe

Requests the creation of a configuration for OS reinstallation via PXE. Supports configuring hostname, 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
hostname ❌ string Hostname
ssh_key ❌ string SSH public key
post_install_script ❌ string Post-installation script
post_install_callback ❌ string Callback URL for notification
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 No LVM (0/1)
custom_domain ❌ string Custom domain
manual_choice_dsk ❌ int manual_choice_dsk parameter (detected in code)

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

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

```

eq/delete_backup

Deletes the specified server backup. Requires execution through an asynchronous queue.

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

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

```

eq/deploy

Starts the deployment process for a specific server by its ID or selects a suitable server from those available for the specified preset in the selected location.

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 server is selected from the preset.
preset ❌ string Preset name or ID (if id is not specified)
location ✅ integer Location/datacenter ID
hostname ❌ string Desired hostname
root_pass ✅ string Root password (minimum 8 characters for non-own OS)
os_id ❌ integer Operating system ID
ssh_key ❌ string SSH public key
post_install_script ❌ string Post-installation script
post_install_callback ❌ string Callback URL for notification
deploy_data ✅ string Billing data (invoice ID or email)
deploy_options ✅ string Billing/location parameters
deploy_period ❌ string Payment period (hourly, quarterly, semi-annually, annually)
deploy_notify ❌ integer Notify client (-1 - no, 0 - yes)
deploy_price ❌ string Deployment price (for debugging/admins)
deploy_comment ❌ string Deployment comment
imitate_deploy ❌ integer Simulation mode (dry run) = 1
imitate_error ❌ integer Error simulation
own_os ❌ integer Use own OS (1 - yes)
activate_windows ❌ integer Windows activation (0/1)
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=YourStrongPassword123!" \
--data "deploy_data=INV-12345" \
--data "deploy_options=some_option_value"
Example of a successful response 
{
"result": "OK",
"action": "deploy",
"callback": "7bc29eb23fb1b879b21fce509597f07c",
"ticket": 12345
}
Failure response

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

```

eq/get_ipmi

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

HTTP-method: GET

Parameters:

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

Example Request

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

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

```

eq/get_traffic

Returns IPv4 traffic 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 the upgrade key linked to an 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",
"module": "eq",
"action": "get_upgrade_key",
"key": ""
}
Failure response

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

```

eq/getserversforannounce

Returns a list of available servers (status rent or power_off) that match IP subnet restrictions and user access rights.

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" \
--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": "Authentication required" }

```

eq/groups

Returns the list of groups for a specific server.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: groups
id ✅ integer Server ID

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=groups" \
--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 forced server shutdown (Hard Stop). If the server is in OpenStack, a reboot is performed.

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": "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, NL). Accepts multiple values: location[]=US&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" \
--data "status[]=rented"
Example of a successful response 
{
"result": "OK",
"servers": [
{
"id": 123,
"status": "rent",
"hostname": "srv-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 performs a reinstallation (reinstall) of an existing server with OS and additional software selection.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: order_instance
token ✅ string Authorization token
id ❌ integer 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 ❌ integer Additional software ID
ssh_key ❌ string SSH public key
post_install_script ❌ string Post-installation script
post_install_callback ❌ string Callback URL for installation completion
hostname ❌ string Hostname
vlan ❌ integer Private VLAN ID
root_size ❌ integer Root partition size (GB)
ipv4_amount ❌ integer Number of IPv4 addresses
custom_domain ❌ string Custom domain
traffic_plan ❌ integer Traffic plan ID
deploy_period ❌ string Payment period (hourly, quarterly, semi-annually, annually)
deploy_notify ❌ integer Deployment notification (-1 - off)
deploy_options ❌ string Admin deployment parameters (for admin edition)
deploy_data ❌ string Data for WHMCS/Billing

Example Request

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

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

```

eq/ovirt_novnc

Requests the launch of a NoVNC console for the server via oVirt. Returns a callback key for asynchronous execution.

HTTP-method: POST

Parameters:

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

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

```

eq/reboot

Sends a request to reboot the specified equipment via IPMI or system tools.

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=123"
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 key to execute the operation.

HTTP-method: POST

Parameters:

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

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
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
token ✅ string Authorization token
id ✅ integer Server ID

Example Request

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

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

```

Requests a temporary link to download a server backup. The operation is asynchronous and returns a callback to track status.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: request_backup_link
id ✅ int Server ID
name ❌ string Backup name (if applicable)

Example Request

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

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

```

eq/restore_backup

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

HTTP-method: POST

Parameters:

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

Example Request

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

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

```

eq/search

Returns a list of available or active equipment based on various filters (group, location, status, IP, MAC, etc.).

HTTP-method: POST|GET

Parameters:

Parameter Required Type Description
group[] ❌ array<string> Equipment groups (comma-separated)
dc[] ❌ array<int> Datacenter ID
location[] ❌ array<string> Location code (US, NL, etc.)
rack[] ❌ array<int> Rack ID
status[] ❌ array<string> Server status (rented, prepare_full, etc.)
owner[] ❌ array<string> Equipment owner
component[] ❌ array<int> Hardware component ID
type[] ❌ array<string> Equipment type (server, switch)
ip[] ❌ array<string> Search by IP address
mac[] ❌ array<string> Search by MAC address
account_id[] ❌ array<int> Account ID in billing
billing[] ❌ array<string> Billing region (en/us)
email[] ❌ array<string> Search by client email
id[] ❌ array<int> Equipment ID
token ✅ string Authentication API token

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "token=HOSTKEY_TOKEN" \
--data "group[]=group1" \
--data "status[]=rented" \
--data "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
},
"is_prebill": false,
"ipmi_model": "none",
"mounted_iso": "",
"project_ids": []
}
]
}
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|GET

Parameters:

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

Example Request

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

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

```

eq/set_pin

Sets a PIN code for operations.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: set_pin
token ✅ string Authorization token
new_pin ✅ string New PIN code (4-10 characters)
old_pin ❌ string Old PIN code
no_pin_req ❌ string Skip PIN check flag (true/false)

Example Request

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

eq/show

Returns detailed information about the server, including hardware configuration (hwconfig), current status, IP addresses, interfaces, and IPMI data.

HTTP-method: POST|GET

Parameters:

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

Example Request

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=show" \
--data "id=123"
Example of a successful response 
{
"result": "OK",
"server_data": {
"id": 123,
"status": "rent",
"Condition_Component": "power_off",
"owner": "[email protected]",
"type": "Server",
"hostname": "srv-01",
"ipmi": {
"model": "",
"interfaces": []
},
"os": {},
"IP": [],
"interfaces": [],
"tags": [],
"preset": null,
"commitment": ""
},
"hardware": {},
"groups": {
"groups": []
},
"licenses": [],
"reinstall": "",
"location": {
"rack_id": 123,
"dc_name": "Amsterdam",
"dc_location": -1,
"location_id": -1
}
}
Failure response

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

```

eq/status

Returns the current server status, state data, and associated tags.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: status
id ✅ int Equipment 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 (available for call 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 
{
"data": [
"User @admin changed [Hostkey PREPARE_FAST VPS US] 's status `PREPARE_FAST` -> `TT` for [ticket_id](link) (no ticket) 5 days ago: description"
]
}
Failure response

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

```

eq/suspend

Requests suspension (suspend) or unsuspension (unsuspend) of a VPS/server. Execution requires access rights and, in some cases, an administrator lock check.

HTTP-method: POST

Parameters:

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

Example Request

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

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

```

eq/traffic_add

Increases the outbound traffic limit for the server and creates a corresponding invoice in WHMCS.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: traffic_add
id ✅ int Server ID
new_limit ✅ int New traffic limit in TB
token ✅ string Authorization 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 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 server's IPMI controller. If the operation requires time, a callback is returned to track status.

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

Unsuspends a server if it was temporarily suspended 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"
--data "token=HOSTKEY_TOKEN"
Example of a successful response 
{
"result": "OK",
"action": "unsuspend",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
Failure response

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

```

eq/update_servers

Updates the list of active and pending payment servers for the current user, synchronizing data with WHMCS billing.

HTTP-method: POST

Parameters:

Parameter Required Type Description
action ✅ string Method identifier: update_servers
token ✅ string Authorization token
show_products ❌ int Show products flag (1 - show)
load_servers_only ❌ string Load only servers (true/false)

Example Request

``` curl -s "https://invapi.hostkey.com/eq.php" -X POST \ --

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