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:
-
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.
The Swagger spec details are displayed.
-
Click the Swagger spec URL to access the API guide.
Citrix SD-WAN Orchestrator for On-premises APIs through curl
Prerequisites
- Cloud login
- Local login
Perform the following steps to use Citrix On-premises orchestrator APIs through curl:
-
Cloud login: In the case of a fresh XVA, you must log in to the cloud first.
curl -k -X POST -H "Content-Type: application/json "https://<onprem-orchestrator-ip>/policy/v1/onprem/cloudLogon –data '{"clientId":"<clientId>","clientSecret":"<clientSecret> ","ccId":"<ccid>", "pop": "<popName>"}'The
clientId,clientSecret, andccIdcan be obtained from the IAM page.Note
Ensure that the customer account is already created in cloud before attempting the cloud logon.
-
Local login: Then do local login to get the auth token.
curl -k -X POST -H "Content-Type: application/json" https://<onprem-orchestrator-ip>/onpm/v1/logon --data '{"username":"admin","password":"<passwordField>"}'This returns token and customerId in response. The customerId remains fixed and it is needed in other API calls. Save the customerId for later use. The token remains valid for one hour. Later, you must perform a fresh login.
Example: Use the auth token and customerId to fire other Citrix On-premises APIs.
curl -k -X GET -H "authorization:CWSAuth bearer= <token> " -H "Content-Type: application/json"https://<onprem-orchestrator-ip>/onpm/v1/scope/<customerId>/globalSettings/ntpSettings