REST API Requirements

To use the API and view the API documentation, you need the following:

1. Skylight orchestrator appliance
• If a Skylight orchestrator appliance is available for development purposes, you will need its IP address and a user account. Default administrator account: admin, 2admin$admin
• If you need to install Skylight orchestrator (as a KVM or VMware virtual appliance), see the Administration material.
2. Skylight orchestrator user account with multiple roles
A Skylight orchestrator user can have multiple roles. To access the Skylight orchestrator web interface and use the API, you need a user account with at least two roles.
• ROLE_WS: Has permission to use Web Services (WS). This is the role required to use the REST API in your client applications. At least one other role is also required.
• ROLE_Admin: Has permission to access all Skylight orchestrator functionality (other than Web Services, the REST API, and the XML/https Export Interface). You need this role if you want to use all possible functionality in the Skylight orchestrator web interface.
• Other roles: Your client application may not need full administrator permissions. You may want to create an account with the ROLE_WS and another role that has more limited permissions. For more information about user roles, see "Managing User Accounts".
3. Web Services feature must be activated on the Skylight orchestrator appliance.
An administrator (user with ROLE_ADMIN) must import a key file for web services (obtained from Accedian Technical Support) in the Skylight orchestrator web interface. For more information, see "Activating Features".