Getting Started

Use the following procedures to get started with the XiO Cloud® service APIs.

Enable Public API Access in XiO Cloud

Users with Global Administrator permissions can enable the XiO Cloud REST API functionality directly from the XiO Cloud portal. An Api Subscription Key value will be generated that is required for making API calls. For more information on enabling API access and obtaining a subscription key in an XiO Cloud account, refer to the XiO Cloud Service User Guide.

Sample subscription key: 9838a7e6a8df4ff3bfe358648555cfe3

Use the Subscription Key for API Calls

Customers must use the provided subscription key whenever accessing the XiO Cloud API. Observe the following points:

The subscription key must be included as part of the "XiO-subscription-key" header parameter in the HTTP client request.
-H: "XiO-subscription-key: [Subscription Key]"
An API call using the same URI and subscription key will be fulfilled no more than once every five minutes (for V1 calls) or three times within a minute (for V2 calls).
Global administrators can enable or disable API access at any time within their XiO Cloud account.

Have feedback on this document? Contact docfeedback@crestron.com.

All brand names, product names and trademarks are the property of their respective owners. Certain trademarks, registered trademarks, and trade names may be used to refer to either the entities claiming the marks and names or their products. Crestron disclaims any proprietary interest in the marks and names of others. Crestron is not responsible for errors in typography or photography. Specifications are subject to change without notice.