REST API Online Documentation
  • 21 Jun 2024
  • 1 Minute to read
  • Contributors
  • PDF

REST API Online Documentation

  • PDF

Article summary

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
  1. 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.
  2. To access API documentation related to performance sessions, open a browser tab and enter this URL:
http://<soIPaddress>:9080/nbapi/doc/application.html
  1. To access API documentation related to other functions, enter this URL:
http://<soIPaddress>:9080/nbapiemswsweb/doc/

© 2024 Cisco and/or its affiliates. All rights reserved.
 
For more information about trademarks, please visit: Cisco trademarks
For more information about legal terms, please visit: Cisco legal terms

For legal information about Accedian Skylight products, please visit: Accedian legal terms and tradmarks



Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.