{"__v":10,"_id":"541c74e251a68c3b45b9ade9","api":{"auth":"never","basic_auth":false,"params":[],"results":{"codes":[]},"try":true,"url":""},"body":"This documentation will allow you to control your Iro through a public API. Hopefully this will provide infinite flexibility in building Iro mashups!\n\nWe would love to hear about how you have built integrations on top of our API, send me an email at  franz@rach.io.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If you have any questions or feedback you can get support in our [public API support forum](http://community.rachio.com/c/public-api).\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/V56Wbg15QKuwIOdwB5YR_Screenshot%20from%202014-11-09%2015:55:29.png\",\n        \"Screenshot from 2014-11-09 15:55:29.png\",\n        \"244\",\n        \"258\",\n        \"#1f6d9c\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","category":"541c74e251a68c3b45b9ade7","createdAt":"2014-09-19T18:24:34.055Z","excerpt":"Welcome to the Rachio API documentation. Let's get started!","githubsync":"","hidden":false,"is_link":false,"link_external":false,"link_url":"","order":0,"project":"541c74e151a68c3b45b9ade3","slug":"getting-started","sync_unique":"","title":"Getting Started","type":"basic","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

Getting Started

Welcome to the Rachio API documentation. Let's get started!

This documentation will allow you to control your Iro through a public API. Hopefully this will provide infinite flexibility in building Iro mashups! We would love to hear about how you have built integrations on top of our API, send me an email at franz@rach.io. [block:callout] { "type": "info", "body": "If you have any questions or feedback you can get support in our [public API support forum](http://community.rachio.com/c/public-api)." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/V56Wbg15QKuwIOdwB5YR_Screenshot%20from%202014-11-09%2015:55:29.png", "Screenshot from 2014-11-09 15:55:29.png", "244", "258", "#1f6d9c", "" ] } ] } [/block]
This documentation will allow you to control your Iro through a public API. Hopefully this will provide infinite flexibility in building Iro mashups! We would love to hear about how you have built integrations on top of our API, send me an email at franz@rach.io. [block:callout] { "type": "info", "body": "If you have any questions or feedback you can get support in our [public API support forum](http://community.rachio.com/c/public-api)." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/V56Wbg15QKuwIOdwB5YR_Screenshot%20from%202014-11-09%2015:55:29.png", "Screenshot from 2014-11-09 15:55:29.png", "244", "258", "#1f6d9c", "" ] } ] } [/block]
{"__v":18,"_id":"542af66f54d88d140075ff5b","api":{"basic_auth":false,"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"Success"},{"language":"json","code":"{}","name":"Failure"}]},"try":true,"url":"","auth":"never"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Obtaining your API Token\"\n}\n[/block]\nAuthentication is done via an OAuth2 token currently provided through the Rachio webapp.\n\nLog onto the [webapp](https://app.rach.io). Click on the left side menu button with three horizontal bars. In here will be displayed your access token.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/tLPfHog2Re4c46USSZ0k_api-key_w_arrow.png\",\n        \"api-key_w_arrow.png\",\n        \"1280\",\n        \"958\",\n        \"#0badeb\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Passing your access token  in an authorization header\"\n}\n[/block]\nThe following examples shows the usage of the *Authorization* header and access token.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X GET -H \\\"Authorization:Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\\\" https://api.rach.io/1/public/person/24763e8a-4418-11e4-a183-164230d1df6\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","category":"541c74e251a68c3b45b9ade7","createdAt":"2014-09-30T18:29:03.981Z","excerpt":"","githubsync":"","hidden":false,"is_link":false,"link_url":"","order":1,"project":"541c74e151a68c3b45b9ade3","slug":"authentication","sync_unique":"","title":"Authentication","type":"basic","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

Authentication


[block:api-header] { "type": "basic", "title": "Obtaining your API Token" } [/block] Authentication is done via an OAuth2 token currently provided through the Rachio webapp. Log onto the [webapp](https://app.rach.io). Click on the left side menu button with three horizontal bars. In here will be displayed your access token. [block:image] { "images": [ { "image": [ "https://files.readme.io/tLPfHog2Re4c46USSZ0k_api-key_w_arrow.png", "api-key_w_arrow.png", "1280", "958", "#0badeb", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Passing your access token in an authorization header" } [/block] The following examples shows the usage of the *Authorization* header and access token. [block:code] { "codes": [ { "code": "curl -X GET -H \"Authorization:Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/person/24763e8a-4418-11e4-a183-164230d1df6", "language": "curl" } ] } [/block]
[block:api-header] { "type": "basic", "title": "Obtaining your API Token" } [/block] Authentication is done via an OAuth2 token currently provided through the Rachio webapp. Log onto the [webapp](https://app.rach.io). Click on the left side menu button with three horizontal bars. In here will be displayed your access token. [block:image] { "images": [ { "image": [ "https://files.readme.io/tLPfHog2Re4c46USSZ0k_api-key_w_arrow.png", "api-key_w_arrow.png", "1280", "958", "#0badeb", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Passing your access token in an authorization header" } [/block] The following examples shows the usage of the *Authorization* header and access token. [block:code] { "codes": [ { "code": "curl -X GET -H \"Authorization:Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/person/24763e8a-4418-11e4-a183-164230d1df6", "language": "curl" } ] } [/block]
{"__v":0,"_id":"5460458ded133016009b33bb","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-abc8d5c90350d\" https://api.rach.io/1/public/person/info\n","language":"curl"}]},"method":"get","params":[],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n {\n   \"id\" : \"c8d10892-fd69-48b3-8743-f111e4392d8a\"\n }\n","language":"json"}]},"try":true,"url":"/public/person/info"},"body":"","category":"5460458ded133016009b33b8","createdAt":"2014-11-10T04:56:45.988Z","excerpt":"Retrieve the id for the person entity currently logged in through OAuth.","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"is_link":false,"link_url":"","order":0,"project":"541c74e151a68c3b45b9ade3","slug":"publicpersoninfo","sync_unique":"FindPersonInfo","title":"/public/person/info","type":"get","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

get/public/person/info

Retrieve the id for the person entity currently logged in through OAuth.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":43,"_id":"5460458ded133016009b33b9","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-ab8d5c90350d\" https://api.rach.io/1/public/person/c8d10892-fd69-48b3-8743-f111e4392d8a\n","language":"curl"}]},"method":"get","params":[{"_id":"56b253068e24c10d005f690a","required":true,"desc":"Person's unique id","type":"String","name":"id","in":"path"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n   {\n     \"id\": \"3c59a593-04b8-42df-91db-758f4fe4a97f\",\n     \"username\": \"franz\",\n     \"fullName\": \"Franz Garsombke\",\n     \"email\": \"franz@rach.io\",\n     \"devices\": [\n       {\n       \"id\": \"2a5e7d3c-c140-4e2e-91a1-a212a518adc5\",\n       \"status\": \"ONLINE\",\n       \"zones\": [\n         {\n         \"id\": \"e02de192-5a2b-4669-95c6-34deea3d23cb\",\n         \"zoneNumber\": 3,\n         \"name\": \"Zone 3\",\n         \"enabled\": false,\n         \"customNozzle\": {\n         \"name\": \"Fixed Spray Head\",\n         \"imageUrl\": \"https://s3-us-west-2.amazonaws.com/rachio-api-icons/nozzle/fixed_spray.png\",\n         \"category\": \"FIXED_SPRAY_HEAD\",\n         \"inchesPerHour\": 1.4\n         },\n         \"availableWater\": 0.17,\n         \"rootZoneDepth\": 10,\n         \"managementAllowedDepletion\": 0.5,\n         \"efficiency\": 0.6,\n         \"yardAreaSquareFeet\": 1000,\n         \"irrigationAmount\": 0,\n         \"depthOfWater\": 0.85,\n         \"runtime\": 3643\n         },\n         ...\n         ],\n     \"timeZone\": \"America/Denver\",\n     \"latitude\": 39.84634,\n     \"longitude\": -105.3383,\n     \"zip\": \"80403\",\n     \"name\": \"Prototype 7\",\n     \"scheduleRules\": [\n       {\n       \"id\": \"cc9c6e6f-c285-4a7b-9911-ff6065e7ff5b\",\n       \"name\": \"\",\n       \"externalName\": \"unknown\"\n     }\n     \"serialNumber\": \"PROTOTYPE7SN\",\n     \"rainDelayExpirationDate\": 1420027691501,\n     \"rainDelayStartDate\": 1420026367029,\n     \"macAddress\": \"PROTOTYPE7MA\",\n     \"elevation\": 2376.8642578125,\n     \"webhooks\": [],\n     \"paused\": false,\n     \"on\": true,\n     \"flexScheduleRules\": [],\n     \"utcOffset\": -25200000\n     }\n   ],\n   \"enabled\": true\n   }\n","language":"json"}]},"try":true,"url":"/public/person/:id"},"body":"","category":"5460458ded133016009b33b8","createdAt":"2014-11-10T04:56:45.951Z","editedParams":true,"editedParams2":true,"excerpt":"Retrieve the information for a person entity","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"is_link":false,"link_url":"","order":1,"project":"541c74e151a68c3b45b9ade3","slug":"publicpersonid","sync_unique":"FindPersonById","title":"/public/person/:id","type":"get","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

get/public/person/:id

Retrieve the information for a person entity

Path Params

id:
required
String
Person's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":41,"_id":"546051c3809c100800b234de","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/device/99363e8a-4418-11e4-b184-164230d1df90\n","language":"curl"}]},"method":"get","params":[{"_id":"56b253028e24c10d005f68fa","required":true,"desc":"Device's unique id","type":"String","name":"id","in":"path"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n   {\n   \"id\": \"2a5e7d3c-c140-4e2e-91a1-a212a518adc5\",\n   \"status\": \"ONLINE\",\n   \"zones\": [\n     {\n     \"id\": \"e02de192-5a2b-4669-95c6-34deea3d23cb\",\n     \"zoneNumber\": 3,\n     \"name\": \"Zone 3\",\n     \"enabled\": false,\n     \"customNozzle\": {\n     \"name\": \"Fixed Spray Head\",\n     \"imageUrl\": \"https://s3-us-west-2.amazonaws.com/rachio-api-icons/nozzle/fixed_spray.png\",\n     \"category\": \"FIXED_SPRAY_HEAD\",\n     \"inchesPerHour\": 1.4\n     },\n     \"availableWater\": 0.17,\n     \"rootZoneDepth\": 10,\n     \"managementAllowedDepletion\": 0.5,\n     \"efficiency\": 0.6,\n     \"yardAreaSquareFeet\": 1000,\n     \"irrigationAmount\": 0,\n     \"depthOfWater\": 0.85,\n     \"runtime\": 3643\n     },\n     ...\n     ],\n     \"timeZone\": \"America/Denver\",\n     \"latitude\": 39.84634,\n     \"longitude\": -105.3383,\n     \"zip\": \"80403\",\n     \"name\": \"Prototype 7\",\n     \"scheduleRules\": [\n       {\n       \"id\": \"cc9c6e6f-c285-4a7b-9911-ff6065e7ff5b\",\n       \"name\": \"\",\n       \"externalName\": \"unknown\"\n       }\n   ],\n   \"serialNumber\": \"PROTOTYPE7SN\",\n   \"rainDelayExpirationDate\": 1420027691501,\n   \"rainDelayStartDate\": 1420026367029,\n   \"macAddress\": \"PROTOTYPE7MA\",\n   \"elevation\": 2376.8642578125,\n   \"webhooks\": [],\n   \"paused\": false,\n   \"on\": true,\n   \"flexScheduleRules\": [],\n   \"utcOffset\": -25200000\n   }\n","language":"json"}]},"try":true,"url":"/public/device/:id"},"body":"","category":"546051c3809c100800b234dd","createdAt":"2014-11-10T05:48:51.389Z","editedParams":true,"editedParams2":true,"excerpt":"Retrieve the information for a device entity","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"is_link":false,"link_url":"","order":0,"project":"541c74e151a68c3b45b9ade3","slug":"deviceid","sync_unique":"FindDeviceById","title":"/public/device/:id","type":"get","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

get/public/device/:id

Retrieve the information for a device entity

Path Params

id:
required
String
Device's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":25,"_id":"546d937d0f33a80800f583be","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-ab8d5c90350d\" https://api.rach.io/1/public/device/2a5e7d3c-c140-4e2e-91a1-a212a518adc5/current_schedule\n","language":"curl"}]},"method":"get","params":[{"_id":"56b253018e24c10d005f68f9","required":true,"desc":"Device's unique id","type":"String","name":"id","in":"path"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n{\n  \"deviceId\": \"2a5e7d3c-c140-4e2e-91a1-a212a518adc5\",\n  \"scheduleId\": \"ba8af494-bc32-4b34-8fa4-27bb00033477\",\n  \"type\": \"MANUAL\",\n  \"status\": \"PROCESSING\",\n  \"startDate\": 1416467043933,\n  \"duration\": 600,\n  \"zoneId\": \"710b5add-4ce1-4d10-9a73-523823c7a82b\",\n  \"zoneStartDate\": 1416467043933,\n  \"zoneDuration\": 600,\n  \"cycleCount\": 1,\n  \"totalCycleCount\": 1,\n  \"cycling\": false,\n  \"durationNoCycle\": 600\n}\n","language":"json"}]},"try":true,"url":"/public/device/:id/current_schedule"},"body":"","category":"546051c3809c100800b234dd","createdAt":"2014-11-20T07:08:45.020Z","editedParams":true,"editedParams2":true,"excerpt":"Retrieve current schedule running, if any.","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"link_external":false,"link_url":"","order":1,"project":"541c74e151a68c3b45b9ade3","slug":"publicdeviceidcurrent_schedule","sync_unique":"FindCurrentSchedule","title":"/public/device/:id/current_schedule","type":"get","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

get/public/device/:id/current_schedule

Retrieve current schedule running, if any.

Path Params

id:
required
String
Device's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":30,"_id":"546281788ba5620800710e23","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-ab8d5c90350d\" https://api.rach.io/1/public/device/2a5e7d3c-c140-4e2e-91a1-a212a518adc5/event?startTime=1414818000000&endTime=1415739608103\n","language":"curl"}]},"method":"get","params":[{"_id":"56b253028e24c10d005f68fd","required":true,"desc":"Device's unique id","type":"String","name":"id","in":"path"},{"_id":"56b253028e24c10d005f68fc","required":true,"desc":"Query start time milliseconds unix epoch","type":"Number","name":"startTime","in":"path"},{"_id":"56b253028e24c10d005f68fb","required":true,"desc":"Query end time milliseconds unix epoch","type":"Number","name":"endTime","in":"path"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n [\n {\n   \"id\": \"79af85a5-f040-4f59-9f7e-a6f06a7bb251\",\n   \"deviceId\": \"2a5e7d3c-c140-4e2e-91a1-a212a518adc5\",\n   \"category\": \"SCHEDULE\",\n   \"type\": \"SCHEDULE_STATUS\",\n   \"eventDate\": 1415677805635,\n   \"iconUrl\": \"https://s3-us-west-2.amazonaws.com/rachio-api-icons/generic-schedule-event.png\",\n   \"summary\": \"Every 3 Days at 5:00 AM with a duration of 6 minutes completed\"\n },\n {\n   \"id\": \"0082c2d6-cb2d-4509-9c18-52fa6f6225d8\",\n   \"deviceId\": \"2a5e7d3c-c140-4e2e-91a1-a212a518adc5\",\n   \"category\": \"SCHEDULE\",\n   \"type\": \"ZONE_STATUS\",\n   \"eventDate\": 1415677800664,\n   \"iconUrl\": \"https://s3-us-west-2.amazonaws.com/rachio-api-icons/watering-stopped.png\",\n   \"summary\": \"Zone 1 ya completed with a duration of 6 minutes\"\n }\n ]\n","language":"json"}]},"try":true,"url":"/public/device/:id/event?startTime=:startTime&endTime=:endTime"},"body":"","category":"546051c3809c100800b234dd","createdAt":"2014-11-11T21:36:56.864Z","editedParams":true,"editedParams2":true,"excerpt":"Retrieve events for a device entity.","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"is_link":false,"link_url":"","order":2,"project":"541c74e151a68c3b45b9ade3","slug":"publicdeviceideventstarttimestarttimeendtimeendtim","sync_unique":"FindDeviceEvents","title":"/public/device/:id/event?startTime=:startTime&endTime=:endTime","type":"get","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

get/public/device/:id/event?startTime=:startTime&endTime=:endTime

Retrieve events for a device entity.

Path Params

id:
required
String
Device's unique id
startTime:
required
Number
Query start time milliseconds unix epoch
endTime:
required
Number
Query end time milliseconds unix epoch

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":33,"_id":"546272718ba5620800710dd4","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-ab8d5c90350d\" https://api.rach.io/1/public/device/c8d10892-fd69-48b3-8743-f111e4392d8a/scheduleitem\n","language":"curl"}]},"method":"get","params":[{"_id":"56b253028e24c10d005f68fe","required":true,"desc":"Device's unique id","type":"String","name":"id","in":"path"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n [\n   {\n     \"startDate\": 1416026400000,\n     \"zones\": [\n       {\n         \"zoneId\": \"710b5add-4ce1-4d10-9a73-523823c7a82b\",\n         \"zoneNumber\": 1,\n         \"duration\": 390,\n         \"sortOrder\": 0\n       }\n     ],\n   \"scheduleRuleId\": \"fde4709a-96eb-4fe6-a054-5178a8e3f20b\",\n   \"cycleSoak\": false,\n   \"totalDuration\": 390\n   }\n ]\n","language":"json"}]},"try":true,"url":"/public/device/:id/scheduleitem"},"body":"","category":"546051c3809c100800b234dd","createdAt":"2014-11-11T20:32:49.976Z","editedParams":true,"editedParams2":true,"excerpt":"Retrieve the next two weeks of schedule items for a device entity.","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"is_link":false,"link_url":"","order":3,"project":"541c74e151a68c3b45b9ade3","slug":"publicdeviceidscheduleitem","sync_unique":"FindDeviceScheduleItems","title":"/public/device/:id/scheduleitem","type":"get","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

get/public/device/:id/scheduleitem

Retrieve the next two weeks of schedule items for a device entity.

Path Params

id:
required
String
Device's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":18,"_id":"547e4596b3f56708000b8ea4","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-ab8d5c90350d\" https://api.rach.io/1/public/device/2a5e7d3c-c140-4e2e-91a1-a212a518adc5/forecast?units=US\n","language":"curl"}]},"method":"get","params":[{"_id":"56b253038e24c10d005f6900","required":true,"desc":"Device's unique id","type":"String","name":"id","in":"path"},{"_id":"56b253038e24c10d005f68ff","required":false,"desc":"forecast data can be represented as US or METRIC units","default":"US","type":"String=\"US\",\"METRIC\"","name":"units","in":"path"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n{\n\"current\": {\n\"time\": 1417447072,\n\"precipIntensity\": 0,\n\"precipProbability\": 0,\n\"windSpeed\": 0,\n\"humidity\": 0.8,\n\"cloudCover\": 1,\n\"dewPoint\": -9,\n\"weatherType\": \"cloudy\",\n\"unitType\": \"METRIC\",\n\"currentTemperature\": -6,\n\"weatherSummary\": \"Cloudy\",\n\"dailyWeatherType\": \"OBSERVATION\",\n\"prettyTime\": \"2014-12-01T15:17:52Z\"\n},\n\" forecast\": [\n{\n  \"time\": 1417447072,\n  \"precipIntensity\": 0.21,\n  \"precipProbability\": 0.38,\n  \"temperatureMin\": -1,\n  \"temperatureMax\": 5,\n  \"windSpeed\": 18,\n  \"humidity\": 0.52,\n  \"cloudCover\": 0.53,\n  \"dewPoint\": -10,\n  \"weatherType\": \"partly-cloudy-day\",\n  \"unitType\": \"METRIC\",\n  \"weatherSummary\": \"Windy with Isolated Snow Showers\",\n  \"dailyWeatherType\": \"FORECAST\",\n  \"prettyTime\": \"2014-12-01T15:17:52Z\"\n},\n...\n]\n}\n","language":"json"}]},"try":true,"url":"/public/device/:id/forecast?units=:units"},"body":"","category":"546051c3809c100800b234dd","createdAt":"2014-12-02T23:04:54.594Z","editedParams":true,"editedParams2":true,"excerpt":"Retrieve current and predicted forecast","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"link_external":false,"link_url":"","order":4,"project":"541c74e151a68c3b45b9ade3","slug":"publicdeviceidforecastunitsunits","sync_unique":"FindForecast","title":"/public/device/:id/forecast?units=:units","type":"get","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

get/public/device/:id/forecast?units=:units

Retrieve current and predicted forecast

Path Params

id:
required
String
Device's unique id
units:
String="US","METRIC"US
forecast data can be represented as US or METRIC units

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":38,"_id":"5461820a64f4f608003ac927","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\" : \"d3e99d27-25e4-47dd-b354-1db5a84c99d7\" }' https://api.rach.io/1/public/device/stop_water\n","language":"curl"}]},"method":"put","params":[{"_id":"56b253038e24c10d005f6903","required":true,"desc":"Device's unique id","type":"String","name":"id","in":"body"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 204 No content\n","language":"json"},{"status":"4XX","name":"Error-Response:","code":"Error-Response:\n HTTP/1.1 400 Bad Request\n {\n   \"error\" : \"Missing data\", \"code\" : 301\n }\n","language":"json"}]},"try":true,"url":"/public/device/stop_water"},"body":"","category":"546051c3809c100800b234dd","createdAt":"2014-11-11T03:27:06.318Z","editedParams":true,"editedParams2":true,"excerpt":"Stop all watering on device","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"is_link":false,"link_url":"","order":5,"project":"541c74e151a68c3b45b9ade3","slug":"devicestop_water","sync_unique":"StopWater","title":"/public/device/stop_water","type":"put","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

put/public/device/stop_water

Stop all watering on device

Body Params

id:
required
String
Device's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":38,"_id":"5461820964f4f608003ac924","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\" : \"d3e99d27-25e4-47dd-b354-1db5a84c99d7\", \"duration\" : 86400 }' https://api.rach.io/1/public/device/rain_delay\n","language":"curl"}]},"method":"put","params":[{"_id":"56b253038e24c10d005f6902","required":true,"desc":"Device's unique id","type":"String","name":"id","in":"body"},{"_id":"56b253038e24c10d005f6901","required":true,"desc":"Duration in seconds (Range is 0 - 604800 (7 days) )","type":"Number","name":"duration","in":"body"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 204 No content\n","language":"json"},{"status":"4XX","name":"Error-Response:","code":"Error-Response:\n HTTP/1.1 400 Bad Request\n {\n   \"error\" : \"Missing data\", \"code\" : 301\n }\n","language":"json"}]},"try":true,"url":"/public/device/rain_delay"},"body":"","category":"546051c3809c100800b234dd","createdAt":"2014-11-11T03:27:05.898Z","editedParams":true,"editedParams2":true,"excerpt":"Rain delay device","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"is_link":false,"link_url":"","order":6,"project":"541c74e151a68c3b45b9ade3","slug":"devicerain_delay","sync_unique":"RainDelay","title":"/public/device/rain_delay","type":"put","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

put/public/device/rain_delay

Rain delay device

Body Params

id:
required
String
Device's unique id
duration:
required
Number
Duration in seconds (Range is 0 - 604800 (7 days) )

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":23,"_id":"5470bdf6691dc80800895299","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\" : \"d3e99d27-25e4-47dd-b354-1db5a84c99d7\" }' https://api.rach.io/1/public/device/on\n","language":"curl"}]},"method":"put","params":[{"_id":"56b253018e24c10d005f68f8","required":true,"desc":"Device's unique id","type":"String","name":"id","in":"body"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 204 No content\n","language":"json"},{"status":"4XX","name":"Error-Response:","code":"Error-Response:\n HTTP/1.1 400 Bad Request\n {\n   \"error\" : \"Missing data\", \"code\" : 301\n }\n","language":"json"}]},"try":true,"url":"/public/device/on"},"body":"","category":"546051c3809c100800b234dd","createdAt":"2014-11-22T16:46:46.663Z","editedParams":true,"editedParams2":true,"excerpt":"Turn ON all features of the device (schedules, weather intelligence, water budget, etc.)","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"link_external":false,"link_url":"","order":7,"project":"541c74e151a68c3b45b9ade3","slug":"publicdeviceon-1","sync_unique":"DeviceOn","title":"/public/device/on","type":"put","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

put/public/device/on

Turn ON all features of the device (schedules, weather intelligence, water budget, etc.)

Body Params

id:
required
String
Device's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":23,"_id":"5470bdf6691dc80800895297","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\" : \"d3e99d27-25e4-47dd-b354-1db5a84c99d7\" }' https://api.rach.io/1/public/device/off\n","language":"curl"}]},"method":"put","params":[{"_id":"56b253008e24c10d005f68f7","required":true,"desc":"Device's unique id","type":"String","name":"id","in":"body"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 204 No content\n","language":"json"},{"status":"4XX","name":"Error-Response:","code":"Error-Response:\n HTTP/1.1 400 Bad Request\n {\n   \"error\" : \"Missing data\", \"code\" : 301\n }\n","language":"json"}]},"try":true,"url":"/public/device/off"},"body":"","category":"546051c3809c100800b234dd","createdAt":"2014-11-22T16:46:46.184Z","editedParams":true,"editedParams2":true,"excerpt":"Turn OFF all features of the device (schedules, weather intelligence, water budget, etc.)","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"link_external":false,"link_url":"","order":8,"project":"541c74e151a68c3b45b9ade3","slug":"publicdeviceoff-1","sync_unique":"DeviceOff","title":"/public/device/off","type":"put","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

put/public/device/off

Turn OFF all features of the device (schedules, weather intelligence, water budget, etc.)

Body Params

id:
required
String
Device's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":4,"_id":"55bb86b87313650d00c46ed9","api":{"auth":"required","examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/device/99363e8a-4418-11e4-b184-164230d1df90\n","language":"curl"}]},"method":"get","params":[{"_id":"56b253098e24c10d005f6910","required":true,"desc":"Zone's unique id","type":"String","name":"id","in":"path"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n {\n \"id\": \"2a5e7d3c-c140-4e2e-91a1-a212a518adc5\",\n \"zoneNumber\": 3,\n \"name\": \"Zone 3\",\n \"enabled\": false,\n \"customNozzle\": {\n   \"name\": \"Fixed Spray Head\",\n   \"imageUrl\": \"https://s3-us-west-2.amazonaws.com/rachio-api-icons/nozzle/fixed_spray.png\",\n   \"category\": \"FIXED_SPRAY_HEAD\",\n   \"inchesPerHour\": 1.4\n  }\n }\n","language":"json"}]},"url":"/public/zone/:id"},"body":"","category":"54605b9ff3a81622001a4318","createdAt":"2015-07-31T14:31:20.706Z","editedParams":true,"editedParams2":true,"excerpt":"Retrieve the information for a zone entity","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"link_external":false,"link_url":"","order":0,"project":"541c74e151a68c3b45b9ade3","slug":"publiczoneid","sync_unique":"FindZoneById","title":"/public/zone/:id","type":"get","updates":[],"version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

get/public/zone/:id

Retrieve the information for a zone entity

Path Params

id:
required
String
Zone's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":40,"_id":"54605b9ff3a81622001a431b","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\" : \"d3e99d27-25e4-47dd-b354-1db5a84c99d7\", \"duration\" : 60 }' https://api.rach.io/1/public/zone/start\n","language":"curl"}]},"method":"put","params":[{"_id":"56b253098e24c10d005f6913","required":true,"desc":"Zone's unique id","type":"String","name":"id","in":"body"},{"_id":"56b253098e24c10d005f6912","required":true,"desc":"Duration in seconds (Range is 0 - 10800 (3 Hours) )","type":"Number","name":"duration","in":"body"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 204 No content\n","language":"json"},{"status":"4XX","name":"Error-Response:","code":"Error-Response:\n HTTP/1.1 400 Bad Request\n {\n   \"error\" : \"Missing data\", \"code\" : 301\n }\n","language":"json"}]},"try":true,"url":"/public/zone/start"},"body":"","category":"54605b9ff3a81622001a4318","createdAt":"2014-11-10T06:30:55.339Z","editedParams":true,"editedParams2":true,"excerpt":"Start a zone","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"is_link":false,"link_url":"","order":1,"project":"541c74e151a68c3b45b9ade3","slug":"zonestart","sync_unique":"StartZone","title":"/public/zone/start","type":"put","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

put/public/zone/start

Start a zone

Body Params

id:
required
String
Zone's unique id
duration:
required
Number
Duration in seconds (Range is 0 - 10800 (3 Hours) )

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":18,"_id":"547e459ab3f56708000b8eb3","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"zones\" : [{ \"id\" : \"d8913f51-3af5-41e8-b526-7c2da3646309\", \"duration\" : 10, \"sortOrder\" : 1 }] }' https://api.rach.io/1/public/zone/start_multiple\n","language":"curl"}]},"method":"put","params":[{"_id":"56b253098e24c10d005f6911","required":true,"desc":"Zone's unique id, duration, and sort order","type":"Object[]","name":"zoneRunDurations","in":"body"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 204 No content\n","language":"json"},{"status":"4XX","name":"Error-Response:","code":"Error-Response:\n HTTP/1.1 400 Bad Request\n {\n   \"error\" : \"Missing data\", \"code\" : 301\n }\n","language":"json"}]},"try":true,"url":"/public/zone/start_multiple"},"body":"","category":"54605b9ff3a81622001a4318","createdAt":"2014-12-02T23:04:58.764Z","editedParams":true,"editedParams2":true,"excerpt":"Start multiple zones","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"link_external":false,"link_url":"","order":2,"project":"541c74e151a68c3b45b9ade3","slug":"publiczonestart_multiple","sync_unique":"StartMultipleZone","title":"/public/zone/start_multiple","type":"put","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

put/public/zone/start_multiple

Start multiple zones

Body Params

zoneRunDurations:
required
Object[]
Zone's unique id, duration, and sort order

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":3,"_id":"55bb9794a8400c2d00873e9f","api":{"auth":"required","examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization:8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/schedulerule/99363e8a-4418-11e4-b184-164230d1df90\n","language":"curl"}]},"method":"get","params":[{"_id":"56b253078e24c10d005f690b","required":true,"desc":"ScheduleRule's unique id","type":"String","name":"id","in":"path"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n   {\n \"id\": \"f887ce96-3103-4774-9de9-6c66a725de18\",\n \"zones\": [\n {\n \"zoneId\": \"1455bba1-0659-4662-91ff-2c1f1e2e9e01\",\n \"zoneNumber\": 1,\n \"duration\": 300,\n \"sortOrder\": 0\n },\n {\n \"zoneId\": \"4d66d57e-b207-462d-bba1-e7e15d61afd9\",\n \"zoneNumber\": 4,\n \"duration\": 300,\n \"sortOrder\": 3\n },\n {\n \"zoneId\": \"688e07b5-578f-442f-af8c-2b2dcc2dae97\",\n \"zoneNumber\": 5,\n \"duration\": 300,\n \"sortOrder\": 4\n },\n {\n \"zoneId\": \"745c6c55-73be-439f-b856-0b5d2cfcc488\",\n \"zoneNumber\": 3,\n \"duration\": 300,\n \"sortOrder\": 2\n },\n {\n \"zoneId\": \"450199ae-f952-469e-9e10-0be81547109b\",\n \"zoneNumber\": 2,\n \"duration\": 300,\n \"sortOrder\": 1\n }\n ],\n \"scheduleJobTypes\": [\n \"DAY_OF_WEEK_3\"\n ],\n \"summary\": \"Every Wed at 9:05 AM\",\n \"rainDelay\": true,\n \"waterBudget\": false,\n \"cycleSoakStatus\": \"ON\",\n \"startDate\": 1437677593983,\n \"name\": \"Every Wed at 9:05 AM\",\n \"enabled\": true,\n \"totalDuration\": 1500,\n \"weatherIntelligenceSensitivity\": 0.25,\n \"seasonalAdjustment\": 0,\n \"totalDurationNoCycle\": 1500,\n \"cycles\": 1,\n \"externalName\": \"Every Wed at 9:05 AM\",\n \"cycleSoak\": true\n }\n","language":"json"}]},"url":"/public/schedulerule/:id"},"body":"","category":"5461820964f4f608003ac922","createdAt":"2015-07-31T15:43:16.778Z","editedParams":true,"editedParams2":true,"excerpt":"Retrieve the information for a scheduleRule entity","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"link_external":false,"link_url":"","order":0,"project":"541c74e151a68c3b45b9ade3","slug":"publicscheduleruleid","sync_unique":"FindScheduleRuleById","title":"/public/schedulerule/:id","type":"get","updates":[],"version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

get/public/schedulerule/:id

Retrieve the information for a scheduleRule entity

Path Params

id:
required
String
ScheduleRule's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":38,"_id":"5461820b64f4f608003ac92a","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\" : \"4eab11bc-b455-472d-86de-14fe8fbcb7f9\"  }' https://api.rach.io/1/public/schedulerule/skip\n","language":"curl"}]},"method":"put","params":[{"_id":"56b253088e24c10d005f690e","required":true,"desc":"Schedule rule's unique id","type":"String","name":"id","in":"body"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 204 No content\n","language":"json"},{"status":"4XX","name":"Error-Response:","code":"Error-Response:\n HTTP/1.1 400 Bad Request\n {\n   \"error\" : \"Missing data\", \"code\" : 301\n }\n","language":"json"}]},"try":true,"url":"/public/schedulerule/skip"},"body":"","category":"5461820964f4f608003ac922","createdAt":"2014-11-11T03:27:07.260Z","editedParams":true,"editedParams2":true,"excerpt":"Skip a schedule rule (watering time)","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"is_link":false,"link_url":"","order":1,"project":"541c74e151a68c3b45b9ade3","slug":"scheduleruleskip","sync_unique":"SkipScheduleRule","title":"/public/schedulerule/skip","type":"put","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

put/public/schedulerule/skip

Skip a schedule rule (watering time)

Body Params

id:
required
String
Schedule rule's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":38,"_id":"5461820b64f4f608003ac92c","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\" : \"4eab11bc-b455-472d-86de-14fe8fbcb7f9\"  }' https://api.rach.io/1/public/schedulerule/start\n","language":"curl"}]},"method":"put","params":[{"_id":"56b253088e24c10d005f690f","required":true,"desc":"Schedule rule's unique id","type":"String","name":"id","in":"body"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 204 No content\n","language":"json"},{"status":"4XX","name":"Error-Response:","code":"Error-Response:\n HTTP/1.1 400 Bad Request\n {\n   \"error\" : \"Missing data\", \"code\" : 301\n }\n","language":"json"}]},"try":true,"url":"/public/schedulerule/start"},"body":"","category":"5461820964f4f608003ac922","createdAt":"2014-11-11T03:27:07.694Z","editedParams":true,"editedParams2":true,"excerpt":"Start a schedule rule (watering time)","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"is_link":false,"link_url":"","order":2,"project":"541c74e151a68c3b45b9ade3","slug":"schedulerulestart","sync_unique":"StartScheduleRule","title":"/public/schedulerule/start","type":"put","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

put/public/schedulerule/start

Start a schedule rule (watering time)

Body Params

id:
required
String
Schedule rule's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":9,"_id":"54c9ca0669c3390d00033a97","api":{"auth":"required","examples":{"codes":[{"name":"Example Usage:","code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\" : \"4eab11bc-b455-472d-86de-14fe8fbcb7f9\", \"adjustment\" : .2  }' https://api.rach.io/1/public/schedulerule/seasonal_adjustment\n","language":"curl"}]},"method":"put","params":[{"_id":"56b253078e24c10d005f690d","required":true,"desc":"Schedule rule's unique id","type":"String","name":"id","in":"body"},{"_id":"56b253078e24c10d005f690c","required":true,"desc":"Seasonal adjustment percent from 100% to -100% (valid data range is 1 to -1)","type":"Number","name":"adjustment","in":"body"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n     {\n       \"createDate\": 1421264613904,\n       \"lastUpdateDate\": 1422398127257,\n       \"id\": \"c0ce64a7-7af5-48ea-966f-6032ea5d3dce\",\n       \"zones\": [\n         {\n           \"zoneId\": \"710b5add-4ce1-4d10-9a73-523823c7a82b\",\n           \"zoneNumber\": 1,\n           \"duration\": 36000,\n           \"sortOrder\": 0\n         }\n       ],\n       \"scheduleJobTypes\": [\n       \"INTERVAL_3\"\n       ],\n       \"startHour\": 13,\n       \"startMinute\": 0,\n       \"endHour\": 0,\n       \"endMinute\": 0,\n       \"operator\": \"START_TIME\",\n       \"summary\": \"Every  3 Days at 1:00 pm\",\n       \"restriction\": false,\n       \"type\": \"MANUAL\",\n       \"sortOrder\": 1,\n       \"rainDelay\": true,\n       \"waterBudget\": true,\n       \"cycleSoakStatus\": \"ON\",\n       \"waterBudgetUpdateDate\": 1421953200628,\n       \"startDate\": 1421218800000,\n       \"name\": \"10 hour test\",\n       \"enabled\": true,\n       \"recalculateDurations\": true,\n       \"startDay\": 14,\n       \"startMonth\": 1,\n       \"startYear\": 2015,\n       \"totalDuration\": 56868,\n       \"weatherIntelligenceSensitivity\": 0.125,\n       \"seasonalAdjustment\": 0.4,\n       \"externalName\": \"10 hour test\"\n     }\n","language":"json"},{"status":"4XX","name":"Error-Response:","code":"Error-Response:\n HTTP/1.1 400 Bad Request\n {\n   \"error\" : \"Missing data\", \"code\" : 301\n }\n","language":"json"}]},"url":"/public/schedulerule/seasonal_adjustment"},"body":"","category":"5461820964f4f608003ac922","createdAt":"2015-01-29T05:49:58.930Z","editedParams":true,"editedParams2":true,"excerpt":"Seasonal adjustment for a schedule rule (watering time). This adjustment amount will be applied to the overall run time of the selected schedule while overriding any current adjustments.","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"link_external":false,"link_url":"","order":3,"project":"541c74e151a68c3b45b9ade3","slug":"publicscheduleruleseasonal_adjustment","sync_unique":"SeasonalAdjustmentScheduleRule","title":"/public/schedulerule/seasonal_adjustment","type":"put","updates":[],"version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

put/public/schedulerule/seasonal_adjustment

Seasonal adjustment for a schedule rule (watering time). This adjustment amount will be applied to the overall run time of the selected schedule while overriding any current adjustments.

Body Params

id:
required
String
Schedule rule's unique id
adjustment:
required
Number
Seasonal adjustment percent from 100% to -100% (valid data range is 1 to -1)

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":3,"_id":"55bb9791a8400c2d00873e97","api":{"auth":"required","examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization:8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/flexschedulerule/99363e8a-4418-11e4-b184-164230d1df90\n","language":"curl"}]},"method":"get","params":[{"_id":"56b253048e24c10d005f6904","required":true,"desc":"FlexScheduleRule's unique id","type":"String","name":"id","in":"path"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n{\n \"id\": \"6ede2d28-6823-48c7-8398-82bb07b979e3\",\n \"zones\": [\n {\n \"zoneId\": \"450199ae-f952-469e-9e10-0be81547109b\",\n \"zoneNumber\": 2,\n \"sortOrder\": 1\n },\n {\n \"zoneId\": \"745c6c55-73be-439f-b856-0b5d2cfcc488\",\n \"zoneNumber\": 3,\n \"sortOrder\": 2\n },\n {\n \"zoneId\": \"4d66d57e-b207-462d-bba1-e7e15d61afd9\",\n \"zoneNumber\": 4,\n \"sortOrder\": 3\n },\n {\n \"zoneId\": \"1455bba1-0659-4662-91ff-2c1f1e2e9e01\",\n \"zoneNumber\": 1,\n \"sortOrder\": 0\n },\n {\n \"zoneId\": \"688e07b5-578f-442f-af8c-2b2dcc2dae97\",\n \"zoneNumber\": 5,\n \"sortOrder\": 4\n },\n {\n \"zoneId\": \"91e5c36a-ca18-4118-b288-aba0a8a6fb20\",\n \"zoneNumber\": 6,\n \"sortOrder\": 5\n }\n ],\n \"scheduleJobTypes\": [\n \"ODD\"\n ],\n \"summary\": \"Odd days at 3:30 am\",\n \"cycleSoak\": true,\n \"startDate\": -61662358804000,\n \"name\": \"Flex o' rama\",\n \"enabled\": true,\n \"totalDuration\": 33016,\n \"totalDurationNoCycle\": 33016,\n \"externalName\": \"Flex o' rama\",\n \"type\": \"FLEX\"\n }\n","language":"json"}]},"url":"/public/flexschedulerule/:id"},"body":"","category":"55bb978ea8400c2d00873e89","createdAt":"2015-07-31T15:43:13.380Z","editedParams":true,"editedParams2":true,"excerpt":"Retrieve the information for a flexscheduleRule entity","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"link_external":false,"link_url":"","order":0,"project":"541c74e151a68c3b45b9ade3","slug":"publicflexscheduleruleid","sync_unique":"FindFlexScheduleRuleById","title":"/public/flexschedulerule/:id","type":"get","updates":[],"version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

get/public/flexschedulerule/:id

Retrieve the information for a flexscheduleRule entity

Path Params

id:
required
String
FlexScheduleRule's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"5474213d59fade080004c8fc","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/notification/webhook_event_type\n","language":"curl"}]},"method":"get","params":[],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n [\n   {\n     \"id\" : \"5\",\n     \"name\": \"ZONE_ACTION\",\n     \"description\" : \"Event description\",\n     \"type\" : \"WEBHOOK\"\n   }\n ]\n","language":"json"}]},"try":true,"url":"/public/notification/webhook_event_type"},"body":"","category":"546ec2a0e6147a0800c794c6","createdAt":"2014-11-25T06:27:09.911Z","excerpt":"Retrieve the list of events types that are available to any webhook for subscription","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"link_external":false,"link_url":"","order":0,"project":"541c74e151a68c3b45b9ade3","slug":"publicnotificationwebhook_event_type","sync_unique":"FindNotificationWebhookEventTypes","title":"/public/notification/webhook_event_type","type":"get","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

get/public/notification/webhook_event_type

Retrieve the list of events types that are available to any webhook for subscription

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":19,"_id":"5474213d59fade080004c8fa","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/notification/2a5e7d3c-c140-4e2e-91a1-a212a518adc5/webhook\n","language":"curl"}]},"method":"get","params":[{"_id":"56b253058e24c10d005f6906","required":true,"desc":"Device's unique id","type":"String","name":"id","in":"query"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n[\n {\n \"id\": \"7c5e7d3c-c140-4e2e-91a1-a212a518aed1\",\n \"url\": \"https://www.mydomain.com/another_webhook\",\n \"externalId\" : \"external company ID\",\n \"eventTypes\": [\n   {\n   \"name\": \"ZONE_ACTION\",\n   \"description\": \"A zone action has has occurred\"\n   },\n   {\n   \"name\": \"SCHEDULE_ACTION\",\n   \"description\": \"A schedule action has occurred\"\n   }\n  ]\n }\n]\n","language":"json"}]},"try":true,"url":"/public/notification/:deviceId/webhook"},"body":"","category":"546ec2a0e6147a0800c794c6","createdAt":"2014-11-25T06:27:09.427Z","editedParams":true,"editedParams2":true,"excerpt":"Retrieve all webhooks for a device","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"link_external":false,"link_url":"","order":1,"project":"541c74e151a68c3b45b9ade3","slug":"publicnotificationdeviceidwebhook","sync_unique":"FindAllWebhooks","title":"/public/notification/:deviceId/webhook","type":"get","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

get/public/notification/:deviceId/webhook

Retrieve all webhooks for a device

Query Params

id:
required
String
Device's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":4,"_id":"55bb86b57313650d00c46ed0","api":{"auth":"required","examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/notification/webhook/79667c29-bd07-428d-9c29-23e18b023978\n","language":"curl"}]},"method":"get","params":[{"_id":"56b253058e24c10d005f6907","required":true,"desc":"Webhook Id to fetch","type":"String","name":"id","in":"path"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n{\n\"createDate\": 1416877798305,\n\"id\": \"79667c29-bd07-428d-9c29-23e18b023978\",\n\"url\": \"https://www.mydomain.com/another_webhook\",\n\"externalId\" : \"external company ID\",\n\"eventTypes\": [\n{\n\"createDate\": 1416544265115,\n\"lastUpdateDate\": 1416544265115,\n\"id\": 1,\n\"name\": \"SCHEDULE_ACTION\",\n\"description\": \"A schedule action has occurred\",\n\"type\": \"WEBHOOK\"\n},\n{\n\"createDate\": 1416544265115,\n\"lastUpdateDate\": 1416544265115,\n\"id\": 2,\n\"name\": \"ZONE_ACTION\",\n\"description\": \"A zone action has has occurred\",\n\"type\": \"WEBHOOK\"\n}\n]\n}\n","language":"json"}]},"url":"/public/notification/webhook/:id"},"body":"","category":"546ec2a0e6147a0800c794c6","createdAt":"2015-07-31T14:31:17.639Z","editedParams":true,"editedParams2":true,"excerpt":"Get a webhook","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"link_external":false,"link_url":"","order":2,"project":"541c74e151a68c3b45b9ade3","slug":"publicnotificationwebhookid-1","sync_unique":"GetWebhook","title":"/public/notification/webhook/:id","type":"get","updates":[],"version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

get/public/notification/webhook/:id

Get a webhook

Path Params

id:
required
String
Webhook Id to fetch

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":19,"_id":"5474213c59fade080004c8f8","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X POST -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{\"device\":{\"id\":\"2a5e7d3c-c140-4e2e-91a1-a212a518adc5\"}, \"externalId\" : \"external company ID\", \"url\":\"https://www.mydomain.com/another_webhook\",\"eventTypes\":[{\"id\":\"1\"},{\"id\":\"2\"}]}' https://api.rach.io/1/public/notification/webhook\n","language":"curl"}]},"method":"post","params":[{"_id":"56b253048e24c10d005f6905","required":true,"desc":"Webhook for device","type":"Object","name":"webhook","in":"body"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n{\n\"createDate\": 1416877798305,\n\"id\": \"79667c29-bd07-428d-9c29-23e18b023978\",\n\"url\": \"https://www.mydomain.com/another_webhook\",\n\"externalId\" : \"external company ID\",\n\"eventTypes\": [\n{\n\"createDate\": 1416544265115,\n\"lastUpdateDate\": 1416544265115,\n\"id\": 1,\n\"name\": \"SCHEDULE_ACTION\",\n\"description\": \"A schedule action has occurred\",\n\"type\": \"WEBHOOK\"\n},\n{\n\"createDate\": 1416544265115,\n\"lastUpdateDate\": 1416544265115,\n\"id\": 2,\n\"name\": \"ZONE_ACTION\",\n\"description\": \"A zone action has has occurred\",\n\"type\": \"WEBHOOK\"\n}\n]\n}\n","language":"json"}]},"try":true,"url":"/public/notification/webhook"},"body":"","category":"546ec2a0e6147a0800c794c6","createdAt":"2014-11-25T06:27:08.927Z","editedParams":true,"editedParams2":true,"excerpt":"Add a webhook to a device. externalId can be used as opaque data that is tied to your company, and passed back in each webhook event response","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"link_external":false,"link_url":"","order":3,"project":"541c74e151a68c3b45b9ade3","slug":"publicnotificationwebhook","sync_unique":"AddWebhook","title":"/public/notification/webhook","type":"post","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

post/public/notification/webhook

Add a webhook to a device. externalId can be used as opaque data that is tied to your company, and passed back in each webhook event response

Body Params

webhook:
required
Object
Webhook for device

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":20,"_id":"5474208959fade080004c8e2","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\":\"79667c29-bd07-428d-9c29-23e18b023978\", \"externalId\" : \"external company ID\", \"url\":\"https://www.mydomain.com/another_webhook_new_url\",\"eventTypes\":[{\"id\":\"1\"},{\"id\":\"2\"}]}' https://api.rach.io/1/public/notification/webhook\n","language":"curl"}]},"method":"put","params":[{"_id":"56b253068e24c10d005f6909","required":true,"desc":"Webhook for device","type":"Object","name":"webhook","in":"body"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n{\n\"createDate\": 1416877798305,\n\"id\": \"79667c29-bd07-428d-9c29-23e18b023978\",\n\"url\": \"https://www.mydomain.com/another_webhook\",\n\"externalId\" : \"external company ID\",\n\"eventTypes\": [\n{\n\"createDate\": 1416544265115,\n\"lastUpdateDate\": 1416544265115,\n\"id\": 1,\n\"name\": \"SCHEDULE_ACTION\",\n\"description\": \"A schedule action has occurred\",\n\"type\": \"WEBHOOK\"\n},\n{\n\"createDate\": 1416544265115,\n\"lastUpdateDate\": 1416544265115,\n\"id\": 2,\n\"name\": \"ZONE_ACTION\",\n\"description\": \"A zone action has has occurred\",\n\"type\": \"WEBHOOK\"\n}\n]\n}\n","language":"json"}]},"try":true,"url":"/public/notification/webhook"},"body":"","category":"546ec2a0e6147a0800c794c6","createdAt":"2014-11-25T06:24:09.271Z","editedParams":true,"editedParams2":true,"excerpt":"Update a webhook","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"link_external":false,"link_url":"","order":4,"project":"541c74e151a68c3b45b9ade3","slug":"publicnotificationwebhook-1","sync_unique":"UpdateWebhook","title":"/public/notification/webhook","type":"put","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

put/public/notification/webhook

Update a webhook

Body Params

webhook:
required
Object
Webhook for device

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":19,"_id":"5474213e59fade080004c8fd","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X DELETE -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/notification/webhook/79667c29-bd07-428d-9c29-23e18b023978\n","language":"curl"}]},"method":"delete","params":[{"_id":"56b253068e24c10d005f6908","required":true,"desc":"Webhook Id to remove","type":"String","name":"id","in":"path"}],"results":{"codes":[]},"try":true,"url":"/public/notification/webhook/:id"},"body":"","category":"546ec2a0e6147a0800c794c6","createdAt":"2014-11-25T06:27:10.416Z","editedParams":true,"editedParams2":true,"excerpt":"Remove a webhook","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"link_external":false,"link_url":"","order":5,"project":"541c74e151a68c3b45b9ade3","slug":"publicnotificationwebhookid","sync_unique":"RemoveWebhook","title":"/public/notification/webhook/:id","type":"delete","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

delete/public/notification/webhook/:id

Remove a webhook

Path Params

id:
required
String
Webhook Id to remove

Definition

{{ api_url }}{{ page_api_url }}

Examples



{"__v":1,"_id":"545feeb91604950800a0144c","api":{"auth":"never","basic_auth":false,"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"try":true,"url":""},"body":"If you have any questions or feedback you can get support in our [public API support forum](http://community.rachio.com/c/public-api).","category":"545fee705884720800d64f95","createdAt":"2014-11-09T22:46:17.678Z","excerpt":"","githubsync":"","hidden":false,"is_link":false,"link_external":false,"link_url":"","order":0,"project":"541c74e151a68c3b45b9ade3","slug":"forum","sync_unique":"","title":"Forum","type":"basic","updates":[],"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","childrenPages":[]}

Forum


If you have any questions or feedback you can get support in our [public API support forum](http://community.rachio.com/c/public-api).
If you have any questions or feedback you can get support in our [public API support forum](http://community.rachio.com/c/public-api).