Citrix DaaS REST APIs
Migrate from the preview version of Citrix DaaS REST APIs
You can migrate from the preview version of Citrix DaaS (formerly Citrix Virtual Apps and Desktops service) REST APIs. The API specifications such as the paths and request headers require updating when you migrate from the preview version.
To migrate from the preview version, modify your scripts following the API specifications and examples provided in this section.
Geographical regions
- API endpoints for use with different Citrix Cloud regions appear in the following table:
| Region | US/EU/AP-S | JP |
|---|---|---|
| Endpoint | https://api.cloud.com |
https://api.citrixcloud.jp |
API specifications
API paths
- The base path for Citrix DaaS REST APIs is changed from
/cvadapisto/cvad/manage. - APIs that took a
siteidpath parameter now no longer have thesiteidin path.
Request headers
- APIs that took a
siteidpath parameter now require aCitrix-InstanceIdrequest header instead. The header value should be thesiteidvalue.
Examples
API request without siteid path parameter
The following API request used in preview:
GET https://ap.cloud.com/cvadapis/Me HTTP/1.1
Citrix-CustomerId:
Authorization: CWSAuth Bearer=
<!--NeedCopy-->
now becomes:
GET https://api.cloud.com/cvad/manage/Me HTTP/1.1
Citrix-CustomerId:
Authorization: CWSAuth Bearer=
<!--NeedCopy-->
API request with siteid path parameter
The following API request used in preview:
GET https://api.cloud.com/cvadapis//DeliveryGroups HTTP/1.1
Citrix-CustomerId:
Authorization: CWSAuth Bearer=
<!--NeedCopy-->
now becomes:
GET https://api.cloud.com/cvad/manage/DeliveryGroups HTTP/1.1
Citrix-CustomerId:
Citrix-InstanceId:
Authorization: CWSAuth Bearer=
<!--NeedCopy-->
For more information on the request format, see the specification page of each API.
Migrate from the preview version of Citrix DaaS REST APIs
In this article
Copied!
Failed!