Call	Parameters	Description and return values
start	none	Starts the VPS
stop	none	Stops the VPS
restart	none	Reboots the VPS
kill	none	Allows to forcibly stop a VPS that is stuck and cannot be stopped by normal means. Please use this feature with great care as any unsaved data will be lost.
getServiceInfo	none	Returns vm_type: Hypervizor type (ovz or kvm) hostname: Hostname of the VPS node_ip: IP address of the physical node node_alias: Internal nickname of the physical node node_location: Physical location (country, state) location_ipv6_ready: Whether IPv6 is supported at the current location plan: Name of plan plan_disk: Disk quota (bytes) plan_ram: RAM (bytes) plan_swap: SWAP (bytes) os: Operating system email: Primary e-mail address of the account plan_monthly_data: Allowed monthly data transfer (bytes). Needs to be multiplied by monthly_data_multiplier - see below. data_counter: Data transfer used in the current billing month. Needs to be multiplied by monthly_data_multiplier - see below. monthly_data_multiplier: Some locations offer more expensive bandwidth; this variable contains the bandwidth accounting coefficient. data_next_reset: Date and time of transfer counter reset (UNIX timestamp) ip_addresses: IPv4 and IPv6 addresses assigned to VPS (Array) private_ip_addresses: Private IPv4 addresses assigned to VPS (Array) ip_nullroutes: Information on IP address nullrouting during (D)DoS attacks (Array). Sample output when IP is under attack: iso1: Mounted image #1 iso2: Mounted image #2 (currently unsupported) available_isos: Array of ISO images available for use plan_max_ipv6s: Maximum number of IPv6 addresses allowed by plan rdns_api_available: Whether or not rDNS records can be set via API plan_private_network_available: Whether or not Private Network features are available on this plan location_private_network_available: Whether or not Private Network features are available at this location ptr: rDNS records (Array of two-dimensional arrays: ip=>value) suspended: Whether VPS is suspended policy_violation: Whether there is an active policy violation that needs attention (see getPolicyViolations) suspension_count: Number of times service was suspended in current calendar year total_abuse_points: Total abuse points accumulated in current calendar year max_abuse_points: Maximum abuse points allowed by plan in a calendar year [ip_nullroutes] => Array ( [1.2.3.4] => Array ( [nullroute_timestamp] => 1556678627 // start of attack [nullroute_duration_s] => 360 // duration of nullroute [log] => "Packet dump data of the attack (multi-line)" // raw log of attack ) )
getLiveServiceInfo	none	This function returns all data provided by getServiceInfo. In addition, it provides detailed status of the VPS. Please note that this call may take up to 15 seconds to complete. Depending on hypervisor this call will return the following information: Returns [OVZ hypervisor] vz_status: array containing OpenVZ beancounters, system load average, number of processes, open files, sockets, memory usage etc vz_quota: array containing OpenVZ disk size, inodes and usage info is_cpu_throttled: 0 = CPU is not throttled, 1 = CPU is throttled due to high usage. Throttling resets automatically every 2 hours. ssh_port: SSH port of the VPS Returns [KVM hypervisor] ve_status: Starting, Running or Stopped ve_mac1: MAC address of primary network interface ve_used_disk_space_b: Occupied (mapped) disk space in bytes ve_disk_quota_gb: Actual size of disk image in GB is_cpu_throttled: 0 = CPU is not throttled, 1 = CPU is throttled due to high usage. Throttling resets automatically every 2 hours. is_disk_throttled: 0 = Disk I/O is not throttled, 1 = Disk I/O is throttled due to high usage. Throttling resets automatically every 15-180 minutes depending on sustained storage I/O utilization. ssh_port: SSH port of the VPS (returned only if VPS is running) live_hostname: Result of "hostname" command executed inside VPS load_average: Raw load average string mem_available_kb: Amount of available RAM in KB swap_total_kb: Total amount of Swap in KB swap_available_kb: Amount of available Swap in KB screendump_png_base64: base64 encoded png screenshot of the VGA console
getAvailableOS	none	Returns installed: Currently installed Operating System templates: Array of available OS
reinstallOS	os	Reinstall the Operating System. OS must be specified via "os" variable. Use getAvailableOS call to get list of available systems. Returns rootPassword: New root password sshPort: SSH port sshKeys: SSH keys uploaded to /root/.ssh/authorized_keys sshKeysBrief: SSH keys (shortened for visual presentation) notificationEmail: E-mail address where notification will be sent when complete
updateSshKeys	ssh_keys	Update per-VM SSH keys in Hypervisor Vault. Keys will be written to /root/.ssh/authorized_keys during a reinstallOS call. These keys will override any keys set in Billing Portal.
getSshKeys		Get SSH keys stored in Hypervisor Vault, as well as the ones stored in Billing Portal. Returns ssh_keys_veid: Per-VM SSH Keys stored in Hypervisor Vault ssh_keys_user: Per-Account SSH keys stored in Billing Portal ssh_keys_preferred: SSH Keys which will be actually used during a reinstallOS call (Per-VM Keys will always override Per-Account keys) shortened_ssh_keys_veid: Visually shortened keys shortened_ssh_keys_user: Visually shortened keys shortened_ssh_keys_preferred: Visually shortened keys
resetRootPassword	none	Generates and sets a new root password. Returns password: New root password
getUsageGraphs	none	Obsolete, use getRawUsageStats instead
getRawUsageStats	none	Returns a two-dimensional array with the detailed usage statistics shown under Detailed Statistics in KiwiVM.
getAuditLog	none	Returns an array with the detailed audit log shown under Audit Log in KiwiVM.
setHostname	newHostname	Sets new hostname.
setPTR	ip, ptr	Sets new PTR (rDNS) record for IP.
iso/mount	iso	Sets ISO image to boot from. VM must be completely shut down and restarted after this API call.
iso/unmount		Removes ISO image and configures VM to boot from primary storage. VM must be completely shut down and restarted after this API call.
basicShell/cd	currentDir, newDir	Simulate change of directory inside of the VPS. Can be used to build a shell like Basic shell. Returns pwd: Result of the "pwd" command after the change.
basicShell/exec	command	Execute a shell command on the VPS (synchronously). Returns error: Exit status code of the executed command message: Console output of the executed command
shellScript/exec	script	Execute a shell script on the VPS (asynchronously). Returns log: Name of the output log file.
snapshot/create	description (optional)	Create snapshot Returns notificationEmail: E-mail address on file where notification will be sent once task is completed.
snapshot/list	none	Get list of snapshots. Returns snapshots: Array of snapshots (fileName, os, description, size, md5, sticky, purgesIn, downloadLink).
snapshot/delete	snapshot	Delete snapshot by fileName (can be retrieved with snapshot/list call).
snapshot/restore	snapshot	Restores snapshot by fileName (can be retrieved with snapshot/list call). This will overwrite all data on the VPS.
snapshot/toggleSticky	snapshot, sticky	Set or remove sticky attribute ("sticky" snapshots are never purged). Name of snapshot can be retrieved with snapshot/list call – look for fileName variable. Set sticky = 1 to set sticky attribute Set sticky = 0 to remove sticky attribute
snapshot/export	snapshot	Generates a token with which the snapshot can be transferred to another instance.
snapshot/import	sourceVeid, sourceToken	Imports a snapshot from another instance identified by VEID and Token. Both VEID and Token must be obtained from another instance beforehand with a snapshot/export call.
backup/list	none	Get list of automatic backups. Returns backups: Array of backups (backupToken, size, os, md5, timestamp).
backup/copyToSnapshot	backupToken	Copies a backup identified by backupToken (returned by backup/list) into a restorable Snapshot.
ipv6/add	ip	Assigns a new IPv6 address. For initial IPv6 assignment an empty IP is required (call without parameters), and a new IP from the available pool is assigned automatically. All subsequent requested IPv6 addresses must be within the /64 subnet of the first IPv6 address. Returns ip: Newly assigned IPv6 address
ipv6/delete	ip	Releases specified IPv6 address.
migrate/getLocations	none	Return all possible migration locations. Returns currentLocation: ID of current location locations: IDs of locations available for migration into descriptions: Friendly descriptions of available locations dataTransferMultipliers: Some locations may offer more expensive bandwidth where monthly allowance will be lower. This array contains monthly data transfer allowance multipliers for each location.
migrate/start	location	Start VPS migration to new location. Takes new location ID as input. Note that this will result in all IPv4 addresses to be replaced with new ones, and all IPv6 addresses will be released. Returns notificationEmail: E-mail address on file where notification will be sent once task is completed. newIps: Array of new IP addresses assigned to the VPS.
cloneFromExternalServer	externalServerIP, externalServerSSHport, externalServerRootPassword	(OVZ only) Clone a remote server or VPS. See Migrate from another server for example on how this works.
getSuspensionDetails	none	Retrieve information related to service suspensions. Returns suspension_count: Number of times service was suspended in current calendar year total_abuse_points: Total abuse points accumulated in current calendar year max_abuse_points: Maximum abuse points allowed by plan in a calendar year suspensions: array of all outstanding issues along with supporing evidence of abuse. See example below. evidence: Full text of the complaint or more details about the issue Sample output when service is suspended: [suspensions] => Array ( [0] => stdClass Object ( [record_id] => 11851 // Case ID, needed to unsuspend // the service via "unsuspend" API call [flag] => copyright // Type of abuse [is_soft] => 1 // 0 = must contact support to unsuspend // 1 = can unsuspend via API call [evidence_record_id] => 2207 // Detailed abuse report ID (see below) [abuse_points] => 100 // Each abuse incident increases total_abuse_points counter ) ) [evidence] => stdClass Object ( [2207] => "Full text of abuse complaint here" ) [suspension_count] => 2 [total_abuse_points] => 200 [max_abuse_points] => 1500
getPolicyViolations	none	Retrieve information related to active policy violations. Returns total_abuse_points: Total abuse points accumulated in current calendar year max_abuse_points: Maximum abuse points allowed by plan in a calendar year policy_violations: array of all outstanding issues along with supporing evidence of abuse. See example below. Sample output when there is an active policy violation: [policy_violations] => Array ( [0] => Array ( [record_id] => 14 // Case ID, for resolvePolicyViolation [timestamp] => 1571469818 // Unix timestamp when record was created [suspend_at] => 1571599418 // Service will be suspended if not resolved by this time [flag] => copyright // Type of abuse [is_soft] => 1 // 0 = must contact support to unsuspend // 1 = can unsuspend via API call [abuse_points] => 100 // Each abuse incident increases total_abuse_points counter [evidence_data] => // Details of violation (text) ) ) [total_abuse_points] => 200 [max_abuse_points] => 1500 [error] => 0
unsuspend	record_id	Clear abuse issue identified by record_id and unsuspend the VPS. Refer to getSuspensionDetails call for details.
resolvePolicyViolation	record_id	Mark policy violation as resolved. This is required to avoid service suspension. Refer to getPolicyViolations call for details.
getRateLimitStatus	none	When you perform too many API calls in a short amount of time, KiwiVM API may start dropping your requests for a few minutes. This call allows monitoring this matter. Returns remaining_points_15min: Number of "points" available to use in the current 15-minute interval remaining_points_24h: Number of "points" available to use in the current 24-hour interval
privateIp/getAvailableIps	none	Returns all available (free) IPv4 addresses which you can activate on VM Returns available_ips: Array of available private IP addresses.
privateIp/assign	ip (optional)	Assign private IP address. If IP address not specified, a random address will be assigned. Returns assigned_ips: Array of successfully assigned private IP addresses
privateIp/delete	ip	Delete private IP address.