Citrix SD-WAN Orchestrator for On-premises 11.1

API guide for Citrix SD-WAN Orchestrator for On-premises

To access the Citrix SD-WAN Orchestrator for On-premises API Guide on the Swagger UI:

  1. Log in to the Citrix SD-WAN Orchestrator for On-premises and click ? at the top-right corner of the UI and then click API Guide.

    API icon

    The Swagger spec details are displayed.

    API icon

  2. Click the Swagger spec URL to access the API guide.

  3. In the API page, navigate to auth-controller > /{ccId}/api/v1/logon > Try it out.

    Authentication controller

  4. From the Citrix SD-WAN Orchestrator for On-premises Swagger Spec Details, copy the Citrix Cloud ID and paste it in the textbox under Citrix Cloud user ID.

  5. Similarly, copy and paste the Client ID, Client secret and Citrix Cloud ID in the respective payload fields and click Execute.

    API payload

  6. Copy the token value from the Server response.

    Server response

  7. Click Authorize on the top of the API page and paste the token value in the Value field. Click Authorize.

    Authorize

    API key

This completes the authorization process and you must now be able to access and use Citrix SD-WAN Orchestrator for On-premises APIs.

API guide for Citrix SD-WAN Orchestrator for On-premises