REST API Online Documentation

If you are a software developer who has been assigned the task of using the Skylight orchestrator REST API to develop a client application that accesses Skylight orchestrator functionality, you should read the online documentation for the API.

The API documentation includes:

• Overview of the API and advice on how to program with it
• A reference section that describes the classes, methods and objects of the REST API

The online documentation is in HTML format. It is available at two different URLs depending on which REST API functionality you want to use:

• URL for API documentation related to performance sessions:

http://<soIPaddress>:9080/nbapi/doc/application.html

• URL for API documentation related to other functions (devices, inventory, configuration jobs, SAT tests and so on):

http://<soIPaddress>:9080/nbapiemswsweb/doc/

▶ To access the Skylight orchestrator web interface and API documentation
We suggest that you open the Skylight orchestrator web interface and familiarize yourself with Skylight orchestrator functionality as you consult the API documentation. Opening the web interface is also a way of checking that the Skylight orchestrator application is running, which is required to use the API.

1. Access the Skylight orchestrator web interface by entering this URL in a browser:

http://<soIPaddress>:6080/businessweb

2. When prompted for a user name and password, enter the credentials of a valid user.
   The Skylight orchestrator web interface opens. Leave it open so you can refer to it as you read the API documentation.
3. To access API documentation related to performance sessions, open a browser tab and enter this URL:

http://<soIPaddress>:9080/nbapi/doc/application.html

4. To access API documentation related to other functions, enter this URL:

http://<soIPaddress>:9080/nbapiemswsweb/doc/