There will be site maintenance on Saturday April 18th, between 10:00 and 14:00 ET (Eastern Time). You may experience interruptions.

WS-NOC API documentation and Sample Postman Collections



For deprecated and deleted APIs list see: deprecated and deleted list

This page provides the API change log between two releases. To view the list of APIs that are new, deleted/deprecated, and changed, select the Source and Target releases from the drop-down.   

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
NA
html
NA
Core Functionalities swagger
NA
postman
Ethernet Service Management swagger
NA
postman
Performance Management(NBI Kafka Streaming - Deprecated) swagger
NA
postman
System Monitor swagger
NA
postman
WaveSuite Synchronizer swagger
NA
NA
Fault Management swagger
NA
postman
Kafka Notification Services swagger
NA
postman

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.

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
NA
html
NA
Core Functionalities swagger
NA
postman
Ethernet Service Management swagger
NA
postman
Performance Management(NBI Kafka Streaming - Deprecated) swagger
NA
postman
System Monitor swagger
NA
postman
WaveSuite Synchronizer swagger
NA
NA
Fault Management swagger
NA
postman
Kafka Notification Services swagger
NA
postman

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.

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
NA
html
NA
Core Functionalities swagger
NA
postman
Ethernet Service Management swagger
NA
postman
Performance Management swagger
NA
postman
System Monitor swagger
NA
postman
WaveSuite Synchronizer swagger
NA
NA
Fault Management swagger
NA
postman
Kafka Notification Services swagger
NA
postman

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.

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
NA
html
NA
Core Functionalities swagger
NA
postman
Ethernet Service Management swagger
NA
postman
Performance Management swagger
NA
postman
System Monitor swagger
NA
postman
WaveSuite-Synchronizer swagger
NA
NA
Fault Management swagger
NA
postman
Kafka Notification Services swagger
NA
postman

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 22.12 release, see:

Core Functionalities:

Performance Management :

Ethernet Service Management:

WaveSuite-Synchronizer:

System Monitor:

There is are no new APIs, deleted/deprecated APIs, and changed APIs in this release.