OpenAPI Specifications

Welcome to the Cumulocity OpenAPI Specifications. They represent a language-agnostic interface to the Cumulocity RESTful API which allows—both humans and computers—to discover and understand the capabilities of the platform.

Cumulocity IoT uses HTTP and REST, which is today the most widely used interfacing technology and which works on any Internet-connected device ranging from small embedded microcontrollers up to desktop PCs. The secure variant, HTTPS, is used for the most security critical applications and will give you the best possible security.

Regardless of the communication originating from IoT devices, web applications or from back-office IT systems, Cumulocity IoT employs the protocol REST for all external communication. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication and verbs.

The public APIs for Cumulocity are backward compatible where possible. More information can be found in the Compatibility policy in the Cumulocity product documentation.