v1

latestOpenAPI 3.0.0GPLv32026-07-17661855.6 KB

Hosts

Update an existing host

patch/hosts/{hostName}/

Path parameters

hostNamestring required

Host name

Request body

namestring

modelstring

host_typestring

buildboolean

validatedboolean

switch_config_appliedboolean

brokenboolean

retiredboolean

can_self_scheduleboolean

last_buildstring

cloud_idinteger

default_cloud_idinteger

Example request

{
  "name": "host.example.com",
  "model": "r640",
  "host_type": "vendor",
  "build": true,
  "validated": true,
  "switch_config_applied": true,
  "broken": true,
  "retired": true,
  "last_build": "2022-02-02",
  "cloud_id": 12,
  "default_cloud_id": 1
}

Response

Host name

idinteger

namestring

modelstring

host_typestring

buildboolean

validatedboolean

switch_config_appliedboolean

brokenboolean

retiredboolean

can_self_scheduleboolean

last_buildstring

cloud_idinteger

default_cloud_idinteger

Example response

{
  "id": 12,
  "name": "host.example.com",
  "model": "r640",
  "host_type": "vendor",
  "build": true,
  "validated": true,
  "switch_config_applied": true,
  "broken": true,
  "retired": true,
  "last_build": "2022-02-02",
  "cloud_id": 12,
  "default_cloud_id": 1,
  "interfaces": [
    {
      "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
    }
  ],
  "disks": [
    {
      "disk_id": 1,
      "disk_type": "nvme",
      "size_gb": 2000,
      "count": 10,
      "host_id": 10
    }
  ],
  "memory": [
    {
      "id": 12,
      "size_gb": 2000,
      "handle": "MMD",
      "host_id": 10
    }
  ],
  "processors": [
    {
      "id": 12,
      "handle": "CoreI7",
      "vendor": "Intel",
      "product": "i7",
      "cores": 20,
      "threads": 20,
      "host_id": 10
    }
  ]
}