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

A newer version of this product documentation is available. If you are redirected to the main page of the user guide, then this page might have been renamed or removed.

NetQ NVLink API Changelog

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

Endpoint Change Summary Notes and Details
GET /compute-nodesAdded: Optional query parameter hostnameEnables filtering by node hostname
GET /compute-nodesAdded: Response property /items/HostnameReturned with status 200
GET /compute-nodes/countAdded: Optional query parameter hostnameEnables filtered count queries
GET /compute-nodes/{id}Added: Response property HostnameReturned with status 200
PUT /compute-nodes/{id}Added: Response property HostnameReturned with status 200
GET /domainsIntroduced: New endpointProvides domain listing
GET /domains/countIntroduced: New endpointReturns domain count
GET /domains/{id}Introduced: New endpointRetrieves domain details
PATCH /domains/{id}Introduced: New endpointUpdates domain properties. Use this endpoint to create an association between a domain and a profile ID. Then use the profile ID to access the switches within the domain.
GET /portsAdded: Required properties /items/LinkRateMbps, /items/PortAdminStateReturned with status 200
GET /ports/{id}Added: Required properties LinkRateMbps, PortAdminStateReturned with status 200
PUT /ports/{id}Introduced: New endpointSupports port updates
GET /services/connectionIntroduced: New endpointProvides connection details
GET /services/{id}/connectionIntroduced: New endpointRetrieves connection by service ID
GET /settingsIntroduced: New endpointLists current settings
PATCH /settingsIntroduced: New endpointUpdates settings
GET /settings/{name}Introduced: New endpointRetrieves a named setting
DELETE /settings/{name}Introduced: New endpointDeletes a named setting
GET /support-packagesAdded: Query parameter domainIDs and property /items/domainIDSupports domain filtering
GET /support-packagesAdded: Response 404 non-success statusNew response code
POST /support-packagesAdded: Optional request property Domains.Adds domain linking. Use the profileID from PATCH /domains/{id} or PUT /switch-nodes{id} to perform this request.
POST /support-packagesChanged: Property Switches became optionalImproved request flexibility
POST /support-packagesAdded: Response 404 non-success statusNew response code
GET /switch-nodesAdded: Optional query parameter hostnameEnables hostname filtering
GET /switch-nodesAdded: Response properties /items/AdminState, /items/Hostname, /items/ManagementIPs, /items/ProfileIDReturned with status 200
GET /switch-nodes/countAdded: Optional query parameter hostnameEnables filtered counts
GET /switch-nodes/{id}Added: Response properties AdminState, Hostname, ManagementIPs, ProfileIDReturned with status 200
PUT /switch-nodes/{id}Changed ⚠️: Removed subschema #1, #2 from request anyOfBreaking request body change
PUT /switch-nodes/{id}Changed ⚠️: Changed request body type/format from object/"" to emptyBreaking request definition change
PUT /switch-nodes/{id}Removed: Request properties Description, NameStreamlined payload
PUT /switch-nodes/{id}Added: Request schemas UpdateSwitchNodePayload, UpdateAdminStateRequestExtended payload flexibility
PUT /switch-nodes/{id}Added: Response properties AdminState, Hostname, ManagementIPs, ProfileIDReturned with status 200.
PUT /switch-nodes/{id}Added: Success response 202New accepted response code
POST /upgrade-switchAdded: Optional request property DomainsUpgrades the OS of switches within a domain. Use the profileID from PATCH /domains/{id} or PUT /switch-nodes{id} to perform this request.
POST /upgrade-switchChanged: Property Switches became optionalImproved request flexibility
POST /upgrade-switchAdded: Response 404 non-success statusError handling addition
GET /versionIntroduced: New endpointRetrieves API version info

    Copyright © 2026  NVIDIA Corporation