layout-3 layout-6 layout-1 layout-top
NVIDIA Docs Hubchevron_right NVIDIA Networkingchevron_right Networking Softwarechevron_right Management Softwarechevron_right

NVIDIA NetQ

layout-top layout-6 layout-1

NetQ NVLink API Changelog

Version 5.2.0 (compared to 5.1.0). Breaking changes are indicated with ⚠️. For more information, see the REST API in Swagger.

Endpoint Change Summary Notes and Details
POST /v1/bring-upAdded: Request field CertP12Binary field for user-cert mode; description updated with cert-mode docs, request examples added, 404 error response removed
GET /v1/certificatesIntroduced: New endpointReturns overview listing all certificate metadata
POST /v1/certificates/caIntroduced: New endpointUploads CA certificate in PEM format; rejected when cluster is in self-signed cert mode
GET /v1/certificates/caIntroduced: New endpointRetrieves CA certificate metadata
POST /v1/certificates/serverIntroduced: New endpointUploads server TLS certificate and key in PEM format; supports ?force=true override
GET /v1/certificates/serverIntroduced: New endpointRetrieves server certificate metadata
GET /v1/compute-nodesAdded: Response field SensorsComputeNode now includes Sensors of type NodeSensorsMap; new schemas NodeSensor and NodeSensorsMap
GET /v1/compute-nodesChanged: ID-related schemas constraintsSlotID, TrayIndex, HostID schemas now require minimum value 0
GET /v1/compute-nodes/{id}Added: Response field SensorsComputeNode now includes Sensors of type NodeSensorsMap; new schemas NodeSensor and NodeSensorsMap
PUT /v1/compute-nodes/{id}Added: Request/response field SensorsComputeNode schema extended with Sensors and NodeSensorsMap
GET /v1/compute-nodes/{id}Changed: ID-related schemas constraintsSlotID, TrayIndex, HostID schemas now require minimum value 0
PUT /v1/compute-nodes/{id}Changed: ID-related schemas constraintsSlotID, TrayIndex, HostID schemas now require minimum value 0
GET /v1/gpusIntroduced: New filtered listingLists GPUs with filters on deviceUID, chassisSerialNumber, slotID, trayIndex, hostID
GET /v1/gpusChanged: GPU.DeviceUID schemaInlined uint64 type and added JavaScript precision warning (was $ref: uint64)
GET /v1/gpus/{id}Changed: ID-related schemas constraintsSlotID, TrayIndex, HostID schemas now require minimum value 0
PUT /v1/gpus/{id}Changed: ID-related schemas constraintsSlotID, TrayIndex, HostID schemas now require minimum value 0
GET /v1/gpus/{id}Changed: GPU.DeviceUID schemaInlined uint64 type with JavaScript precision warning (was $ref: uint64)
PUT /v1/gpus/{id}Changed: GPU.DeviceUID schemaInlined uint64 type with JavaScript precision warning (was $ref: uint64)
POST /v1/imagesAdded: Optional request field ImageTypeExtends UploadImageRequest with ImageType
GET /v1/imagesChanged ⚠️: ImageMetadata.imageType enumEnum values changed from uppercase NVOS to lowercase nvos; new value cpld added (breaking change)
GET /v1/kpi/compute-healthIntroduced: New endpointReturns compute node health metrics time series
GET /v1/kpi/connection-stateIntroduced: New endpointReturns connection state metrics time series
GET /v1/kpi/domain-healthIntroduced: New endpointReturns domain health metrics time series
GET /v1/kpi/gpu-healthIntroduced: New endpointReturns GPU health metrics time series
GET /v1/kpi/partition-healthIntroduced: New endpointReturns partition health metrics time series
GET /v1/kpi/switch-node-healthIntroduced: New endpointReturns switch node health metrics time series
GET /v1/kpisChanged: KPI enums and schemaKPIType enum extended with FW_VERSIONS; KPIResponse schema gains fw-versions field
GET /v1/partitionsAdded: Query parameter gpu-id-typeEnum values: device-uuid, db-id; new GpuIdType schema
POST /v1/partitionsAdded: Request support for GPU-DeviceUUIDPartition members may use uint64 device UUIDs in addition to GPU DB IDs
GET /v1/partitions/{id}Added: Query parameter gpu-id-typeEnum values: device-uuid, db-id
PUT /v1/partitions/{id}Added: Request support for GPU-DeviceUUIDPartition members may use uint64 device UUIDs in addition to GPU DB IDs
GET /v1/redfishIntroduced: New endpointLists all Redfish endpoints
POST /v1/redfishIntroduced: New endpointCreates a new Redfish endpoint
GET /v1/redfish/{id}Introduced: New endpointRetrieves a specific Redfish endpoint
DELETE /v1/redfish/{id}Introduced: New endpointDeletes a Redfish endpoint
GET /v1/switch-nodesAdded: Response field SensorsSwitchNode schema now includes Sensors of type NodeSensorsMap
GET /v1/switch-nodesAdded: Response field FWVersionsSwitchNode schema gains FWVersions; new FWVersions schema (ASIC, BIOS, BMC, CPLD1–4, EROT variants, FPGA, NVOS)
GET /v1/switch-nodesChanged: ID-related schemas constraintsSlotID, TrayIndex, HostID schemas now require minimum value 0
GET /v1/switch-nodes/{id}Added: Response field SensorsSwitchNode schema includes Sensors of type NodeSensorsMap
PUT /v1/switch-nodes/{id}Added: Request/response field SensorsSwitchNode schema includes Sensors of type NodeSensorsMap
GET /v1/switchesChanged: ID-related schemas constraintsSlotID, TrayIndex, HostID schemas now require minimum value 0
GET /v1/switches/{id}Changed: ID-related schemas constraintsSlotID, TrayIndex, HostID schemas now require minimum value 0
PUT /v1/switches/{id}Changed: ID-related schemas constraintsSlotID, TrayIndex, HostID schemas now require minimum value 0
GET /v1/portsChanged: ID-related schemas constraintsSlotID, TrayIndex, HostID schemas now require minimum value 0
GET /v1/ports/{id}Changed: ID-related schemas constraintsSlotID, TrayIndex, HostID schemas now require minimum value 0
PUT /v1/ports/{id}Changed: ID-related schemas constraintsSlotID, TrayIndex, HostID schemas now require minimum value 0
GET /v1/switch-nodes/{id}Added: Response field FWVersionsSwitchNode schema includes FWVersions; new FWVersions schema (ASIC, BIOS, BMC, CPLD1–4, EROT variants, FPGA, NVOS)
PUT /v1/switch-nodes/{id}Added: Request/response field FWVersionsSwitchNode schema includes FWVersions; uses shared FWVersions schema
GET /v1/switch-nodes/{id}Changed: ID-related schemas constraintsSlotID, TrayIndex, HostID schemas now require minimum value 0
PUT /v1/switch-nodes/{id}Changed: ID-related schemas constraintsSlotID, TrayIndex, HostID schemas now require minimum value 0
POST /v1/upgrade-switchChanged: Upgrade request schemaAdded UpgradeType enum (nvos, cpld) to CreateSwitchUpgradeRequest; description updated from “NVOS image” to “NVOS/Firmware image”; CPLD upgrade examples added
GET /v1/validations/fw-versionsIntroduced: New endpointReturns firmware version validation results per domain
GET /v1/versionChanged: API versionAPI version updated from 5.1.0 to 5.2.0
ALL nmx/v1/* (NVL endpoints)Added: Error schema metadataError schema extended with x-go-type: liberr.Error and x-go-type-import for Go code generation; no wire-format changes

    Copyright © 2026  NVIDIA Corporation