WS-NOC API documentation and Sample Postman Collections
For deprecated and deleted APIs list see: deprecated and deleted list
- API Diff
- 25.12
- 25.6
- 24.12
- 24.6
This page provides links to API Swagger documentation and sample code collections for all of the listed Optical Network API REST services.
| ON REST API | Swagger | Postman Collections | ON REST API |
|---|---|---|---|
| NBI Network Kafka Notification |
|
|
|
| Comet Notification (Deprecated |
|
|
|
| Core Functionalities |
|
|
|
| Ethernet Service Management |
|
|
|
| Performance Management (NBI Kafka Streaming - Deprecated) |
|
|
|
| System Monitor |
|
|
|
| WaveSuite Synchronizer |
|
|
|
| Fault Management |
|
|
|
| Kafka Notification Services |
|
|
|
Note:
- The Kafka notification service and Fault Management APIs can also be accessed from 8443 port.
- User can execute a REST API call from the Graphical User Interface of WS-NOC application. From the user manual icon, navigate to the WS-NOC Rest API. Navigate to Swagger 3.0 page of the required component. Swagger 3.0 now has Try It Out option for the user to execute REST APIs.
How-To Use Case in WS-NOC
To understand the execution of WS-NOC scenarios in detail, see How To in WS-NOC.
What's New for REST API:
To view the list of new APIs, deleted/deprecated APIs, and changed APIs for the 25.12 release, see:
Core Functionalities:
- REST API changes from R25.6 to R25.12
- REST API changes from R24.12 to R25.12
- REST API changes from R24.6 to R25.12
- REST API changes from R23.12 to R25.12
Performance Management:
- REST API changes from R25.6 to R25.12
- REST API changes from R24.12 to R25.12
- REST API changes from R24.6 to R25.12
- REST API changes from R23.12 to R25.12
Ethernet Service Management:
- REST API changes from R25.6 to R25.12
- REST API changes from R24.12 to R25.12
- REST API changes from R24.6 to R25.12
- REST API changes from R23.12 to R25.12
WaveSuite Synchronizer:
- REST API changes from R25.6 to R25.12
- REST API changes from R24.12 to R25.12
- REST API changes from R24.6 to R25.12
- REST API changes from R23.12 to R25.12
System Monitor:
This page provides links to API Swagger documentation and sample code collections for all of the listed Optical Network API REST services.
| ON REST API | Swagger | Postman Collections |
|---|---|---|
| NBI Network Kafka Notification |
|
|
| Comet Notification (Deprecated |
|
|
| Core Functionalities |
|
|
| Ethernet Service Management |
|
|
| Performance Management (NBI Kafka Streaming - Deprecated) |
|
|
| System Monitor |
|
|
| WaveSuite Synchronizer |
|
|
| Fault Management |
|
|
| Kafka Notification Services |
|
|
Note:
- The Kafka notification service and Fault Management APIs can also be accessed from 8443 port.
- User can execute a REST API call from the Graphical User Interface of WS-NOC application. From the user manual icon, navigate to the WS-NOC Rest API. Navigate to Swagger 3.0 page of the required component. Swagger 3.0 now has Try It Out option for the user to execute REST APIs.
How-To Use Case in WS-NOC
To understand the execution of WS-NOC scenarios in detail, see How To in WS-NOC.
What's New for REST API:
To view the list of new APIs, deleted/deprecated APIs, and changed APIs for the 25.6 release, see:
Core Functionalities:
- REST API changes from R24.12 to R25.6
- REST API changes from R24.6 to R25.6
- REST API changes from R23.12 to R25.6
- REST API changes from R23.6 to R25.6
Performance Management:
- REST API changes from R24.12 to R25.6
- REST API changes from R24.6 to R25.6
- REST API changes from R23.12 to R25.6
- REST API changes from R23.6 to R25.6
Ethernet Service Management:
- REST API changes from R24.12 to R25.6
- REST API changes from R24.6 to R25.6
- REST API changes from R23.12 to R25.6
- REST API changes from R23.6 to R25.6
WaveSuite Synchronizer:
- REST API changes from R24.12 to R25.6
- REST API changes from R24.6 to R25.6
- REST API changes from R23.12 to R25.6
- REST API changes from R23.6 to R25.6
System Monitor:
This page provides links to API Swagger documentation and sample code collections for all of the listed Optical Network API REST services.
| ON REST API | Swagger | HTML Collection | Postman Collections |
|---|---|---|---|
| NBI Network Kafka Notification |
|
|
|
| Comet Notification(Deprecated |
|
|
|
| Core Functionalities |
|
|
|
| Ethernet Service Management |
|
|
|
| Performance Management(NBI Kafka Streaming - Deprecated) |
|
|
|
| System Monitor |
|
|
|
| WaveSuite Synchronizer |
|
|
|
| Fault Management |
|
|
|
| Kafka Notification Services |
|
|
|
Note:
- The Kafka notification service and Fault Management APIs can also be accessed from 8443 port.
- User can execute a REST API call from the Graphical User Interface of WS-NOC application. From the user manual icon, navigate to the WS-NOC Rest API. Navigate to Swagger 3.0 page of the required component. Swagger 3.0 now has Try It Out option for the user to execute REST APIs.
How-To Use Case in WS-NOC
To understand the execution of WS-NOC scenarios in detail, see How To in WS-NOC.
What's New for REST API:
To view the list of new APIs, deleted/deprecated APIs, and changed APIs for the 24.12 release, see:
Core Functionalities:
- REST API changes from R24.6 to R24.12
- REST API changes from R23.12 to R24.12
- REST API changes from R23.6 to R24.12
- REST API changes from R22.12 to R24.12
Performance Management :
- REST API changes from R24.6 to R24.12
- REST API changes from R23.12 to R24.12
- REST API changes from R23.6 to R24.12
- REST API changes from R22.12 to R24.12
Ethernet Service Management:
- REST API changes from R24.6 to R24.12
- REST API changes from R23.12 to R24.12
- REST API changes from R23.6 to R24.12
- REST API changes from R22.12 to R24.12
WaveSuite Synchronizer:
- REST API changes from R24.6 to R24.12
- REST API changes from R23.12 to R24.12
- REST API changes from R23.6 to R24.12
- REST API changes from R22.12 to R24.12
- Test
System Monitor:
This page provides links to API Swagger documentation and sample code collections for all of the listed Optical Network API REST services.
| ON REST API | Swagger | HTML Collection | Postman Collections |
|---|---|---|---|
| Comet Notification |
|
|
|
| Core Functionalities |
|
|
|
| Ethernet Service Management |
|
|
|
| Performance Management(NBI Kafka Streaming - Deprecated) |
|
|
|
| System Monitor |
|
|
|
| WaveSuite Synchronizer |
|
|
|
| Fault Management |
|
|
|
| Kafka Notification Services |
|
|
|
Note:
- The Kafka notification service and Fault Management APIs can also be accessed from 8443 port.
- User can execute a REST API call from the Graphical User Interface of WS-NOC application. From the user manual icon, navigate to the WS-NOC Rest API. Navigate to Swagger 3.0 page of the required component. Swagger 3.0 now has Try It Out option for the user to execute REST APIs.
How-To Use Case in WS-NOC
To understand the execution of WS-NOC scenarios in detail, see How To in WS-NOC.
What's New for REST API:
To view the list of new APIs, deleted/deprecated APIs, and changed APIs for the 24.6 release, see:
Core Functionalities:
- REST API changes from R23.12 to R24.6
- REST API changes from R23.6 to R24.6
- REST API changes from R22.12 to R24.6
- REST API changes from R22.6 to R24.6
Performance Management :
- REST API changes from R23.12 to R24.6
- REST API changes from R23.6 to R24.6
- REST API changes from R22.12 to R24.6
- REST API changes from R22.6 to R24.6
Ethernet Service Management:
- REST API changes from R23.12 to R24.6
- REST API changes from R23.6 to R24.6
- REST API changes from R22.12 to R24.6
- REST API changes from R22.6 to R24.6
WaveSuite Synchronizer:
- REST API changes from R23.12 to R24.6
- REST API changes from R23.6 to R24.6
- REST API changes from R22.12 to R24.6
- REST API changes from R22.6 to R24.6