Hostkey Cloud

List Hostkey account servers with filters. Before the first call, automatically refreshes inventory (eq/update_servers). Returns server IDs and brief data; use get_server for the full card.

Full server details by ID (eq/show): configuration, network, status, location.

Current server power status (on/off).

Hardware sensor readings (temperatures, voltages, fans). Bare-metal only.

All server tags (tags/list). Tags store arbitrary key-value pairs.

Search servers by tag name or value (tags/search_user). Returns server IDs.

Current list of available instant servers (VM/BM/GPU/vGPU) with prices for a location. No token required. Use to pick a preset before ordering.

Search free servers matching a preset name (e.g. vm.pico). Requires auth.

Prices for available presets in given currencies (presets/info). No token required.

Preset groups for catalog categories (presets/groups). No token required.

無需輸入參數。

Details for one preset or all presets (presets/show). May require auth depending on permissions.

Available stock servers (physical servers of standard configs; deploy within a business day). No token required.

Details for a specific stock server (stocks/show).

Operating systems available for a preset/server (os/list). Without instance_id returns OS for all presets. No token required.

Software (marketplace apps) available for auto-install (software/list). No token required.

Available traffic plans for a preset in a location (traffic_plans/list). No token required.

Current API token and account info (auth/info): available calls, account type and role, linked server IDs. Useful to verify the connection.

無需輸入參數。

End the current API session (auth/logout): session token is removed from InvAPI. On the next call the client will sign in again with the API key.

無需輸入參數。

List all account API keys (api_keys/list).

無需輸入參數。

List API keys issued for a specific server (api_keys/list_for_server).

Details for a specific API key (api_keys/view).

API key usage history for a period (api_keys/history).

Create a new API key for the account or a specific server (api_keys/add). The key value is shown once in the response — save it.

Update API key settings (api_keys/edit): name, IP allowlist, notifications, active flag.

Delete an API key (api_keys/delete). DESTRUCTIVE: apps using the key will lose access.

Server network interface status (net/get_status): port, switch, VLAN, speed, MAC, link status. Optional port limits the query to one interface (useful when another NIC has no upstream_id).

Port utilization graphs for a period (net/show_cacti): day/month/year.

Network interface information by IP address (ip/get_ip).

Current PTR record (reverse DNS) for an IP address (ip/get_ptr).

Enable a server network port (net/port_on).

Disable a server network port (net/port_off). DESTRUCTIVE: the server will lose network connectivity on this interface.

Block an IP address on the server at the Hostkey network level (net/block_ip). Useful for abuse requests.

Unblock an IP address on the server (net/unblock_ip).

Update the PTR record for an IP address (ip/update_ptr). Multiple records are passed separated by %0A.

Set the primary IP address of the server (ip/set_main) when there are multiple addresses.

List all DNS zones on the account on Hostkey PowerDNS servers (pdns/list_zones).

無需輸入參數。

DNS zone contents: all records (A, AAAA, CNAME, MX, TXT, etc.) from the authoritative server (pdns/view_zone).

List all user domains from the domains table (pdns/list_domains).

無需輸入參數。

List subdomains by server ID (pdns/list_subdomains).

Create a DNS zone and add a domain to the domains table (pdns/add_domain). Requires pdns/edit permission.

Delete a domain by ID: DNS zone, the domain itself, and all its subdomains (pdns/delete_domain). DESTRUCTIVE. Requires pdns/edit permission.

Add a subdomain to the subdomains table (pdns/add_subdomain). Requires pdns/edit permission.

Update a subdomain (pdns/edit_subdomain). Requires pdns/edit permission.

Delete a subdomain from the subdomains table (pdns/delete_subdomain). DESTRUCTIVE. Requires pdns/edit permission.

Create a DNS zone on the authoritative PowerDNS server (pdns/add_zone). Requires pdns/edit permission.

Delete a DNS zone by name along with all records and metadata (pdns/delete_zone). DESTRUCTIVE. Requires pdns/edit permission.

Add or update a DNS record in a zone (pdns/add_dns). Requires pdns/edit permission. For SRV records, fill in proto/priority/weight/port/target. Fields mname/rname are marked required for SOA checks in the docs — fill them in on error.

Delete a DNS record from a zone (pdns/delete_dns). DESTRUCTIVE. Requires pdns/edit permission.

List virtual machine snapshots (vm/get_snapshot): name, snapshot_id, date.

Virtualization engine information (vm/get_engine).

無需輸入參數。

Virtual machine statistics (vm/load_stats).

Create a virtual machine snapshot (vm/create_snapshot). Async operation. Track with check_task.

Delete a snapshot (vm/remove_snapshot). DESTRUCTIVE: the snapshot is permanently deleted. Deletion is only possible on a powered-off VM.

Restore a VM from a snapshot (vm/restore_snapshot). DESTRUCTIVE: the current VM disk state will be overwritten with the snapshot state.

Access the server VNC console (eq/console): returns console.vv config in Base64 for virt-viewer.

Start a NoVNC (HTML5) server console session (eq/novnc): returns a link to open in the browser.

Available post-install Ansible tasks (jenkins/get_tasks) with applicability tags: gpu, bm, vm, vgpu, default. Without a token — general list; with a token — tasks available to the specific user.

無需輸入參數。

Run a Jenkins/Ansible task on a server (jenkins/call): task ID or name from list_post_install_tasks + extra params. E.g. installing GPU drivers after OS reinstall.

Create a static DNAT to the server IPMI (nat/add_static_nat): public IP for classic IPMI access. Distinct from Secure IPMI Proxy in the panel — Proxy Active alone may not satisfy this call. Async; track with check_task. On server_ipmi_acl_required pass ip_acl.

Remove static DNAT to the server IPMI (nat/remove_static_nat).

Remove stale static NAT forwarding rules by internal IP (nat/clear_static_nat).

Delete a NAT record from the database (nat/drop_nat). DESTRUCTIVE, internal/ops action.

Create a temporary IPMI user for web access to IPMI (eq/add_ipmi_user).

Remove a temporary IPMI user (eq/remove_ipmi_user).

Reboot the server IPMI module (eq/unit_reset). Use when IPMI is unresponsive.

Remote Hands request: power on the server manually (jira/request_pon). Creates a Remote Hands ticket for the datacenter on-call shift; status and correspondence are in the ticket (link will be emailed).

Remote Hands request: power off the server manually (jira/request_poff). DESTRUCTIVE for running services. Creates a Remote Hands ticket for the datacenter on-call shift; status and correspondence are in the ticket (link will be emailed).

Remote Hands request: reboot the server manually (jira/request_reboot). Creates a Remote Hands ticket for the datacenter on-call shift; status and correspondence are in the ticket (link will be emailed).

Remote Hands request: boot the server via PXE (jira/request_PXEboot). Needed when reinstalling OS on servers without a remote management module. Creates a Remote Hands ticket for the datacenter on-call shift; status and correspondence are in the ticket (link will be emailed).

Remote Hands request: attach IP KVM to the server (jira/request_kvm). Creates a Remote Hands ticket for the datacenter on-call shift; status and correspondence are in the ticket (link will be emailed).

Remote Hands request: check the server and boot it into the OS (jira/request_check). Creates a Remote Hands ticket for the datacenter on-call shift; status and correspondence are in the ticket (link will be emailed).

Ticket to the sales department (jira/request_assistance): cancellation or transfer of a service and similar requests. Describe details in message.

PXE reinstall step 1: create an OS reinstall master key (eq/reinstall). Returns reinstall_key used by check_task to track install stages. DESTRUCTIVE: part of the process that wipes server disks.

PXE reinstall step 2: create a PXE config for OS install (eq/create_pxe). DESTRUCTIVE.

Set server boot order (eq/boot_dev): pxe — network boot (reinstall step 3), disk — boot from disk (step 6), cd — mounted ISO.

PXE reinstall step 7: remove the PXE config (eq/clear_pxe). REQUIRED after completion — otherwise an unexpected reinstall may occur on the next reboot.

List available ISO images (iso/list_iso). InvAPI requires a server id (for client keys); images are matched to the server configuration.

List ISO images uploaded by the client (iso/uploaded).

無需輸入參數。

Upload a new ISO image by URL (iso/upload). Available to clients.

Add a new ISO image or update an existing one by name (iso/add). Requires special 'add' permission.

Mount an ISO image on a server (iso/mount_iso). Async operation. Callback key returned — track with check_task. InvAPI expects `iso` (name or id). Pass iso, or name / iso_id aliases.

Unmount an ISO image from a server (iso/unmount_iso). Async operation. Callback key returned — track with check_task.

Delete an ISO image by ID (iso/delete). DESTRUCTIVE. Per docs, available only to Hostkey staff — clients will likely get a permission error.

List available S3 storage plans (s3/list_plans).

List available locations for S3 (s3/get_available_locations).

無需輸入參數。

List S3 account buckets and usage (s3/get_buckets_rmq). Pass s3uid or account_id from s3_get_users. May return a task key — then track with check_task.

Same as s3_get_buckets: list buckets via s3/get_buckets_rmq. Prefer s3_get_buckets.

List files in a bucket with pagination and search (s3/get_files).

List S3 users with service, traffic, and storage usage info (s3/get_users). Full filtering is available to administrators. Use returned s3uid/id with s3_get_buckets.

Get a decrypted S3 access key (s3/show_key). SECRET: do not log or share with third parties.

Create an S3 account: bind a plan and initial bucket (s3/create_account). Requires authentication.

Create a new bucket in an existing S3 account (s3/create_bucket).

Create a paid S3 storage order linked to billing (s3/create_order). MONEY: creates a real order/invoice.

Delete a file from a bucket (s3/delete_file). DESTRUCTIVE: the file is permanently deleted.

Delete a bucket from an S3 account (s3/delete_bucket). DESTRUCTIVE: all files in the bucket will be deleted.

Fully delete a user's S3 account (s3/delete_account). DESTRUCTIVE: all buckets and data will be deleted. Requires HOSTKEY_ALLOW_DESTRUCTIVE=1.

Initiate S3 account deletion via service cancellation in billing (s3/delete_payment_account). DESTRUCTIVE: an end date will be set on the active service. Requires HOSTKEY_ALLOW_DESTRUCTIVE=1.

Cancel S3 service deletion initiated via billing and restore the account to active status (s3/cancel_payment_account_deletion).

Update S3 account traffic information (s3/update_traffic_info). Available to administrators only.

List Remote Hands requests with filtering by location and status (rhr/list).

Create a Remote Hands request (rhr/add): on-site datacenter shift work that cannot be done remotely. Describe the work in as much detail as possible in comment. Use only if the remote server management module is unavailable/not working.

Add a client-visible message to the request history (rhr/chat).

Cancel/close a Remote Hands request (rhr/discard). DESTRUCTIVE: the request will be cancelled.

Client data from billing (whmcs/get_client): contacts, currency, account status.

無需輸入參數。

Full list of account invoices (whmcs/get_invoices).

無需輸入參數。

Data for a specific invoice for payment (whmcs/get_invoice).

Invoices related to a specific server (whmcs/get_related_invoices).

Billing information for a server rental (whmcs/get_billing_data).

List of transactions for the client account (whmcs/transactions).

Credit balance movement: credit additions and deductions (whmcs/getcredits).

Payment methods for a specific invoice (whmcs/getpaymentgw).

Download an invoice as PDF (whmcs/download_invoice). InvAPI returns binary PDF; MCP returns JSON with encoding=base64 and data — decode to a .pdf file.

List of active service cancellation requests (whmcs/get_cancellation_requests).

List of additional account contacts (whmcs/get_contacts).

無需輸入參數。

Update client data in billing (whmcs/update_client): name, company, address, email, phone, etc.

Reset the billing account password (whmcs/reset_password): a reset link is sent to the given email. Email must match the account email.

Add an additional contact to the account (whmcs/add_contact). WARNING: the contact is created with a random email — change it in Invapi.

Update an additional contact (whmcs/update_contact): email, password, phone. Providing a phone enables SMS 2FA.

Delete an additional account contact (whmcs/delete_contact). DESTRUCTIVE.

Create the next invoice for a server (whmcs/generate_due_invoice).

Create an invoice to top up the credit balance (whmcs/create_addfunds). MONEY: creates a real invoice for the given amount.

Pay an invoice in full or in part from the credit balance (whmcs/apply_credit). MONEY: deducts funds from the account.

Create a group invoice to pay multiple invoices at once (whmcs/mass_pay). MONEY.

Request service cancellation (whmcs/request_cancellation). DESTRUCTIVE: cancellation_type=1 — immediate cancel with partial refund (if possible), 0 — cancel at end of billing period. Requires HOSTKEY_ALLOW_DESTRUCTIVE=1.

Withdraw a service cancellation request (whmcs/delete_cancellation_request).

Check async job status by callback key (eq_callback/check). Many InvAPI operations (power on/off, order, reinstall, snapshots) return {"result":"OK","callback":"<key>"}. Pass that key here: result="Not ready" — still running; result="OK" — finished (key then expires). Server deploy can take 10–30 minutes. If the client sent progressToken, emits notifications/progress.

Power on a server (eq/on). Async: response includes a callback key for check_task.

Power off a server (eq/off). DESTRUCTIVE: interrupts all services on the server. Requires confirm=true. Async: response includes a callback key for check_task.

Reboot a server (eq/reboot). Interrupts services during reboot. Requires confirm=true. Async: response includes a callback key for check_task.

Order an instant or stock server (eq/order_instance). IMPORTANT: ordering charges the credit balance or creates an invoice. Defaults to dry_run=true — only checks preset/OS availability and returns a summary without placing an order. For a real order pass dry_run=false and confirm=true after explicit user consent on the cost. Deploy takes 10–30 minutes; status via check_task.

Reinstall OS on an existing server (simplified path via eq/order_instance with id). DESTRUCTIVE: all disk data will be erased. Requires HOSTKEY_ALLOW_DESTRUCTIVE=1 in the server environment, confirm=true, and re-entering the server's current hostname. Async: status via check_task.

Universal direct InvAPI call by resource and action, for resources without typed tools (e.g.: iso — ISO image library, s3 — S3 Object Storage, rhr — Remote Hands new version; see action list in the docs: https://hostkey.com/documentation/apidocs/). ALWAYS requires confirm=true; destructive/paid actions additionally require HOSTKEY_ALLOW_DESTRUCTIVE=1. Prefer typed tools when they exist for the needed operation.