-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathtado-openapispec-v2.yaml
5225 lines (4851 loc) · 174 KB
/
tado-openapispec-v2.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: tado API v2
description: |
Community managed API definition for the tado API hosted on https://my.tado.com/api/v2/.
This definition is not officially supported or published by tadoº.
Start with `[user] GET /me`. This will give you the id of your home and you can take it further from there.
## tadoº X support
This API is primarily meant to support homes equipped with tadoº V3 (and earlier generation) devices.
It provides limited support for tadoº X enabled homes.
API operation groups (and sometimes individual API operations) are labelled to indicate whether they support tadoº X or not:
| group label | operation label | explanation |
|------------------------|-----------------|-------------------------------------------|
| **[ ✓ tado X]** | [ + tado X] | operation group (or single operation) supports tadoº X |
| **[ ✗ tado X]** | [ NO tado X] | operation group (or single operation) does not support tadoº X |
| **[ ~ tado X]** | | some operations do supports tadoº X, others don't |
Note: when a group is labelled with **[ ~ tado X]**,
individual operations in that group are labelled as [ + tado X] or [ NO tado X]
More info: [/~https://github.com/kritsel/tado-openapispec-v2/wiki/tado-X](/~https://github.com/kritsel/tado-openapispec-v2/wiki/tado-X)
## Additional resources
* Github repo where this API definition is maintained:
[/~https://github.com/kritsel/tado-openapispec-v2](/~https://github.com/kritsel/tado-openapispec-v2)
* Wiki for this GitHub repo with additional information:
[/~https://github.com/kritsel/tado-openapispec-v2/wiki](/~https://github.com/kritsel/tado-openapispec-v2/wiki/)
version: 2.2025.02.03.0
servers:
- url: https://my.tado.com/api/v2/
security:
- oauth2: [] # no scopes
paths:
####################################################################################################################
# user paths
/me:
get:
summary: Returns information about the authenticated user, (summary) information of their home(s) and mobile devices.
operationId: getMe # hint for client code generators
tags:
- user
responses:
'200':
description: successful response
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'401':
$ref: '#/components/responses/Unauthorized401'
/homes/{homeId}/users:
get:
summary: Get all users associated with the provided homeId.
operationId: getUsers # hint for client code generators
tags:
- user
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
responses:
'200':
description: successful response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
####################################################################################################################
# mobile device paths
/homes/{homeId}/mobileDevices:
get:
summary: Get all mobile devices associated with the provided homeId
operationId: getMobileDevices # hint for client code generators
tags:
- mobile device
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
responses:
'200':
description: successful response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MobileDevice'
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
/homes/{homeId}/mobileDevices/{mobileDeviceId}:
get:
summary: Get a specific mobile device associated with the provided homeId
operationId: getMobileDevice # hint for client code generators
tags:
- mobile device
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
- in: path
name: mobileDeviceId
schema:
$ref: '#/components/schemas/MobileDeviceId'
required: true
responses:
'200':
description: successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MobileDevice'
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
delete:
summary: Remove the relationship between a mobile device and a home
operationId: deleteMobileDeviceFromHome # hint for client code generators
tags:
- mobile device
parameters:
- in: header
name: Content-Type
schema:
type: string
pattern: "application/json"
example: "application/json"
required: true
description: >
Strangely enough a 'Content-Type' header with value 'application/json'
is mandatory for this specific endpoint.
No other endpoint requires it.
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
- in: path
name: mobileDeviceId
schema:
type: integer
format: int64
required: true
description: ID of a mobile device
responses:
'200':
description: successful response
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
'404':
$ref: '#/components/responses/NotFound404'
/homes/{homeId}/mobileDevices/{mobileDeviceId}/settings:
get:
summary: Get the settings for a specific mobile device which is associated with the given home
operationId: getMobileDeviceSettings # hint for client code generators
tags:
- mobile device
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
- in: path
name: mobileDeviceId
schema:
$ref: '#/components/schemas/MobileDeviceId'
required: true
responses:
'200':
description: successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MobileDeviceSettings'
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
put:
summary: Update the settings for a specific mobile device which is associated with the given home
operationId: setMobileDeviceSettings # hint for client code generators
tags:
- mobile device
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
- in: path
name: mobileDeviceId
schema:
type: integer
format: int64
required: true
description: ID of a mobile device
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MobileDeviceSettings'
examples:
enable-geotracking:
value:
geoTrackingEnabled: true
disable-geotracking:
value:
geoTrackingEnabled: false
responses:
'200':
description: successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MobileDeviceSettings'
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
'404':
$ref: '#/components/responses/NotFound404'
'422':
$ref: '#/components/responses/InputError422'
####################################################################################################################
# home paths
/homes/{homeId}:
get:
summary: Get full details of a single home.
description: Use `GET /me` to determine the `homeId` of your home
operationId: getHome # hint for client code generators
tags:
- home
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
responses:
'200':
description: successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Home'
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
/homes/{homeId}/airComfort:
get:
summary: Get humidity and temperature indicators for all zones (rooms) in this home
description: "'Climate comfort' element in the app"
operationId: getAirComfort # hint for client code generators
tags:
- home
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
responses:
'200':
description: successful response
content:
application/json:
schema:
$ref: '#/components/schemas/AirComfort'
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
/homes/{homeId}/awayRadiusInMeters:
put:
summary: Set the geo-tracking distance.
description: >
When the distance between home location and the location of a mobile device which can control this home
is greater than this distance, tado considers the mobile device to be outside of home.
operationId: setAwayRadiusInMeters # hint for client code generators
tags:
- home
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AwayRadiusInput'
responses:
'204':
description: successful response
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
'422':
$ref: '#/components/responses/InputError422'
/homes/{homeId}/details:
put:
summary: Set home details for this home.
description: >
This endpoint expects a complete HomeDetails object,
you cannot send a partial object which only contains the properties you would like to update.
operationId: setHomeDetails # hint for client code generators
tags:
- home
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/HomeDetails'
responses:
'204':
description: successful response
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
'422':
$ref: '#/components/responses/InputError422'
/homes/{homeId}/heatingCircuits:
get:
summary: Get information about the heating circuits of this home. [ + tado X]
operationId: getHeatingCircuits # hint for client code generators
tags:
- heating circuit
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
responses:
'200':
description: successful response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/HeatingCircuit'
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
/homes/{homeId}/heatingSystem:
get:
summary: Get information about the presence of various heating systems in this home
operationId: getHeatingSystem # hint for client code generators
tags:
- home
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
responses:
'200':
description: successful response
content:
application/json:
schema:
$ref: '#/components/schemas/HeatingSystem'
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
/homes/{homeId}/heatingSystem/boiler:
put:
summary: Inform tado about the presence of a boiler in this home
description: >
When setting the boiler presence to true with a boiler id, the tado api does not seem to generate any
errors when you supply an unknown boiler id.
The resulting response of /homes/{homeId}/heatingSystem will always have boiler.id set to the supplied
boiler id value and boiler.found set to true.
The app assists the user in finding the boiler by brand and model.
This is supported by tado's graphql API, and not via the API described in this definition.
operationId: setBoiler # hint for client code generators
tags:
- home
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Boiler1'
examples:
not-present:
value:
present: false
present_no-id:
value:
present: true
present_with-id:
value:
present: true
id: 2699
responses:
'204':
description: successful response
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
'422':
$ref: '#/components/responses/InputError422'
/homes/{homeId}/heatingSystem/underfloorHeating:
put:
summary: Inform tado about the presence of underfloor heating in this home
operationId: setUnderfloorHeating # hint for client code generators
tags:
- home
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UnderfloorHeating'
examples:
not-present:
value:
present: false
present:
value:
present: true
responses:
'204':
description: successful response
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
'422':
$ref: '#/components/responses/InputError422'
/homes/{homeId}/incidentDetection:
get:
summary: Get the value of the incidentDetection setting for this home.
description: |
From [https://support.tado.com/en/articles/4467468-what-is-care-protect](https://support.tado.com/en/articles/4467468-what-is-care-protect):
If you have an Auto-Assist subscription, or if Incident Detection is included in your tado° starter kit,
then tado° will constantly monitor your heating system to let you know if something isn’t working properly.
It considers various factors, including the indoor temperature of each room, your Smart Schedule and open windows.
If there are any unexpected changes, you’ll receive a notification and be given the option
to try to identify and resolve the issue or call in a professional to do so for you.
This means you can address boiler problems as they arise, and in some cases even avoid costly repairs.
Incident Detection works with all boiler types and interfaces, however it might not detect every incident.
For instance, the tado° app won’t show bus interface errors of digitally connected boilers (e.g. regarding a broken pump).
operationId: getIncidentDetection # hint for client code generators
tags:
- home
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
responses:
'200':
description: successful response
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentDetection'
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
put:
summary: Enable or disable incident detection setting for this home.
description: >
You won't be able to enable incident detection when it is not supported for your home.
See the description for GET /homes/{homeId}/incidentDetection for more information.
operationId: setIncidentDetection # hint for client code generators
tags:
- home
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentDetectionInput'
examples:
enable:
value:
enabled: true
disable:
value:
enabled: false
responses:
'204':
description: successful response
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
'422':
$ref: '#/components/responses/InputError422'
/homes/{homeId}/flowTemperatureOptimization:
get:
summary: Get the boiler's water temperature specifics.
description: |
Only works for homes with boilers which support an OpenTherm interface.
Returns 404 otherwise.
Also see the `supportsFlowTemperatureOptimization` property in the `GET /homes/{homeId}` response.
operationId: getFlowTemperatureOptimization # hint for client code generators
tags:
- home
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
responses:
'200':
description: successful response
content:
application/json:
schema:
$ref: '#/components/schemas/FlowTemperatureOptimization'
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
'404':
$ref: '#/components/responses/NotFound404'
put:
summary: Set the boiler's water temperature specifics.
description: |
Only works for homes with boilers which support an OpenTherm interface.
Also see the `supportsFlowTemperatureOptimization` property in the `GET /homes/{homeId}` response.
This operation might be the equivalent of `PUT /homeByBridge/{bridgeId}/boilerMaxOutputTemperature`
operationId: setFlowTemperatureOptimization # hint for client code generators
tags:
- home
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FlowTemperatureOptimizationInput'
responses:
'204':
description: successful response
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
'422':
$ref: '#/components/responses/InputError422'
/homes/{homeId}/weather:
get:
summary: Get the current weather for the given home.
operationId: getWeather # hint for client code generators
tags:
- home
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
responses:
'200':
description: successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Weather'
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
####################################################################################################################
# home control paths
/homes/{homeId}/presenceLock:
put:
summary: Manually specify whether someone at home or not.
description: |
This operation sets a home's `homePresence` property.
When this property's value is `AWAY`, the AwayConfiguration of each zone will control
the (temperature) settings for that zone.
`homePresence` can also be automatically controlled via geo-tracking (requires a paid Auto-Assist subscription).
When geo-tracking is enabled, this operation overrides the `homePresence` value determined by
geo-tracking.
operationId: setPresenceLock # hint for client code generators
tags:
- home control
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PresenceLock'
examples:
HOME:
value:
homePresence: HOME
AWAY:
value:
homePresence: AWAY
responses:
'204':
description: successful empty response
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
'422': # verify
$ref: '#/components/responses/InputError422'
delete:
summary: Remove the manually set home status.
description: |
Remove the manually set `homePresence` value as set by `PUT /homes/{homeId}/presenceLock`,
handing back control of the `homePresence` value to the geo-tracking capability
enabled on the mobile devices used to control this home.
Requires a paid Auto-Assist subscription.
operationId: deletePresenceLock # hint for client code generators
tags:
- home control
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
responses:
'204':
description: successful empty response
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
'422': # verify
$ref: '#/components/responses/InputError422'
/homes/{homeId}/state:
get:
summary: Get information about the presence state of the home.
description: |
`homePresence` can be automatically controlled by enabling geo-tracking on the mobile devices used
to control the home
(see `PUT /homes/{homeId}/mobileDevices/{mobileDeviceId}/settings`,
requires a paid Auto-Assist subscription).
Or it can be set via `PUT /homes/{homeId}/presenceLock`
When its value is `AWAY`, the AwayConfiguration of each zone will control
the (temperature) settings for that zone.
operationId: getHomeState # hint for client code generators
tags:
- home control
parameters:
- in: path
name: homeId
schema:
$ref: '#/components/schemas/HomeId'
required: true
description: unique ID of a home the authenticated user has access to
responses:
'200':
description: successful response
content:
application/json:
schema:
$ref: '#/components/schemas/HomeState'
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
####################################################################################################################
# bridge paths
/bridges/{bridgeId}:
get:
summary: Retrieve Internet Bridge details.
description: >
This operation is used in the https://model-selector.tado.com/ webapp
and the 'tadoº for Installers' mobile app.
operationId: getBridge # hint for client code generators
tags:
- bridge
security: [ ] # No security
parameters:
- in: path
name: bridgeId
schema:
$ref: '#/components/schemas/BridgeId'
required: true
description: unique ID of your tado Internet Bridge
- in: query
name: authKey
schema:
type: string
example: 1234
required: true
description: printed on your tado Internet Bridge
responses:
'200':
description: successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Bridge'
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
####################################################################################################################
# boiler paths
/homeByBridge/{bridgeId}/boilerInfo:
get:
summary: Retrieve information about this home's boiler.
description: >
This operation is used in the https://model-selector.tado.com/ webapp
and the 'tadoº for Installers' mobile app.
operationId: getBoilerInfo # hint for client code generators
tags:
- home by bridge
security: [] # No security
parameters:
- in: path
name: bridgeId
schema:
$ref: '#/components/schemas/BridgeId'
required: true
description: serialNo of your tado Internet Bridge
- in: query
name: authKey
schema:
type: string
example: 1234
required: true
description: printed on your tado Internet Bridge
responses:
'200':
description: successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Boiler2'
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
'404':
$ref: '#/components/responses/NotFound404'
/homeByBridge/{bridgeId}/boilerMaxOutputTemperature:
get:
summary: Retrieve the boiler's maximum output temperature.
description: >
This operation is used in the https://model-selector.tado.com/ webapp
and the 'tadoº for Installers' mobile app.
operationId: getBoilerMaxOutputTemperature # hint for client code generators
tags:
- home by bridge
security: [] # No security
parameters:
- in: path
name: bridgeId
schema:
$ref: '#/components/schemas/BridgeId'
required: true
description: serialNo of your tado Internet Bridge
- in: query
name: authKey
schema:
type: string
example: 1234
required: true
description: printed on your tado Internet Bridge
responses:
'200':
description: successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BoilerMaxOutputTemperature'
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
'404':
$ref: '#/components/responses/NotFound404'
put:
summary: Set the boiler's maximum output temperature.
description: |
Whether this information is actually transmitted to your boiler or not
depends on the communication capabilities of your boiler and any connector solution
used between your boiler and your tado hardware.
This operation is used in the https://model-selector.tado.com/ webapp
and the 'tadoº for Installers' mobile app.
This operation could be the equivalent of `PUT /homes/{homeId}/flowTemperatureOptimization`.
operationId: setBoilerMaxOutputTemperature # hint for client code generators
tags:
- home by bridge
security: [] # No security
parameters:
- in: path
name: bridgeId
schema:
$ref: '#/components/schemas/BridgeId'
required: true
description: serialNo of your tado Internet Bridge
- in: query
name: authKey
schema:
type: string
example: 1234
required: true
description: printed on your tado Internet Bridge
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BoilerMaxOutputTemperature'
responses:
'204':
description: successful response
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
'404':
$ref: '#/components/responses/NotFound404'
'422':
$ref: '#/components/responses/InputError422'
/homeByBridge/{bridgeId}/boilerWiringInstallationState:
get:
summary: >
Retrieves information about the connection between your boiler
and the wired tado device which controls your boiler.
description: >
This operation is used in the https://model-selector.tado.com/ webapp
and the 'tadoº for Installers' mobile app.
operationId: getBoilerWiringInstallationState # hint for client code generators
tags:
- home by bridge
security: [] # No security
parameters:
- in: path
name: bridgeId
schema:
$ref: '#/components/schemas/BridgeId'
required: true
description: serialNo of your tado Internet Bridge
- in: query
name: authKey
schema:
type: string
example: 1234
required: true
description: printed on your tado Internet Bridge
responses:
'200':
description: successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BoilerWiringInstallationState'
'401':
$ref: '#/components/responses/Unauthorized401'
'403':
$ref: '#/components/responses/AccessDenied403'
'404':
$ref: '#/components/responses/NotFound404'
####################################################################################################################
# zone paths
/homes/{homeId}/zones:
get:
summary: Get all zones (a.k.a. rooms) associated with the provided homeId.
description: >
Delivers information about each zone in the given home, including the tado devices present in each zone.