Interfaces

Update an existing host interface definitions

Changed on
patch/interfaces/{hostName}

Request

  • Base URL
    https://quads.example.com/api/v3
  • URL
    https://quads.example.com/api/v3/interfaces/{hostName}
  • Auth
    HTTP bearer

Path parameters

hostNamestring required

Host name

Request body

idinteger required
namestring
mac_addressstring
switch_ipstring
switch_portstring
bios_idstring
speedinteger
vendorstring
pxe_bootboolean
maintenanceboolean

Example request

{
  "id": 12,
  "name": "em1",
  "mac_address": "aa:00:bb:11:cc:22",
  "switch_ip": "10.1.1.18",
  "switch_port": "xt-0-0/1",
  "bios_id": "nic1",
  "speed": 1000,
  "vendor": "Intel",
  "pxe_boot": true
}

Response

Interface details

idinteger
namestring
bios_idstring
mac_addressstring
switch_ipstring
switch_portstring
speedinteger
vendorstring
pxe_bootboolean
maintenanceboolean
host_idinteger

Example response

{
  "id": 12,
  "name": "em1",
  "bios_id": "nic1",
  "mac_address": "aa:00:bb:11:cc:22",
  "switch_ip": "10.1.1.18",
  "switch_port": "xt-0-0/1",
  "speed": 1000,
  "vendor": "Intel",
  "pxe_boot": true,
  "host_id": 10
}

Changes