Citrix SD-WAN Orchestrator Service
Getting Started
To use Citrix SD-WAN Orchestrator service APIs, Citrix customer must have the following in each API request:
-
CCAuth Token: Secure HTTP requests sent to Citrix Cloud (CC) uses a custom
Authorization headerthat contains a CC bearer token. Bearer tokens are required for actions that take place on behalf of a user.
To make a request to Citrix SD-WAN Orchestrator service APIs from a client, perform the following:
- Set
Authorizationheader. - Add a JSON Payload to the request, if any.
- Send
HTTPRequest. - Handle any error responses.
- Process the response displayed in JSON.
To get Client ID and secret, see Get started with Citrix Cloud APIs and to obtain bearer, use Logon API
Request and Response
A typical Request and Response looks as follows:
POST [https://sdwan.cloud.com/massvc/policy/v1/customer/a0e23e76-e178-42b1-8aae-e156a9daf4dd/siteapi]
Request
ccid:
Authorization: CWSAuth bearer=
Content-Type: application/json
Accept: application/json
<!--NeedCopy-->
{
"address": "string",
"applianceMode": "client",
"applianceName": "string",
"applianceName2": "string",
"bandwidthTier": 0,
"cloudProvider": "string",
"cloudRegionName": "string",
"contactEmail": "string",
"contactName": "string",
"continent": "string",
"country": "string",
"cpu": 0,
"customCoordinates": true,
"defaultRoutingDomain": "string",
"edition": "AE",
"enableHa": true,
"enableSourceMacLearning": true,
"gatewayArpTimer": 0,
"hostArpTimer": 0,
"ignoreInternetWanLinkStatus": true,
"ignoreIntranetWanLinkStatus": true,
"isCloudSite": true,
"latitude": 0,
"longitude": 0,
"memory": 0,
"model": "cb1000",
"name": "string",
"region": "string",
"secureKey": "string",
"serial": "string",
"serial2": "string",
"siteProfile": "string",
"subModel": "string",
"tags": [
"string"
],
"w2wForwarding": true
}
<!--NeedCopy-->
Response 200 Created
{
"address": "string",
"applianceMode": "string",
"applianceName": "string",
"applianceName2": "string",
"bandwidthTier": 0,
"calculatedStatus": "string",
"cloudProvider": "string",
"cloudRegionName": "string",
"configuredBandwidth": 0,
"contactEmail": "string",
"contactName": "string",
"continent": "string",
"country": "string",
"cpu": 0,
"createdAt": "string",
"criticalAlertCount": 0,
"customCoordinates": true,
"customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"defaultRoutingDomain": "string",
"deployed": true,
"devices": [
{
"addOnEntitlements": [
{
"addonBandwidth": 0,
"backOfficeId": "string",
"boAvailable": 0,
"boTotal": 0,
"dateExpires": "2021-01-12T22:09:40.544Z",
"datePurchased": "2021-01-12T22:09:40.544Z",
"entitlementId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"license": {
"addOnEntitlements": [
null
],
"ccId": "string",
"createdAt": "2021-01-12T22:09:40.544Z",
"customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"lac": "string",
"orchEntitlements": [
{
"backOfficeId": "string",
"boAvailable": 0,
"boTotal": 0,
"createdAt": "2021-01-12T22:09:40.544Z",
"dateExpires": "2021-01-12T22:09:40.544Z",
"datePurchased": "2021-01-12T22:09:40.544Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"orchAvailable": 0,
"orchTotal": 0,
"sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
],
"sdwanEntitlements": [
{
"applianceEdition": "string",
"backOfficeId": "string",
"boAvailable": 0,
"boTotal": 0,
"createdAt": "2021-01-12T22:09:40.544Z",
"dateExpires": "2021-01-12T22:09:40.544Z",
"datePurchased": "2021-01-12T22:09:40.544Z",
"entitlementType": "NONE",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"orchAvailable": 0,
"orchTotal": 0,
"platform": "string",
"saDate": "2021-01-12T22:09:40.544Z",
"sdwanBandwidth": 0,
"sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
},
"orchAvailable": 0,
"orchTotal": 0,
"saDate": "2021-01-12T22:09:40.544Z",
"type": "CLOUD_DIRECT"
}
],
"addOnLicenseType": "CLOUD_DIRECT",
"agentBuild": "string",
"allocatedBandwidth": 0,
"cmDeviceStatus": "ACTIVATION_COMPLETE",
"configured": true,
"createdAt": "string",
"defaultPassword": true,
"deviceHaState": "string",
"deviceRegulatoryDomain": 0,
"deviceReportedStatus": "string",
"deviceState": "CADS_NOT_ACTIVE",
"deviceStateDetails": "string",
"deviceStatus": "string",
"entitlementId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expirationDate": "2021-01-12T22:09:40.544Z",
"firmwareBuild": "string",
"haRole": "string",
"haState": "string",
"heartbeatInterval": 0,
"heartbeatLastSeen": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"interfaceStatusList": [
{
"adminStatus": "string",
"createdAt": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"interfaceName": "string",
"interfaceType": "string",
"ipAddress": "string",
"lowerInterface": "string",
"operStatus": "string",
"updatedAt": "string"
}
],
"licenseId": "string",
"licenseType": "LICENSED",
"maintenanceMode": true,
"moreTokensAllowed": true,
"onlineStatus": "string",
"platform": "string",
"role": "string",
"saDate": "2021-01-12T22:09:40.544Z",
"serialNumber": "string",
"shortName": "string",
"siteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"softwareEdition": "string",
"stsRunning": true,
"updateLicense": true,
"updatedAt": "string",
"uptime": 0
}
],
"edition": "string",
"enableHa": true,
"enableSourceMacLearning": true,
"gatewayArpTimer": 0,
"hostArpTimer": 0,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ignoreInternetWanLinkStatus": true,
"ignoreIntranetWanLinkStatus": true,
"isCloudSite": true,
"isDeployed": true,
"latitude": 0,
"longitude": 0,
"lowAlertCount": 0,
"mediumAlertCount": 0,
"memory": 0,
"model": "string",
"name": "string",
"region": "string",
"serial": "string",
"serial2": "string",
"siteProfile": "string",
"status": "string",
"subModel": "string",
"tags": [
"string"
],
"updatedAt": "string"
}
<!--NeedCopy-->
Getting Started
In this article
Copied!
Failed!