Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ecobee Thermostat Update API

Update writable properties and run thermostat functions.

ecobee Thermostat Update API is one of 7 APIs that ecobee publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Thermostat Update. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 1 operation across 1 path, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.ecobee.com/1, https://api.ecobee.com.

1 operations 1 paths 6 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.ecobee.com/1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

ecobee Thermostat Update API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 access token passed as Authorization: Bearer ACCESSTOKEN on all data-plane requests to https://api.ecobee.com/1.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Thermostat Update 1

Update writable properties and run thermostat functions.

POST
/thermostat
Update thermostats and run functions
updateThermostats 1 param body → 200401500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Thermostat (10 properties), Selection (9 properties), UpdateThermostatRequest (3 properties), Status (2 properties). Each schema is shown below with its type and property counts.

Selection
object
Determines which thermostats and which sub-objects are returned or acted upon.
9 properties 1 required
Thermostat
object
10 properties
UpdateThermostatRequest
object
3 properties 1 required
StatusResponse
object
1 property
Function
object
A thermostat function to execute.
2 properties 1 required
Status
object
Standard ecobee response status.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ecobee-thermostat-update-api-openapi.yml Raw ↑

Other APIs ecobee publishes across the network.

ecobee Authorization API
ecobee Demand Response API
ecobee Group API
ecobee Hierarchy API
ecobee Reports API
ecobee Thermostat API