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

April 5, 2022

Contributed by:

C H

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, and ccId can 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
```

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 for On-premises

April 5, 2022

Contributed by:

C H

April 5, 2022

Contributed by:

C H

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

Citrix SD-WAN Orchestrator for On-premises APIs through curl

Prerequisites

In this article