Sign in

v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB
Host Firmware Config

Create or Update Host Firmware Config

Create or update host firmware config for the org/site. The target Site is specified by siteId in the request body.

User must have authorization role with PROVIDER_ADMIN suffix in the URL {org}.

put/v2/org/{org}/nico/firmware-config/host

Request body

siteIdstring uuid required

ID of the Site where the host firmware config is stored.

vendorstring required

Hardware vendor for the configuration (for example Nvidia, Dell).

modelstring required

Hardware model for the configuration (for example DGXH100).

explicitStartNeededboolean

Optional. When true, host firmware updates for this vendor/model require an explicit start. Omitted on update leaves the stored value unchanged.

orderingHostFirmwareComponentType[]

Update order for configured components. Required on first create. Must include every configured component and must be updated when adding a new component on subsequent PUTs.

Example request

{
  "siteId": "00000000-0000-0000-0000-000000000001",
  "vendor": "Nvidia",
  "model": "DGXH100",
  "explicitStartNeeded": true,
  "ordering": [
    "Cx7",
    "BMC"
  ],
  "components": [
    {
      "type": "Cx7",
      "firmware": [
        {
          "version": "28.47.2682",
          "default": true,
          "installOnlySpecified": true,
          "powerDrainsNeeded": 1,
          "preUpdateResets": true,
          "artifacts": [
            {
              "url": "https://firmware.example.invalid/28.47.2682/fw.bin",
              "sha256": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456"
            }
          ]
        }
      ]
    }
  ]
}

Response

Host firmware config replaced/updated

vendorstring required

Hardware vendor for the configuration.

modelstring required

Hardware model for the configuration.

explicitStartNeededboolean required

Whether host firmware updates require an explicit start.

orderingHostFirmwareComponentType[] required

Stored update order for configured components.

createdstring date-time required

When this vendor/model configuration was first created.

updatedstring date-time required

When this vendor/model configuration was last updated.

Example response

{
  "vendor": "Nvidia",
  "model": "DGXH100",
  "explicitStartNeeded": true,
  "ordering": [
    "Cx7",
    "BMC"
  ],
  "components": [
    {
      "type": "BMC",
      "firmware": [
        {
          "version": "2.3.7",
          "default": true,
          "installOnlySpecified": false,
          "powerDrainsNeeded": 0,
          "preUpdateResets": false,
          "artifacts": [
            {
              "url": "https://firmware.example.invalid/2.3.7/fw.bin",
              "sha256": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456"
            }
          ]
        }
      ]
    },
    {
      "type": "Cx7",
      "firmware": [
        {
          "version": "28.47.2682",
          "default": true,
          "installOnlySpecified": true,
          "powerDrainsNeeded": 1,
          "preUpdateResets": true,
          "artifacts": [
            {
              "url": "https://firmware.example.invalid/28.47.2682/fw.bin",
              "sha256": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456"
            }
          ]
        }
      ]
    }
  ],
  "created": "2025-08-24T14:15:22Z",
  "updated": "2025-08-24T14:15:22Z"
}