Citrix SD-WAN Orchestrator

API guide for Citrix SD-WAN Orchestrator

January 22, 2021

Contributed by:

C S

To access the Citrix SD-WAN Orchestrator service API Guide on the Swagger UI, you need to authenticate yourself using an API key.

The following procedure provides instructions on generating an API key and using it for authentication.

Log into your Citrix Cloud account and navigate to Identity and Access management > API Access.

Note

If you are a partner running APIs on behalf of your customer, log into the customer’s Citrix Cloud account using the Change Customer option or obtain the authentication and relevant API parameters from the customer.
Provide a name for your secure client and click Create Client. An ID and secret key is generated. Use the ID and secret to authenticate yourself when using APIs to manage your network.

Note

Download the ID and the Secret and store it securely. You cannot access the secret after closing the window.

Note

For security reasons, it is advised to delete the API Key entries from Citrix Cloud when you are done using the APIs.
Log in to the Citrix SD-WAN Orchestrator service and click ? at the top-right corner of the UI and then click API Guide.

The Swagger spec details are displayed.
Click the Swagger spec URL to access the API guide.
In the API page, navigate to auth-controller > /{ccId}/api/v1/logon > Try it out.
From the Citrix SD-WAN Orchestrator service Swagger Spec Details, copy the Citrix Cloud ID and paste it in the textbox under Citrix Cloud user ID.
Similarly, copy and paste the Client ID, Client secret and Citrix Cloud ID in the respective payload fields and click Execute.
Copy the token value from the Server response.
Click Authorize on the top of the API page and paste the token value in the Value field. Click Authorize.

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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

API guide for Citrix SD-WAN Orchestrator

January 22, 2021

Contributed by:

C S

January 22, 2021

Contributed by:

C S

API guide for Citrix SD-WAN Orchestrator

In this article