Create or Update Host Firmware Config

PUT

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/firmware-config/host

PUT

/v2/org/:org/nico/firmware-config/host

$ curl -X PUT https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/firmware-config/host \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "siteId": "00000000-0000-0000-0000-000000000001",
>   "vendor": "Nvidia",
>   "model": "DGXH100",
>   "components": [
>     {
>       "type": "Cx7",
>       "firmware": [
>         {
>           "version": "28.47.2682",
>           "artifacts": [
>             {
>               "url": "https://firmware.example.invalid/28.47.2682/fw.bin",
>               "sha256": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456"
>             }
>           ],
>           "default": true,
>           "installOnlySpecified": true,
>           "powerDrainsNeeded": 1,
>           "preUpdateResets": true
>         }
>       ]
>     }
>   ],
>   "explicitStartNeeded": true,
>   "ordering": [
>     "Cx7",
>     "BMC"
>   ]
> }'

1 {
2   "vendor": "Nvidia",
3   "model": "DGXH100",
4   "components": [
5     {
6       "type": "BMC",
7       "firmware": [
8         {
9           "version": "2.3.7",
10           "artifacts": [
11             {
12               "url": "https://firmware.example.invalid/2.3.7/fw.bin",
13               "sha256": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456"
14             }
15           ],
16           "default": true,
17           "installOnlySpecified": false,
18           "powerDrainsNeeded": 0,
19           "preUpdateResets": false
20         }
21       ]
22     },
23     {
24       "type": "Cx7",
25       "firmware": [
26         {
27           "version": "28.47.2682",
28           "artifacts": [
29             {
30               "url": "https://firmware.example.invalid/28.47.2682/fw.bin",
31               "sha256": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456"
32             }
33           ],
34           "default": true,
35           "installOnlySpecified": true,
36           "powerDrainsNeeded": 1,
37           "preUpdateResets": true
38         }
39       ]
40     }
41   ],
42   "explicitStartNeeded": true,
43   "ordering": [
44     "Cx7",
45     "BMC"
46   ],
47   "created": "2025-08-24T14:15:22Z",
48   "updated": "2025-08-24T14:15:22Z"
49 }

WARNING: As of the 2.0 release, NICo core will store the config data sent by this request, but will not yet rely on it to determine firmware installed on host.

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}.

**WARNING:** As of the 2.0 release, NICo core will store the config data sent by this request, but will not yet rely on it to determine firmware installed on host. 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}`.

Authentication

AuthorizationBearer

export JWT_BEARER_TOKEN="<jwt-bearer-token>"
# Example org name: "acme-inc
export ORG_NAME=<org-name>
# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current ```

Path parameters

orgstringRequired

Name of the Org

Request

This endpoint expects an object.

siteIdstringRequiredformat: "uuid"

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

vendorstringRequired>=1 character

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

modelstringRequired>=1 character

Hardware model for the configuration (for example DGXH100).

componentslist of objectsRequired

Component firmware entries to create or merge.

explicitStartNeededbooleanOptional

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

orderinglist of enumsOptional

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.

Response

Host firmware config replaced/updated

vendorstringRead-only

Hardware vendor for the configuration.

modelstringRead-only

Hardware model for the configuration.

componentslist of objects

Stored component firmware entries.

explicitStartNeededbooleanRead-only

Whether host firmware updates require an explicit start.

orderinglist of enumsRead-only

Stored update order for configured components.

createddatetimeRead-only

When this vendor/model configuration was first created.

updateddatetimeRead-only

When this vendor/model configuration was last updated.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error