API Reference

The REST API interface allows configuration and device status changes to be passed to the Crestron Home® OS system. The REST API calls defined in this section are used to get and set data for different device functions and are current as of the version 3.021.0214 firmware release.

The following sections describe the various APIs that are available within the Crestron Home OS REST API interface. Each section contains the following information:

The HTTPS methods that may be issued for each API.
A list of parameters and/or request body syntax available for each HTTPS method.
Sample responses for each HTTPS method.

This section provides the following information:

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.