os.php¶

Operating system management module: provides methods for adding, removing, updating, and retrieving a list of OS with filtering by hardware compatibility and licenses.

API Methods¶

Method	Action	Description
`list`	get OS list	Returns a filtered list of operating systems based on server hardware, instance presets, or customer location.

os/list¶

Returns a filtered list of operating systems based on server hardware, instance presets, or customer location.

HTTP Method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	The action to perform (e.g., `list`)
token	❌	string	Authentication token
id	❌	integer	Server ID for hardware-specific filtering
instance_id	❌	integer	Preset instance ID for configuration matching

Example Request

curl -s "https://invapi.hostkey.com/os.php" -X POST \
--data "action=list"

Example of a successful response

{
"result": "OK",
"action": "list",
"os_list": [
{
"id": 1,
"name": "Ubuntu 22.04 LTS",
"active": 1,
"price_EUR": 5.0,
"price_RUB": 450.0,
"billing_plan": {
"USD": 5.9,
"EUR": "monthly",
"RUB": 450.0
},
"tags": [
{
"tag": "uefi",
"value": ""
}
]
}
],
"os_excluded": []
}

Failure response

{
"code": -1,
"message": "$module/$action: no OS found"
}