Update a monitor for a home

PATCH/homes/{homeId}/smartModules/{moduleId}/monitors/{monitorId}

Base URL: https://api.tinkermode.com

Update a monitor for this home.

Authentication

Send an Authorization header of the form ModeCloud <AUTH_CODE>.

Must contain API key of the matching user, or a Project API Key with admin permission.

Path parameters

Name	Type	Required	Description
`homeId`	integer	Yes	The unique id for a home.
`moduleId`	string	Yes	The unique id for a smart module.
`monitorId`	string	Yes	Monitor ID

Request body

Content type: application/json

Property Type Required Constraints Description

condition one of 2 No Monitor Condition object

One of the following 2 shapes:

Variant 1

Heartbeat monitoring condition against data points in a time series.

Property	Type	Required	Description
`conditionType`	string	Yes	Currently, the only supported type is `timeSeriesHeartbeat`.
`interval`	integer	Yes	Duration of time (second) how often data points are expected to appear in the time series. It should be longer than 60 seconds at least.
`seriesId`	string	Yes	Time Series ID to be monitored.

Variant 2

Threshold-based monitoring condition against static data points in a time series

Property	Type	Required	Constraints	Description
`conditionType`	string	Yes		Currently, the only supported type is `timeSeriesThreshold`
`dataPointsDuration`	integer	Yes		Expected duration of time (in seconds) between two data points
`dataPointsEvaluationPolicy`	string	Yes	one of: consecutive, total	How to count the breaching data points
`interval`	integer	Yes		How often (in seconds) the monitoring condition is evaluated
`missingDataPointPolicy`	string	Yes	one of: ignore, breaching, notBreaching	How to treat missing data
`numberOfBreachingDataPointsToAlert`	integer	Yes		Number of breaching data points before an alert is triggered
`operator`	string	Yes	one of: lessThan, lessThanOrEqualTo, equal, notEqual, greaterThanOrEqualTo, greaterThan	The operator to compare the threshold value and monitored value
`seriesId`	string	Yes		Time Series ID to be monitored
`threshold`	number	Yes		Threshold value against which the monitor evaluates whether the data point has breached the condition

description string No Monitor description

enabled boolean No Whether this monitor is enabled

evaluationDelay integer No min: 0 How long the monitor evaluation should be delayed; if this field is omitted when monitor is created, default value 0 will be applied

incidentCustomDescriptions object No User defined incident descriptions

Properties of incidentCustomDescriptions
Property	Type	Required	Constraints	Description
`alert`	string	No	read-only (server-generated)	Custom description for alert incident. If not set, default description will be 'ALERT: ${monitor.name}'
`recovery`	string	No	read-only (server-generated)	Custom description for recovery incident. If not set, default description will be 'RECOVERY: ${monitor.name}'

name string No Monitor name

Request example

{
  "condition": {
    "conditionType": "timeSeriesThreshold",
    "interval": 120,
    "seriesId": "room1_humidity"
  },
  "description": "humidity monitor",
  "enabled": true,
  "evaluationDelay": 60,
  "name": "humidity monitor"
}

Responses

`204` The monitor has been successfully updated.

`401` Authorization is required to access this resource.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`403` Request failed because of invalid data or denied permission.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`404` The requested monitor does not exist or is not accessible.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`429` Request failed because of rate limit.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`500` An unexpected error has occurred.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`503` The service is temporarily unavailable.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

Update a monitor for a home

Authentication

Path parameters

Request body

Request example

Responses

204 The monitor has been successfully updated.

401 Authorization is required to access this resource.

403 Request failed because of invalid data or denied permission.

404 The requested monitor does not exist or is not accessible.

429 Request failed because of rate limit.

500 An unexpected error has occurred.

503 The service is temporarily unavailable.

`204` The monitor has been successfully updated.

`401` Authorization is required to access this resource.

`403` Request failed because of invalid data or denied permission.

`404` The requested monitor does not exist or is not accessible.

`429` Request failed because of rate limit.

`500` An unexpected error has occurred.

`503` The service is temporarily unavailable.