Sign in
jobs

Create a new Proxmox Installation job.

Take installation details as json payload and create Proxmox installation job per each host in 'hosts' list.<br> Mandatory (minimal) input data parameters:

  • iso_image (Proxmox ISO)
  • root_pwd
  • host_gateway
  • cidr
  • installmethod (must be "cimc")
  • hosts list with {hostname, host_ip, cimc_ip}
  • cimc_pwd

cimc_usr defaults to "admin" if not supplied.

Refer to schema definition for all parameters and default values.

post/proxmox-jobs

Request body

iso_imagestring required
root_pwdstring password required
installmethod'cimc' required
cimc_usrstring
cimc_pwdstring password required
host_gatewaystring required
cidrstring required
dnsstring
keyboardstring
countrystring
timezonestring
mailtostring email
filesystem'ext4' | 'xfs' | 'zfs' | 'btrfs'
disk_liststring
interfacestring
net_filter'ID_NET_NAME_SLOT' | 'ID_NET_NAME_PATH' | 'ID_NET_NAME_ONBOARD' | 'ID_VENDOR_ID' | 'ID_MODEL_ID' | 'ID_PATH' | 'ID_BUS' | 'ID_PCI_CLASS_FROM_DATABASE' | 'ID_PCI_SUBCLASS_FROM_DATABASE'
custom_scriptstring

Optional custom bash script to run on first boot.

Example request

{
  "iso_image": "proxmox-ve_9.0-1.iso",
  "host_gateway": "192.168.1.1",
  "cidr": "24",
  "dns": "8.8.8.8",
  "keyboard": "en-us",
  "country": "us",
  "timezone": "UTC",
  "mailto": "admin@example.com",
  "disk_list": "/dev/sda",
  "interface": "eno1",
  "custom_script": "echo \"Custom setup script\"\n# Your custom commands here\n",
  "hosts": [
    {
      "hostname": "pve-01.example.com",
      "host_ip": "192.168.1.100",
      "cimc_ip": "192.168.1.10"
    }
  ]
}

Response

Successful operation - return list of job IDs

string[] required

List of job IDs

Example response

[
  "192.168.0.1_1628871425.1136827",
  "192.168.0.2_1633093658.6881468"
]