NetQ NVLink API Changelog
5.1 NetQ NVLink REST API Changelog
Version 5.1.0 (compared to 5.0.0). Breaking changes are indicated with ⚠️.
| Endpoint | Change Summary | Notes and Details |
|---|---|---|
GET /compute-nodes | Added: Optional query parameter hostname | Enables filtering by node hostname |
GET /compute-nodes | Added: Response property /items/Hostname | Returned with status 200 |
GET /compute-nodes/count | Added: Optional query parameter hostname | Enables filtered count queries |
GET /compute-nodes/{id} | Added: Response property Hostname | Returned with status 200 |
PUT /compute-nodes/{id} | Added: Response property Hostname | Returned with status 200 |
GET /domains | Introduced: New endpoint | Provides domain listing |
GET /domains/count | Introduced: New endpoint | Returns domain count |
GET /domains/{id} | Introduced: New endpoint | Retrieves domain details |
PATCH /domains/{id} | Introduced: New endpoint | Updates 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 /partitions | Changed ⚠️: Added subschema #3 to /items/Members list | Schema update for 200 responses |
GET /partitions | Changed ⚠️: Added enum value DEVICE_UID_BASED to /items/Type | Expands partition type options |
GET /partitions | Added: Response properties /items/MultiCastGroupLimit, /items/ResiliencyMode | Returned with status 200 |
POST /partitions | Added: Optional request properties MultiCastGroupLimit, ResiliencyMode | Enhances partition configuration |
POST /partitions | Changed: Added subschema #3 to Members oneOf list | Schema expansion |
GET /partitions/{id} | Changed ⚠️: Added subschema #3 and enum DEVICE_UID_BASED | Updated schema for ID lookup |
GET /partitions/{id} | Added: Optional properties MultiCastGroupLimit, ResiliencyMode | Returned with status 200 |
PUT /partitions/{id} | Changed: Added subschema #3 to request Members | Aligns with POST schema |
GET /ports | Added: Required properties /items/LinkRateMbps, /items/PortAdminState | Returned with status 200 |
GET /ports/{id} | Added: Required properties LinkRateMbps, PortAdminState | Returned with status 200 |
PUT /ports/{id} | Introduced: New endpoint | Supports port updates |
GET /services/connection | Introduced: New endpoint | Provides connection details |
GET /services/{id}/connection | Introduced: New endpoint | Retrieves connection by service ID |
GET /settings | Introduced: New endpoint | Lists current settings |
PATCH /settings | Introduced: New endpoint | Updates settings |
GET /settings/{name} | Introduced: New endpoint | Retrieves a named setting |
DELETE /settings/{name} | Introduced: New endpoint | Deletes a named setting |
GET /support-packages | Added: Query parameter domainIDs and property /items/domainID | Supports domain filtering |
GET /support-packages | Added: Response 404 non-success status | New response code |
POST /support-packages | Added: 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-packages | Changed: Property Switches became optional | Improved request flexibility |
POST /support-packages | Added: Response 404 non-success status | New response code |
GET /switch-nodes | Added: Optional query parameter hostname | Enables hostname filtering |
GET /switch-nodes | Added: Response properties /items/AdminState, /items/Hostname, /items/ManagementIPs, /items/ProfileID | Returned with status 200 |
GET /switch-nodes/count | Added: Optional query parameter hostname | Enables filtered counts |
GET /switch-nodes/{id} | Added: Response properties AdminState, Hostname, ManagementIPs, ProfileID | Returned with status 200 |
PUT /switch-nodes/{id} | Changed ⚠️: Removed subschema #1, #2 from request anyOf | Breaking request body change |
PUT /switch-nodes/{id} | Changed ⚠️: Changed request body type/format from object/"" to empty | Breaking request definition change |
PUT /switch-nodes/{id} | Removed: Request properties Description, Name | Streamlined payload |
PUT /switch-nodes/{id} | Added: Request schemas UpdateSwitchNodePayload, UpdateAdminStateRequest | Extended payload flexibility |
PUT /switch-nodes/{id} | Added: Response properties AdminState, Hostname, ManagementIPs, ProfileID | Returned with status 200. |
PUT /switch-nodes/{id} | Added: Success response 202 | New accepted response code |
POST /upgrade-switch | Added: Optional request property Domains | Upgrades 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-switch | Changed: Property Switches became optional | Improved request flexibility |
POST /upgrade-switch | Added: Response 404 non-success status | Error handling addition |
GET /version | Introduced: New endpoint | Retrieves API version info |