NVIDIA Docs Hubchevron_right NVIDIA Networkingchevron_right Networking Softwarechevron_right Management Softwarechevron_right

NVIDIA NetQ

NetQ NVLink API Changelog

5.3 NetQ NVLink REST API Changelog

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

Endpoint	Change Summary	Notes and Details
`PUT /v1/certificates/ca`	Added: New endpoint to rotate CA certificate	Replaces the stored CA certificate synchronously. Southbound picks up the new CA on its next natural reconnect or after a subsequent server or switch certificate rotation.
`PUT /v1/certificates/server`	Added: New endpoint to rotate server certificate	Creates an asynchronous operation to rotate the server (southbound) TLS certificate. The optional `Reconnect` query parameter, when set to `true`, immediately activates the new certificate and drops and re-establishes managed-service connections.
`PUT /v1/certificates/switches`	Added: New endpoint to rotate switch certificates	Creates an asynchronous operation to rotate TLS certificates on one or more managed switches. Requires a `CertP12` bundle in a multipart/form-data request. Returns `422` if a specified switch address is not currently managed.
`DELETE /v1/chassis/{id}`	Added: New endpoint to delete a chassis	Synchronously deletes the chassis and cascades the deletion to its compute nodes, switch nodes, switches, GPUs, ports, and partitions in a single transaction.
`DELETE /v1/compute-nodes/{id}`	Added: New endpoint to delete a compute node	Synchronously deletes the compute node and its GPUs and ports in a single transaction. Returns `409` if any of the node's GPUs is a member of an active partition; detach or delete the partition first.
`DELETE /v1/domains/{id}`	Added: New endpoint to delete a domain	Asynchronously deletes the domain and all related entities (chassis, switch nodes, compute nodes, switches, GPUs, ports, partitions) and associated NMX services. Track progress via `GET /v1/operations/{operationId}`.
`DELETE /v1/switch-nodes/{id}`	Added: New endpoint to delete a switch node	Synchronously deletes the switch node and its switches and ports in a single transaction.
`GET /v1/chassis`	⚠️ Removed: `pagination` query parameter Added: `chassisSerialNumber` query filter	The `pagination` parameter (offset/limit object) has been removed. Clients that relied on it must be updated. Use the new `chassisSerialNumber` parameter to filter results by chassis serial number.
`GET /v1/compute-nodes`	⚠️ Removed: `pagination` query parameter Added: `chassisSerialNumber`, `slotID`, `trayIndex`, `hostID` query filters	The `pagination` parameter has been removed. Clients that relied on it must be updated. New location-based query filters allow narrowing results by chassis, slot, tray, and host.
`GET /v1/domains`	⚠️ Removed: `pagination` query parameter Added: `controlPlaneState` query filter	The `pagination` parameter has been removed. Clients that relied on it must be updated. Use the new `controlPlaneState` parameter to filter domains by their control plane state.
`GET /v1/gpus`	⚠️ Removed: `pagination` query parameter ⚠️ Changed: `deviceUID` parameter type from `uint64` to `HexOrDecimalUint64` Added: `systemUID` query filter	The `pagination` parameter has been removed. The `deviceUID` filter now accepts a decimal number or a hex string with `0x` prefix (e.g., `0x1A2B3C`); clients passing plain integer values must update to the new string format. A new `systemUID` filter allows filtering by node unique identifier.
`GET /v1/ports`	⚠️ Removed: `pagination` query parameter Added: `portUID`, `portType`, `chassisSerialNumber`, `slotID`, `trayIndex`, `hostID` query filters	The `pagination` parameter has been removed. Clients that relied on it must be updated. New filters allow querying ports by UID, type, and physical location.
`GET /v1/switch-nodes`	⚠️ Removed: `pagination` query parameter Added: `chassisSerialNumber`, `slotID`, `trayIndex`, `hostID` query filters	The `pagination` parameter has been removed. Clients that relied on it must be updated. New location-based query filters allow narrowing results by chassis, slot, tray, and host.
`GET /v1/switches`	⚠️ Removed: `pagination` query parameter ⚠️ Changed: `deviceUID` parameter type from `uint64` to `HexOrDecimalUint64` Added: `deviceUID`, `systemUID`, `chassisSerialNumber`, `slotID`, `trayIndex`, `hostID` query filters	The `pagination` parameter has been removed. The new `deviceUID` filter accepts a decimal number or a hex string with `0x` prefix (e.g., `0x1A2B3C`). Additional location-based filters and a `systemUID` filter are also new.
`GET /v1/compute-nodes` `GET /v1/compute-nodes/{id}` `GET /v1/switch-nodes` `GET /v1/switch-nodes/{id}`	⚠️ Changed: Response field `NodeSensor.URI` renamed to `NodeSensor.ID`	The sensor identifier field in the `NodeSensor` schema was renamed from `URI` to `ID`. Clients that read sensor data from compute node or switch node responses must update field references from `URI` to `ID`.
`GET /v1/services`	⚠️ Changed: `address` query filter type from IPv4-only to IPv4 or hostname Changed: Response field `NmxService.Address` type from IPv4-only to IPv4 or hostname	The `address` filter and the `NmxService.Address` response field now use the broader `Address` schema (IPv4 or hostname). Previously, only IPv4 addresses were accepted.
`POST /v1/services`	⚠️ Changed: Request field `ServiceConnectionInformation.Address` type from IPv4-only to IPv4 or hostname	`AddNmxServiceRequest.ServiceConnectionInformation.Address` now uses the `Address` schema (IPv4 or hostname). Services can now be registered using a hostname. Clients passing IPv4 values are unaffected.
`POST /v1/certificates/server`	Added: `403` error response	The endpoint now returns `403 Forbidden` when the upload is rejected due to the current system configuration or policy (for example, when operating in self-signed cert-mode).
`PATCH /v1/switch-profiles/{id}`	Changed: Request body is now required	The request body was previously optional. It is now required. A `PATCH` request must always include a body with at least one field to update (`Name`, `Username`, or `Password`).