Google Git
Sign in
eclipse / gerrit / www.eclipse.org / hono / d107b6f0b3c29befb6aab5fc3137cd268144201f / . / docs / 1.5 / api / device-registration / index.html
blob: 47521680914417013984baf7c1eb2fa2dd4fffd2 [file] [log] [blame]
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1<!DOCTYPE html>
2<html lang="1.5" class="js csstransforms3d">
3 <head>
4 <meta charset="utf-8">
5 <meta name="viewport" content="width=device-width, initial-scale=1.0">
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]6 <meta name="generator" content="Hugo 0.81.0" />
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]7 <meta name="description" content="A set of micro-services for connecting millions of devices.">
8<meta name="author" content="The Eclipse Hono Project">
9
10 <link rel="apple-touch-icon" sizes="180x180" href="/hono/docs/favicon/apple-touch-icon.png">
11<link rel="icon" type="image/png" sizes="48x48" href="/hono/docs/favicon/favicon-48x48.png">
12<link rel="icon" type="image/png" sizes="32x32" href="/hono/docs/favicon/favicon-32x32.png">
13<link rel="icon" type="image/png" sizes="16x16" href="/hono/docs/favicon/favicon-16x16.png">
14<link rel="manifest" href="/hono/docs/favicon/site.webmanifest">
15<link rel="mask-icon" href="/hono/docs/favicon/safari-pinned-tab.svg" color="#5bbad5">
16<link rel="shortcut icon" href="/hono/docs/favicon/favicon.ico">
17<meta name="msapplication-TileColor" content="#da532c">
18<meta name="msapplication-config" content="/hono/docs/favicon/browserconfig.xml">
19<meta name="theme-color" content="#ffffff">
20
21 <title>Device Registration API Specification :: Eclipse Hono&trade; Vers.: 1.5</title>
22
23
Hono Botd107b6f2021-07-28 01:13:41 +0000[diff] [blame^]24 <link href="/hono/docs/css/nucleus.css?1627434793" rel="stylesheet">
25 <link href="/hono/docs/css/fontawesome-all.min.css?1627434793" rel="stylesheet">
26 <link href="/hono/docs/css/hybrid.css?1627434793" rel="stylesheet">
27 <link href="/hono/docs/css/featherlight.min.css?1627434793" rel="stylesheet">
28 <link href="/hono/docs/css/perfect-scrollbar.min.css?1627434793" rel="stylesheet">
29 <link href="/hono/docs/css/auto-complete.css?1627434793" rel="stylesheet">
30 <link href="/hono/docs/css/atom-one-dark-reasonable.css?1627434793" rel="stylesheet">
31 <link href="/hono/docs/css/theme.css?1627434793" rel="stylesheet">
32 <link href="/hono/docs/css/hugo-theme.css?1627434793" rel="stylesheet">
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]33
Hono Botd107b6f2021-07-28 01:13:41 +0000[diff] [blame^]34 <link href="/hono/docs/css/theme-hono.css?1627434793" rel="stylesheet">
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]35
Hono Botd107b6f2021-07-28 01:13:41 +0000[diff] [blame^]36 <link href="/hono/docs/css/hono.css?1627434793" rel="stylesheet">
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]37
Hono Botd107b6f2021-07-28 01:13:41 +0000[diff] [blame^]38 <script src="/hono/docs/js/jquery-3.3.1.min.js?1627434793"></script>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]39
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]40 <style>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]41 :root #header + #content > #left > #rlblock_left{
42 display:none !important;
43 }
44
45 :not(pre) > code + span.copy-to-clipboard {
46 display: none;
47 }
48
49 </style>
50
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]51<link rel="stylesheet" href="https://www.eclipse.org/eclipse.org-common/themes/solstice/public/stylesheets/vendor/cookieconsent/cookieconsent.min.css">
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]52
53
54<meta name="twitter:card" content="summary_large_image">
55<meta name="twitter:site" content="@EclipseHono">
56<meta name="twitter:title" content="Device Registration API Specification :: Eclipse Hono&amp;trade; Vers.: 1.5">
57<meta name="twitter:image" content="https://www.eclipse.org/hono/docs/images/twitter_image.png">
58<meta name="twitter:description" content="A set of micro-services for connecting millions of devices.">
59
60
61<meta property="og:title" content="Device Registration API Specification :: Eclipse Hono&amp;trade; Vers.: 1.5" />
62<meta property="og:type" content="website" />
63<meta property="og:url" content="https://www.eclipse.org/hono/docs/1.5/api/device-registration//" />
64<meta property="og:image" content="https://www.eclipse.org/hono/docs/images/twitter_image.png" />
65
66 </head>
67 <body class="" data-url="/hono/docs/1.5/api/device-registration/">
68 <nav id="sidebar" class="">
69
70
71
72 <div id="header-wrapper">
73 <div id="header">
74 <a href="https://www.eclipse.org/hono/">
75 <img src="/hono/docs/images/HONO-Logo_Bild-Wort_quer-w-310x120px.svg" alt="Hono logo" class="logo-img">
76</a>
77
78 </div>
79
80 <div class="searchbox">
81 <label for="search-by"><i class="fas fa-search"></i></label>
82 <input data-search-input id="search-by" type="search" placeholder="Search...">
83 <span data-search-clear=""><i class="fas fa-times"></i></span>
84</div>
85
Hono Botd107b6f2021-07-28 01:13:41 +0000[diff] [blame^]86<script type="text/javascript" src="/hono/docs/js/lunr.min.js?1627434793"></script>
87<script type="text/javascript" src="/hono/docs/js/auto-complete.js?1627434793"></script>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]88<script type="text/javascript">
89
90 var baseurl = "https:\/\/www.eclipse.org\/hono\/docs\/\/1.5";
91
92</script>
Hono Botd107b6f2021-07-28 01:13:41 +0000[diff] [blame^]93<script type="text/javascript" src="/hono/docs/js/search.js?1627434793"></script>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]94
95
96 </div>
97
98 <div class="highlightable">
99 <ul class="topics">
100
101
102
103
104
105
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]106
107
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]108
109
110
111 <li data-nav-id="/hono/docs/1.5/concepts/" title="Concepts" class="dd-item
112
113
114
115 ">
116 <a href="/hono/docs/1.5/concepts/">
117 <i class="far fa-lightbulb"></i> Concepts
118
119 </a>
120
121
122 <ul>
123
124
125
126
127
128
129
130
131
132
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]133
134
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]135
136
137
138 <li data-nav-id="/hono/docs/1.5/concepts/device-identity/" title="Device Identity" class="dd-item ">
139 <a href="/hono/docs/1.5/concepts/device-identity/">
140 Device Identity
141
142 </a>
143 </li>
144
145
146
147
148
149
150
151
152
153
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]154
155
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]156
157
158
159 <li data-nav-id="/hono/docs/1.5/concepts/tenancy/" title="Multi-Tenancy" class="dd-item ">
160 <a href="/hono/docs/1.5/concepts/tenancy/">
161 Multi-Tenancy
162
163 </a>
164 </li>
165
166
167
168
169
170
171
172
173
174
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]175
176
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]177
178
179
180 <li data-nav-id="/hono/docs/1.5/concepts/device-provisioning/" title="Device Provisioning" class="dd-item ">
181 <a href="/hono/docs/1.5/concepts/device-provisioning/">
182 Device Provisioning
183
184 </a>
185 </li>
186
187
188
189
190
191
192
193
194
195
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]196
197
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]198
199
200
201 <li data-nav-id="/hono/docs/1.5/concepts/connecting-devices/" title="Connecting Devices" class="dd-item ">
202 <a href="/hono/docs/1.5/concepts/connecting-devices/">
203 Connecting Devices
204
205 </a>
206 </li>
207
208
209
210
211
212
213
214
215
216
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]217
218
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]219
220
221
222 <li data-nav-id="/hono/docs/1.5/concepts/device-notifications/" title="Device Notifications" class="dd-item ">
223 <a href="/hono/docs/1.5/concepts/device-notifications/">
224 Device Notifications
225
226 </a>
227 </li>
228
229
230
231
232
233
234
235
236
237
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]238
239
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]240
241
242
243 <li data-nav-id="/hono/docs/1.5/concepts/command-and-control/" title="Command &amp; Control" class="dd-item ">
244 <a href="/hono/docs/1.5/concepts/command-and-control/">
245 Command &amp; Control
246
247 </a>
248 </li>
249
250
251
252
253
254
255
256
257
258
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]259
260
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]261
262
263
264 <li data-nav-id="/hono/docs/1.5/concepts/resource-limits/" title="Resource limits" class="dd-item ">
265 <a href="/hono/docs/1.5/concepts/resource-limits/">
266 Resource limits
267
268 </a>
269 </li>
270
271
272
273
274
275
276
277
278
279
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]280
281
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]282
283
284
285 <li data-nav-id="/hono/docs/1.5/concepts/connection-events/" title="Connection Events" class="dd-item ">
286 <a href="/hono/docs/1.5/concepts/connection-events/">
287 Connection Events
288
289 </a>
290 </li>
291
292
293
294
295
296
297
298 </ul>
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]299
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]300 </li>
301
302
303
304
305
306
307
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]308
309
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]310
311
312
313 <li data-nav-id="/hono/docs/1.5/user-guide/" title="User Guide" class="dd-item
314
315
316
317 ">
318 <a href="/hono/docs/1.5/user-guide/">
319 <i class="fas fa-book-reader"></i> User Guide
320
321 </a>
322
323
324 <ul>
325
326
327
328
329
330
331
332
333
334
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]335
336
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]337
338
339
340 <li data-nav-id="/hono/docs/1.5/user-guide/mongodb-based-device-registry/" title="MongoDB Based Device Registry" class="dd-item ">
341 <a href="/hono/docs/1.5/user-guide/mongodb-based-device-registry/">
342 MongoDB Based Device Registry
343
344 </a>
345 </li>
346
347
348
349
350
351
352
353
354
355
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]356
357
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]358
359
360
361 <li data-nav-id="/hono/docs/1.5/user-guide/file-based-device-registry/" title="File Based Device Registry" class="dd-item ">
362 <a href="/hono/docs/1.5/user-guide/file-based-device-registry/">
363 File Based Device Registry
364
365 </a>
366 </li>
367
368
369
370
371
372
373
374
375
376
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]377
378
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]379
380
381
382 <li data-nav-id="/hono/docs/1.5/user-guide/http-adapter/" title="HTTP Adapter" class="dd-item ">
383 <a href="/hono/docs/1.5/user-guide/http-adapter/">
384 HTTP Adapter
385
386 </a>
387 </li>
388
389
390
391
392
393
394
395
396
397
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]398
399
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]400
401
402
403 <li data-nav-id="/hono/docs/1.5/user-guide/mqtt-adapter/" title="MQTT Adapter" class="dd-item ">
404 <a href="/hono/docs/1.5/user-guide/mqtt-adapter/">
405 MQTT Adapter
406
407 </a>
408 </li>
409
410
411
412
413
414
415
416
417
418
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]419
420
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]421
422
423
424 <li data-nav-id="/hono/docs/1.5/user-guide/amqp-adapter/" title="AMQP Adapter" class="dd-item ">
425 <a href="/hono/docs/1.5/user-guide/amqp-adapter/">
426 AMQP Adapter
427
428 </a>
429 </li>
430
431
432
433
434
435
436
437
438
439
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]440
441
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]442
443
444
445 <li data-nav-id="/hono/docs/1.5/user-guide/coap-adapter/" title="CoAP Adapter" class="dd-item ">
446 <a href="/hono/docs/1.5/user-guide/coap-adapter/">
447 CoAP Adapter
448
449 </a>
450 </li>
451
452
453
454
455
456
457
458
459
460
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]461
462
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]463
464
465
466 <li data-nav-id="/hono/docs/1.5/user-guide/kura-adapter/" title="Kura Adapter" class="dd-item ">
467 <a href="/hono/docs/1.5/user-guide/kura-adapter/">
468 Kura Adapter
469
470 </a>
471 </li>
472
473
474
475
476
477
478
479
480
481
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]482
483
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]484
485
486
487 <li data-nav-id="/hono/docs/1.5/user-guide/sigfox-adapter/" title="Sigfox Adapter" class="dd-item ">
488 <a href="/hono/docs/1.5/user-guide/sigfox-adapter/">
489 Sigfox Adapter
490
491 </a>
492 </li>
493
494
495
496
497
498
499
500
501
502
503 </ul>
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]504
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]505 </li>
506
507
508
509
510
511
512
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]513
514
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]515
516
517
518 <li data-nav-id="/hono/docs/1.5/admin-guide/" title="Admin Guide" class="dd-item
519
520
521
522 ">
523 <a href="/hono/docs/1.5/admin-guide/">
524 <i class="fas fa-sliders-h"></i> Admin Guide
525
526 </a>
527
528
529 <ul>
530
531
532
533
534
535
536
537
538
539
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]540
541
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]542
543
544
545 <li data-nav-id="/hono/docs/1.5/admin-guide/common-config/" title="Common Configuration" class="dd-item ">
546 <a href="/hono/docs/1.5/admin-guide/common-config/">
547 Common Configuration
548
549 </a>
550 </li>
551
552
553
554
555
556
557
558
559
560
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]561
562
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]563
564
565
566 <li data-nav-id="/hono/docs/1.5/admin-guide/auth-server-config/" title="Auth Server Configuration" class="dd-item ">
567 <a href="/hono/docs/1.5/admin-guide/auth-server-config/">
568 Auth Server Configuration
569
570 </a>
571 </li>
572
573
574
575
576
577
578
579
580
581
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]582
583
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]584
585
586
587 <li data-nav-id="/hono/docs/1.5/admin-guide/jdbc-device-registry-config/" title="JDBC Based Device Registry Configuration" class="dd-item ">
588 <a href="/hono/docs/1.5/admin-guide/jdbc-device-registry-config/">
589 JDBC Based Device Registry Configuration
590
591 </a>
592 </li>
593
594
595
596
597
598
599
600
601
602
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]603
604
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]605
606
607
608 <li data-nav-id="/hono/docs/1.5/admin-guide/mongodb-device-registry-config/" title="MongoDB Based Device Registry Configuration" class="dd-item ">
609 <a href="/hono/docs/1.5/admin-guide/mongodb-device-registry-config/">
610 MongoDB Based Device Registry Configuration
611
612 </a>
613 </li>
614
615
616
617
618
619
620
621
622
623
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]624
625
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]626
627
628
629 <li data-nav-id="/hono/docs/1.5/admin-guide/file-based-device-registry-config/" title="File Based Device Registry Configuration" class="dd-item ">
630 <a href="/hono/docs/1.5/admin-guide/file-based-device-registry-config/">
631 File Based Device Registry Configuration
632
633 </a>
634 </li>
635
636
637
638
639
640
641
642
643
644
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]645
646
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]647
648
649
650 <li data-nav-id="/hono/docs/1.5/admin-guide/command-router-config/" title="Configuring the Command Router Service" class="dd-item ">
651 <a href="/hono/docs/1.5/admin-guide/command-router-config/">
652 Command Router Service Configuration
653
654 </a>
655 </li>
656
657
658
659
660
661
662
663
664
665
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]666
667
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]668
669
670
671 <li data-nav-id="/hono/docs/1.5/admin-guide/device-connection-config/" title="Configuring the Device Connection Service" class="dd-item ">
672 <a href="/hono/docs/1.5/admin-guide/device-connection-config/">
673 Device Connection Service Configuration
674
675 </a>
676 </li>
677
678
679
680
681
682
683
684
685
686
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]687
688
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]689
690
691
692 <li data-nav-id="/hono/docs/1.5/admin-guide/http-adapter-config/" title="HTTP Adapter Configuration" class="dd-item ">
693 <a href="/hono/docs/1.5/admin-guide/http-adapter-config/">
694 HTTP Adapter Configuration
695
696 </a>
697 </li>
698
699
700
701
702
703
704
705
706
707
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]708
709
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]710
711
712
713 <li data-nav-id="/hono/docs/1.5/admin-guide/mqtt-adapter-config/" title="MQTT Adapter Configuration" class="dd-item ">
714 <a href="/hono/docs/1.5/admin-guide/mqtt-adapter-config/">
715 MQTT Adapter Configuration
716
717 </a>
718 </li>
719
720
721
722
723
724
725
726
727
728
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]729
730
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]731
732
733
734 <li data-nav-id="/hono/docs/1.5/admin-guide/amqp-adapter-config/" title="AMQP Adapter Configuration" class="dd-item ">
735 <a href="/hono/docs/1.5/admin-guide/amqp-adapter-config/">
736 AMQP Adapter Configuration
737
738 </a>
739 </li>
740
741
742
743
744
745
746
747
748
749
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]750
751
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]752
753
754
755 <li data-nav-id="/hono/docs/1.5/admin-guide/coap-adapter-config/" title="CoAP Adapter Configuration" class="dd-item ">
756 <a href="/hono/docs/1.5/admin-guide/coap-adapter-config/">
757 CoAP Adapter Configuration
758
759 </a>
760 </li>
761
762
763
764
765
766
767
768
769
770
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]771
772
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]773
774
775
776 <li data-nav-id="/hono/docs/1.5/admin-guide/kura-adapter-config/" title="Kura Adapter Configuration" class="dd-item ">
777 <a href="/hono/docs/1.5/admin-guide/kura-adapter-config/">
778 Kura Adapter Configuration
779
780 </a>
781 </li>
782
783
784
785
786
787
788
789
790
791
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]792
793
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]794
795
796
797 <li data-nav-id="/hono/docs/1.5/admin-guide/hono-client-configuration/" title="Hono Client Configuration" class="dd-item ">
798 <a href="/hono/docs/1.5/admin-guide/hono-client-configuration/">
799 Hono Client Configuration
800
801 </a>
802 </li>
803
804
805
806
807
808
809
810
811
812
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]813
814
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]815
816
817
818 <li data-nav-id="/hono/docs/1.5/admin-guide/amqp-network-config/" title="AMQP 1.0 Messaging Network Configuration" class="dd-item ">
819 <a href="/hono/docs/1.5/admin-guide/amqp-network-config/">
820 AMQP 1.0 Messaging Network Configuration
821
822 </a>
823 </li>
824
825
826
827
828
829
830
831
832
833
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]834
835
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]836
837
838
839 <li data-nav-id="/hono/docs/1.5/admin-guide/secure_communication/" title="Secure Communication" class="dd-item ">
840 <a href="/hono/docs/1.5/admin-guide/secure_communication/">
841 Secure Communication
842
843 </a>
844 </li>
845
846
847
848
849
850
851
852
853
854
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]855
856
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]857
858
859
860 <li data-nav-id="/hono/docs/1.5/admin-guide/monitoring-tracing-config/" title="Monitoring &amp; Tracing" class="dd-item ">
861 <a href="/hono/docs/1.5/admin-guide/monitoring-tracing-config/">
862 Monitoring &amp; Tracing
863
864 </a>
865 </li>
866
867
868
869
870
871
872
873
874
875
876 </ul>
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]877
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]878 </li>
879
880
881
882
883
884
885
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]886
887
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]888
889
890
891 <li data-nav-id="/hono/docs/1.5/dev-guide/" title="Developer Guide" class="dd-item
892
893
894
895 ">
896 <a href="/hono/docs/1.5/dev-guide/">
897 <i class="fas fa-tools"></i> Developer Guide
898
899 </a>
900
901
902 <ul>
903
904
905
906
907
908
909
910
911
912
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]913
914
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]915
916
917
918 <li data-nav-id="/hono/docs/1.5/dev-guide/building_hono/" title="Building from Source" class="dd-item ">
919 <a href="/hono/docs/1.5/dev-guide/building_hono/">
920 Building from Source
921
922 </a>
923 </li>
924
925
926
927
928
929
930
931
932
933
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]934
935
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]936
937
938
939 <li data-nav-id="/hono/docs/1.5/dev-guide/amqp_adapter_client/" title="AMQP Adapter Client for Java" class="dd-item ">
940 <a href="/hono/docs/1.5/dev-guide/amqp_adapter_client/">
941 AMQP Adapter Client for Java
942
943 </a>
944 </li>
945
946
947
948
949
950
951
952
953
954
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]955
956
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]957
958
959
960 <li data-nav-id="/hono/docs/1.5/dev-guide/java_client_consumer/" title="Consuming Messages from Java" class="dd-item ">
961 <a href="/hono/docs/1.5/dev-guide/java_client_consumer/">
962 Consuming Messages from Java
963
964 </a>
965 </li>
966
967
968
969
970
971
972
973
974
975
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]976
977
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]978
979
980
981 <li data-nav-id="/hono/docs/1.5/dev-guide/custom_http_adapter/" title="Implement a Custom Hono HTTP Protocol Adapter" class="dd-item ">
982 <a href="/hono/docs/1.5/dev-guide/custom_http_adapter/">
983 Implement a Custom Hono HTTP Protocol Adapter
984
985 </a>
986 </li>
987
988
989
990
991
992
993
994 </ul>
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]995
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]996 </li>
997
998
999
1000
1001
1002
1003
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1004
1005
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1006
1007
1008
1009 <li data-nav-id="/hono/docs/1.5/api/" title="API" class="dd-item
1010 parent
1011
1012
1013 ">
1014 <a href="/hono/docs/1.5/api/">
1015 &nbsp;<i class='fas fa-plug'></i>&nbsp;API
1016
1017 </a>
1018
1019
1020 <ul>
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1031
1032
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1033
1034
1035
1036 <li data-nav-id="/hono/docs/1.5/api/telemetry/" title="Telemetry API Specification" class="dd-item ">
1037 <a href="/hono/docs/1.5/api/telemetry/">
1038 Telemetry API
1039
1040 </a>
1041 </li>
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1052
1053
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1054
1055
1056
1057 <li data-nav-id="/hono/docs/1.5/api/event/" title="Event API Specification" class="dd-item ">
1058 <a href="/hono/docs/1.5/api/event/">
1059 Event API
1060
1061 </a>
1062 </li>
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1073
1074
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1075
1076
1077
1078 <li data-nav-id="/hono/docs/1.5/api/command-and-control/" title="Command &amp; Control API Specification" class="dd-item ">
1079 <a href="/hono/docs/1.5/api/command-and-control/">
1080 Command &amp; Control API
1081
1082 </a>
1083 </li>
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1094
1095
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1096
1097
1098
1099 <li data-nav-id="/hono/docs/1.5/api/tenant/" title="Tenant API Specification" class="dd-item ">
1100 <a href="/hono/docs/1.5/api/tenant/">
1101 Tenant API
1102
1103 </a>
1104 </li>
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1115
1116
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1117
1118
1119
1120 <li data-nav-id="/hono/docs/1.5/api/command-router/" title="Command Router API Specification" class="dd-item ">
1121 <a href="/hono/docs/1.5/api/command-router/">
1122 Command Router API
1123
1124 </a>
1125 </li>
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1136
1137
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1138
1139
1140
1141 <li data-nav-id="/hono/docs/1.5/api/device-connection/" title="Device Connection API Specification" class="dd-item ">
1142 <a href="/hono/docs/1.5/api/device-connection/">
1143 Device Connection API
1144
1145 </a>
1146 </li>
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1157
1158
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1159
1160
1161
1162 <li data-nav-id="/hono/docs/1.5/api/device-registration/" title="Device Registration API Specification" class="dd-item active">
1163 <a href="/hono/docs/1.5/api/device-registration/">
1164 Device Registration API
1165
1166 </a>
1167 </li>
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1178
1179
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1180
1181
1182
1183 <li data-nav-id="/hono/docs/1.5/api/credentials/" title="Credentials API Specification" class="dd-item ">
1184 <a href="/hono/docs/1.5/api/credentials/">
1185 Credentials API
1186
1187 </a>
1188 </li>
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1199
1200
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1201
1202
1203
1204 <li data-nav-id="/hono/docs/1.5/api/authentication/" title="Authentication API Specification" class="dd-item ">
1205 <a href="/hono/docs/1.5/api/authentication/">
1206 Authentication API
1207
1208 </a>
1209 </li>
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1220
1221
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1222
1223
1224
1225 <li data-nav-id="/hono/docs/1.5/api/management/" title="Device Registry Management API Specification" class="dd-item ">
1226 <a href="/hono/docs/1.5/api/management/">
1227 Device Registry Management API
1228
1229 </a>
1230 </li>
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1241
1242
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1243
1244
1245
1246 <li data-nav-id="/hono/docs/1.5/api/metrics/" title="Metrics" class="dd-item ">
1247 <a href="/hono/docs/1.5/api/metrics/">
1248 Metrics
1249
1250 </a>
1251 </li>
1252
1253
1254
1255
1256
1257
1258
1259 </ul>
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1260
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1261 </li>
1262
1263
1264
1265
1266
1267
1268
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1269
1270
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1271
1272
1273
1274 <li data-nav-id="/hono/docs/1.5/deployment/" title="Deployment" class="dd-item
1275
1276
1277
1278 ">
1279 <a href="/hono/docs/1.5/deployment/">
1280 <i class="fas fa-shipping-fast"></i> Deployment
1281
1282 </a>
1283
1284
1285 <ul>
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1296
1297
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1298
1299
1300
1301 <li data-nav-id="/hono/docs/1.5/deployment/helm-based-deployment/" title="Helm based Deployment" class="dd-item ">
1302 <a href="/hono/docs/1.5/deployment/helm-based-deployment/">
1303 Helm based Deployment
1304
1305 </a>
1306 </li>
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1317
1318
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1319
1320
1321
1322 <li data-nav-id="/hono/docs/1.5/deployment/openshift/" title="OpenShift / OKD" class="dd-item ">
1323 <a href="/hono/docs/1.5/deployment/openshift/">
1324 OpenShift / OKD
1325
1326 </a>
1327 </li>
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1338
1339
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1340
1341
1342
1343 <li data-nav-id="/hono/docs/1.5/deployment/create-kubernetes-cluster/" title="Setting up a Kubernetes Cluster" class="dd-item ">
1344 <a href="/hono/docs/1.5/deployment/create-kubernetes-cluster/">
1345 Setting up a Kubernetes Cluster
1346
1347 </a>
1348 </li>
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1359
1360
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1361
1362
1363
1364 <li data-nav-id="/hono/docs/1.5/deployment/resource-limitation/" title="Limiting Resource Usage" class="dd-item ">
1365 <a href="/hono/docs/1.5/deployment/resource-limitation/">
1366 Limiting Resource Usage
1367
1368 </a>
1369 </li>
1370
1371
1372
1373
1374
1375
1376
1377 </ul>
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1378
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1379 </li>
1380
1381
1382
1383
1384
1385
1386
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1387
1388
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1389
1390
1391
1392 <li data-nav-id="/hono/docs/1.5/architecture/" title="Architecture" class="dd-item
1393
1394
1395
1396 ">
1397 <a href="/hono/docs/1.5/architecture/">
1398 <i class="fas fa-landmark"></i> Architecture
1399
1400 </a>
1401
1402
1403 <ul>
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1414
1415
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1416
1417
1418
1419 <li data-nav-id="/hono/docs/1.5/architecture/component-view/" title="Component View" class="dd-item ">
1420 <a href="/hono/docs/1.5/architecture/component-view/">
1421 Component View
1422
1423 </a>
1424 </li>
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1435
1436
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1437
1438
1439
1440 <li data-nav-id="/hono/docs/1.5/architecture/auth/" title="Authentication/Authorization" class="dd-item ">
1441 <a href="/hono/docs/1.5/architecture/auth/">
1442 Authentication/Authorization
1443
1444 </a>
1445 </li>
1446
1447
1448
1449
1450
1451
1452
1453 </ul>
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1454
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1455 </li>
1456
1457
1458
1459
1460
1461 </ul>
1462
1463
1464
1465 <section id="shortcuts">
1466 <h3></h3>
1467 <ul>
1468
1469 <li>
1470 <a class="padding" href="https://www.eclipse.org/hono/" title="Hono&#39;s Homepage"><i class='fas fa-home'></i> Hono Home</a>
1471 </li>
1472
1473 <li>
1474 <a class="padding" href="https://www.eclipse.org/hono/getting-started/" title="Getting started with Eclipse Hono"><i class='fas fa-plane-departure'></i> Getting Started</a>
1475 </li>
1476
1477 </ul>
1478 </section>
1479
1480
1481
1482 <section id="prefooter">
1483 <hr/>
1484 <ul>
1485
1486 <li>
1487 <div id="select-box-wrapper">
1488 <div id="select-box">
1489 <a class="padding">
1490 Version:&nbsp;
1491 <div class="select-style">
1492 <select id="select-language" onchange="location = this.value;">
1493
1494
1495
1496
1497
1498
1499
1500
Hono Bot8fa7d952021-07-14 01:12:12 +0000[diff] [blame]1501 <option id="stable" value="https://www.eclipse.org/hono/docs/api/device-registration/">stable (1.9)</option>
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535 <option id="1.9" value="https://www.eclipse.org/hono/docs/1.9/api/device-registration/">1.9</option>
Hono Bot1f51cfc2021-05-21 01:12:32 +0000[diff] [blame]1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
Hono Bot8fa7d952021-07-14 01:12:12 +0000[diff] [blame]1565
1566
Hono Bot1f51cfc2021-05-21 01:12:32 +0000[diff] [blame]1567
1568
1569 <option id="1.8" value="https://www.eclipse.org/hono/docs/1.8/api/device-registration/">1.8</option>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
Hono Bot1f51cfc2021-05-21 01:12:32 +0000[diff] [blame]1597
1598
Hono Bot8fa7d952021-07-14 01:12:12 +0000[diff] [blame]1599
1600
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1601
1602
1603 <option id="1.7" value="https://www.eclipse.org/hono/docs/1.7/api/device-registration/">1.7</option>
Hono Bot650d39f2021-02-02 02:17:46 +0000[diff] [blame]1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1629
1630
Hono Bot1f51cfc2021-05-21 01:12:32 +0000[diff] [blame]1631
1632
Hono Bot8fa7d952021-07-14 01:12:12 +0000[diff] [blame]1633
1634
Hono Bot650d39f2021-02-02 02:17:46 +0000[diff] [blame]1635
1636
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1637 <option id="1.6" value="https://www.eclipse.org/hono/docs/1.6/api/device-registration/">1.6</option>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
Hono Bot650d39f2021-02-02 02:17:46 +0000[diff] [blame]1661
1662
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1663
1664
Hono Bot1f51cfc2021-05-21 01:12:32 +0000[diff] [blame]1665
1666
Hono Bot8fa7d952021-07-14 01:12:12 +0000[diff] [blame]1667
1668
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1669
1670
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1671 <option id="1.5" value="https://www.eclipse.org/hono/docs/1.5/api/device-registration/" selected>1.5</option>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
Hono Bot650d39f2021-02-02 02:17:46 +0000[diff] [blame]1695
1696
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1697
1698
Hono Bot1f51cfc2021-05-21 01:12:32 +0000[diff] [blame]1699
1700
Hono Bot8fa7d952021-07-14 01:12:12 +0000[diff] [blame]1701
1702
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1703
1704
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1705 <option id="1.4" value="https://www.eclipse.org/hono/docs/1.4/api/device-registration/">1.4</option>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
Hono Bot650d39f2021-02-02 02:17:46 +0000[diff] [blame]1729
1730
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1731
1732
Hono Bot1f51cfc2021-05-21 01:12:32 +0000[diff] [blame]1733
1734
Hono Bot8fa7d952021-07-14 01:12:12 +0000[diff] [blame]1735
1736
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1737
1738
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1739 <option id="1.3" value="https://www.eclipse.org/hono/docs/1.3/api/device-registration/">1.3</option>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
Hono Bot650d39f2021-02-02 02:17:46 +0000[diff] [blame]1763
1764
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1765
1766
Hono Bot1f51cfc2021-05-21 01:12:32 +0000[diff] [blame]1767
1768
Hono Bot8fa7d952021-07-14 01:12:12 +0000[diff] [blame]1769
1770
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1771
1772
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1773 <option id="1.2" value="https://www.eclipse.org/hono/docs/1.2/api/device-registration/">1.2</option>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
Hono Bot650d39f2021-02-02 02:17:46 +0000[diff] [blame]1797
1798
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1799
1800
Hono Bot1f51cfc2021-05-21 01:12:32 +0000[diff] [blame]1801
1802
Hono Bot8fa7d952021-07-14 01:12:12 +0000[diff] [blame]1803
1804
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1805
1806
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1807 <option id="1.1" value="https://www.eclipse.org/hono/docs/1.1/api/device-registration/">1.1</option>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
Hono Bot650d39f2021-02-02 02:17:46 +0000[diff] [blame]1831
1832
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1833
1834
Hono Bot1f51cfc2021-05-21 01:12:32 +0000[diff] [blame]1835
1836
Hono Bot8fa7d952021-07-14 01:12:12 +0000[diff] [blame]1837
1838
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1839
1840
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1841 <option id="1.0" value="https://www.eclipse.org/hono/docs/1.0/api/device-registration/">1.0</option>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
Hono Bot650d39f2021-02-02 02:17:46 +0000[diff] [blame]1865
1866
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1867
1868
Hono Bot1f51cfc2021-05-21 01:12:32 +0000[diff] [blame]1869
1870
Hono Bot8fa7d952021-07-14 01:12:12 +0000[diff] [blame]1871
1872
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1873
1874
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1875 <option id="dev" value="https://www.eclipse.org/hono/docs/dev/api/device-registration/">dev</option>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1876
1877
1878
1879
1880 </select>
1881 <svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
1882 width="255px" height="255px" viewBox="0 0 255 255" style="enable-background:new 0 0 255 255;" xml:space="preserve">
1883 <g>
1884 <g id="arrow-drop-down">
1885 <polygon points="0,63.75 127.5,191.25 255,63.75 " />
1886 </g>
1887 </g>
1888 </svg>
1889 </div>
1890 </a>
1891 </div>
1892 </div>
1893 </li>
1894
1895
1896
1897 </ul>
1898 </section>
1899
1900 <section id="footer">
1901
1902
Hono Botd9322632021-01-01 02:10:48 +0000[diff] [blame]1903<p>&copy; 2021 <a href="https://www.eclipse.org/hono/">The Eclipse Hono Project</a></p>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1904
1905<p>
1906 Documentation built with
1907 <a href="https://gohugo.io/" target="_blank">Hugo</a>
1908 using the
1909 <a href="https://github.com/matcornic/hugo-theme-learn" target="_blank">Learn</a> theme.
1910</p>
1911
1912<div class="eclipse-logo">
1913 <a href="https://www.eclipse.org" target="_blank">
1914 <img src="https://www.eclipse.org/hono/docs/images/eclipse_foundation_logo.svg"/>
1915 </a>
1916</div>
1917
1918 </section>
1919 </div>
1920</nav>
1921
1922
1923
1924
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1925 <section id="body">
1926 <div id="overlay"></div>
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1927
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1928
Hono Bot650d39f2021-02-02 02:17:46 +0000[diff] [blame]1929 <div class="old-version-hint">
1930 <p>This page refers to version <em>1.5</em>.
1931 You might want to use the <a href="https://www.eclipse.org/hono/docs/">current stable</a> version.
1932 </p>
1933 </div>
1934
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1935
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1936
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1937 <div class="padding highlightable">
1938
1939 <div>
1940 <div id="top-bar">
1941
1942
1943
1944
1945 <div id="top-github-link">
1946 <a class="github-link" title='Edit this page' href="https://github.com/eclipse/hono/edit/master/site/documentation/content/api/device-registration/index.md" target="blank">
1947 <i class="fas fa-code-branch"></i>
1948 <span id="top-github-link-text">Edit this page</span>
1949 </a>
1950 </div>
1951
1952
1953
1954 <div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
1955 <span id="sidebar-toggle-span">
1956 <a href="#" id="sidebar-toggle" data-sidebar-toggle="">
1957 <i class="fas fa-bars"></i>
1958 </a>
1959 </span>
1960
1961 <span id="toc-menu"><i class="fas fa-list-alt"></i></span>
1962
1963 <span class="links">
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977 <a href='/hono/docs/1.5/'>Documentation</a> > <a href='/hono/docs/1.5/api/'>API</a> > Device Registration API Specification
1978
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1979
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1980
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1981
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1982
1983
1984
1985 </span>
1986 </div>
1987
1988 <div class="progress">
1989 <div class="wrapper">
1990<nav id="TableOfContents">
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1991 <ul>
1992 <li><a href="#preconditions-for-invoking-the-device-registration-api">Preconditions for invoking the Device Registration API</a></li>
1993 <li><a href="#assert-device-registration">Assert Device Registration</a></li>
1994 <li><a href="#delivery-states">Delivery States</a></li>
1995 </ul>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1996</nav>
1997 </div>
1998</div>
1999
2000
2001 </div>
2002 </div>
2003
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]2004 <div id="head-tags">
2005
2006 </div>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2007
2008 <div id="body-inner">
2009
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]2010 <h1>
2011
2012 Device Registration API Specification
2013 </h1>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2014
2015
2016
2017
2018
2019<p>The <em>Device Registration API</em> is used by Hono&rsquo;s protocol adapters to get information about devices connecting to the adapters.</p>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2020<p>The Device Registration API is defined by means of AMQP 1.0 message exchanges, i.e. a client needs to connect to Hono using an AMQP 1.0 client in order to invoke operations of the API as described in the following sections.</p>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2021<p><a name="preconditions"></a></p>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2022<h2 id="preconditions-for-invoking-the-device-registration-api">Preconditions for invoking the Device Registration API</h2>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2023<ol>
2024<li>Client has established an AMQP connection with the Device Registration service.</li>
2025<li>Client has established an AMQP link in role <em>sender</em> on the connection using target address <code>registration/${tenant_id}</code>. This link is used by the client to send request messages to the Device Registration service.</li>
2026<li>Client has established an AMQP link in role <em>receiver</em> on the connection using source address <code>registration/${tenant_id}/${reply-to}</code> where <em>reply-to</em> may be any arbitrary string chosen by the client. This link is used by the client to receive responses to the requests it has sent to the Device Registration service. This link&rsquo;s source address is also referred to as the <em>reply-to</em> address for the request messages.</li>
2027</ol>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2028<figure>
2029 <img src="preconditions.svg"
2030 alt="A client establishes an AMQP connection and the links required to invoke operations of the Device Registration service"/> <figcaption>
2031 <h4>Client connecting to Device Registration service</h4>
2032 </figcaption>
2033</figure>
2034
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2035<h2 id="assert-device-registration">Assert Device Registration</h2>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2036<p>Clients use this command to verify that a device is registered for a particular tenant and is enabled.</p>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2037<p><strong>Message Flow</strong></p>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2038<p>The following sequence diagram illustrates the flow of messages involved in a <em>Client</em> asserting a device&rsquo;s registration status.</p>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2039<figure>
2040 <img src="assert_success.svg"
2041 alt="A client sends a request message for asserting a device&#39;s registration status and receives a response containing the registration status"/> <figcaption>
2042 <h4>Client asserting a device&#39;s registration status</h4>
2043 </figcaption>
2044</figure>
2045
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2046<p><strong>Request Message Format</strong></p>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2047<p>The following table provides an overview of the properties a client needs to set on a message to assert a device&rsquo;s registration status:</p>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2048<table>
2049<thead>
2050<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2051<th style="text-align:left">Name</th>
2052<th style="text-align:center">Mandatory</th>
2053<th style="text-align:left">Location</th>
2054<th style="text-align:left">AMQP Type</th>
2055<th style="text-align:left">Description</th>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2056</tr>
2057</thead>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2058<tbody>
2059<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2060<td style="text-align:left"><em>correlation-id</em></td>
2061<td style="text-align:center">no</td>
2062<td style="text-align:left"><em>properties</em></td>
2063<td style="text-align:left"><em>message-id</em></td>
2064<td style="text-align:left">MAY contain an ID used to correlate a response message to the original request. If set, it is used as the <em>correlation-id</em> property in the response, otherwise the value of the <em>message-id</em> property is used. Either this or the <em>message-id</em> property MUST be set.</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2065</tr>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2066<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2067<td style="text-align:left"><em>device_id</em></td>
2068<td style="text-align:center">yes</td>
2069<td style="text-align:left"><em>application-properties</em></td>
2070<td style="text-align:left"><em>string</em></td>
2071<td style="text-align:left">MUST contain the ID of the device that is subject to the operation.</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2072</tr>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2073<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2074<td style="text-align:left"><em>gateway_id</em></td>
2075<td style="text-align:center">no</td>
2076<td style="text-align:left"><em>application-properties</em></td>
2077<td style="text-align:left"><em>string</em></td>
2078<td style="text-align:left">The identifier of the gateway that wants to get an assertion <em>on behalf</em> of another device (given in the <em>device_id</em> property).<br>An implementation SHOULD verify that the gateway exists, is enabled and is authorized to get an assertion for, and thus send data on behalf of, the device.</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2079</tr>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2080<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2081<td style="text-align:left"><em>message-id</em></td>
2082<td style="text-align:center">no</td>
2083<td style="text-align:left"><em>properties</em></td>
2084<td style="text-align:left"><em>string</em></td>
2085<td style="text-align:left">MAY contain an identifier that uniquely identifies the message at the sender side. Either this or the <em>correlation-id</em> property MUST be set.</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2086</tr>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2087<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2088<td style="text-align:left"><em>reply-to</em></td>
2089<td style="text-align:center">yes</td>
2090<td style="text-align:left"><em>properties</em></td>
2091<td style="text-align:left"><em>string</em></td>
2092<td style="text-align:left">MUST contain the source address that the client wants to received response messages from. This address MUST be the same as the source address used for establishing the client&rsquo;s receive link (see <a href="#preconditions-for-invoking-the-device-registration-api">Preconditions</a>).</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2093</tr>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2094<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2095<td style="text-align:left"><em>subject</em></td>
2096<td style="text-align:center">yes</td>
2097<td style="text-align:left"><em>properties</em></td>
2098<td style="text-align:left"><em>string</em></td>
2099<td style="text-align:left">MUST be set to <code>assert</code>.</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2100</tr>
2101</tbody>
2102</table>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2103<p>The body of the message SHOULD be empty and will be ignored if it is not.</p>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2104<p><strong>Response Message Format</strong></p>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2105<p>The following table provides an overview of the properties contained in a response message to an <em>assert</em> request:</p>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2106<table>
2107<thead>
2108<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2109<th style="text-align:left">Name</th>
2110<th style="text-align:center">Mandatory</th>
2111<th style="text-align:left">Location</th>
2112<th style="text-align:left">AMQP Type</th>
2113<th style="text-align:left">Description</th>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2114</tr>
2115</thead>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2116<tbody>
2117<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2118<td style="text-align:left"><em>correlation-id</em></td>
2119<td style="text-align:center">yes</td>
2120<td style="text-align:left"><em>properties</em></td>
2121<td style="text-align:left"><em>message-id</em></td>
2122<td style="text-align:left">Contains the <em>message-id</em> (or the <em>correlation-id</em>, if specified) of the request message that this message is the response to.</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2123</tr>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2124<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2125<td style="text-align:left"><em>content-type</em></td>
2126<td style="text-align:center">no</td>
2127<td style="text-align:left"><em>properties</em></td>
2128<td style="text-align:left"><em>string</em></td>
2129<td style="text-align:left">MUST be set to <code>application/json</code> if the invocation of the operation was successful and the body of the response message contains payload as described below.</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2130</tr>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2131<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2132<td style="text-align:left"><em>status</em></td>
2133<td style="text-align:center">yes</td>
2134<td style="text-align:left"><em>application-properties</em></td>
2135<td style="text-align:left"><em>int</em></td>
2136<td style="text-align:left">Contains the status code indicating the outcome of the operation. Concrete values and their semantics are defined below.</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2137</tr>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2138<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2139<td style="text-align:left"><em>cache_control</em></td>
2140<td style="text-align:center">no</td>
2141<td style="text-align:left"><em>application-properties</em></td>
2142<td style="text-align:left"><em>string</em></td>
2143<td style="text-align:left">Contains an <a href="https://tools.ietf.org/html/rfc2616#section-14.9">RFC 2616</a> compliant <em>cache directive</em>. The directive contained in the property MUST be obeyed by clients that are caching responses.</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2144</tr>
2145</tbody>
2146</table>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2147<p>In case of a successful invocation of the operation, the body of the response message consists of a single <em>Data</em> section containing a UTF-8 encoded string representation of a single JSON object having the following properties:</p>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2148<table>
2149<thead>
2150<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2151<th style="text-align:left">Name</th>
2152<th style="text-align:center">Mandatory</th>
2153<th style="text-align:left">JSON Type</th>
2154<th style="text-align:left">Description</th>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2155</tr>
2156</thead>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2157<tbody>
2158<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2159<td style="text-align:left"><em>device-id</em></td>
2160<td style="text-align:center"><em>yes</em></td>
2161<td style="text-align:left"><em>string</em></td>
2162<td style="text-align:left">The ID of the device that is subject of the assertion.</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2163</tr>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2164<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2165<td style="text-align:left"><em>via</em></td>
2166<td style="text-align:center"><em>no</em></td>
2167<td style="text-align:left"><em>array</em></td>
2168<td style="text-align:left">The IDs (JSON strings) of gateways which may act on behalf of the device. This property MUST be set if any gateways are registered for the device. If the assertion request contained a <em>gateway_id</em> property and the response&rsquo;s <em>status</em> property has value <code>200</code> (indicating a successful assertion) then the array MUST at least contain the gateway ID from the request.</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2169</tr>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2170<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2171<td style="text-align:left"><em>defaults</em></td>
2172<td style="text-align:center"><em>no</em></td>
2173<td style="text-align:left"><em>object</em></td>
2174<td style="text-align:left">Default values to be used by protocol adapters for augmenting messages from devices with missing information like a <em>content type</em>. It is up to the discretion of a protocol adapter if and how to use the given default values when processing messages published by the device.</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2175</tr>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2176<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2177<td style="text-align:left"><em>mapper</em></td>
2178<td style="text-align:center"><em>no</em></td>
2179<td style="text-align:left"><em>string</em></td>
2180<td style="text-align:left">The name of a service that can be used to transform messages uploaded by the device before they are forwarded to downstream consumers. The client needs to map this name to the particular service to invoke.</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2181</tr>
2182</tbody>
2183</table>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2184<p>Below is an example for a payload of a response to an <em>assert</em> request for device <code>4711</code> which also includes a default <em>content-type</em> and a mapper service:</p>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2185<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-json" data-lang="json">{
2186 <span style="color:#f92672">&#34;device-id&#34;</span>: <span style="color:#e6db74">&#34;4711&#34;</span>,
2187 <span style="color:#f92672">&#34;via&#34;</span>: [<span style="color:#e6db74">&#34;4712&#34;</span>],
2188 <span style="color:#f92672">&#34;defaults&#34;</span>: {
2189 <span style="color:#f92672">&#34;content-type&#34;</span>: <span style="color:#e6db74">&#34;application/vnd.acme+json&#34;</span>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2190 },
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2191 <span style="color:#f92672">&#34;mapper&#34;</span>: <span style="color:#e6db74">&#34;my-payload-transformation&#34;</span>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2192}
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2193</code></pre></div><p>The response message&rsquo;s <em>status</em> property may contain the following codes:</p>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2194<table>
2195<thead>
2196<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2197<th style="text-align:left">Code</th>
2198<th style="text-align:left">Description</th>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2199</tr>
2200</thead>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2201<tbody>
2202<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2203<td style="text-align:left"><em>200</em></td>
2204<td style="text-align:left">OK, the device is registered for the given tenant and is enabled. The response message body contains the asserted device&rsquo;s registration status.</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2205</tr>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2206<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2207<td style="text-align:left"><em>400</em></td>
2208<td style="text-align:left">Bad Request, the request message did not contain all mandatory properties.</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2209</tr>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2210<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2211<td style="text-align:left"><em>403</em></td>
2212<td style="text-align:left">Forbidden, the gateway with the given <em>gateway id</em> either does not exist, is not enabled or is not authorized to get an assertion for the device with the given <em>device id</em>.</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2213</tr>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2214<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2215<td style="text-align:left"><em>404</em></td>
2216<td style="text-align:left">Not Found, there is no device registered with the given <em>device id</em> within the given <em>tenant id</em> or the device is not enabled.</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2217</tr>
2218</tbody>
2219</table>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2220<p>For status codes indicating an error (codes in the <code>400 - 499</code> range) the message body MAY contain a detailed description of the error that occurred. In this case, the response message&rsquo;s <em>content-type</em> property SHOULD be set accordingly.</p>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2221<h2 id="delivery-states">Delivery States</h2>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2222<p>The Device Registration service uses the following AMQP message delivery states when receiving request messages from clients:</p>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2223<table>
2224<thead>
2225<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2226<th style="text-align:left">Delivery State</th>
2227<th style="text-align:left">Description</th>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2228</tr>
2229</thead>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2230<tbody>
2231<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2232<td style="text-align:left"><em>ACCEPTED</em></td>
2233<td style="text-align:left">Indicates that the request message has been received and accepted for processing.</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2234</tr>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2235<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2236<td style="text-align:left"><em>REJECTED</em></td>
2237<td style="text-align:left">Indicates that the request message has been received but cannot be processed. The disposition frame&rsquo;s <em>error</em> field contains information regarding the reason why. Clients should not try to re-send the request using the same message properties in this case.</td>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2238</tr>
2239</tbody>
2240</table>
2241
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]2242<footer class="footline">
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2243
2244</footer>
2245
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]2246
2247 </div>
2248
2249
2250 </div>
2251
2252 <div id="navigation">
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261 </div>
3262
3263 </section>
3264
3265 <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
3266 <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
3267 </div>
Hono Botd107b6f2021-07-28 01:13:41 +0000[diff] [blame^]3268 <script src="/hono/docs/js/clipboard.min.js?1627434794"></script>
3269 <script src="/hono/docs/js/perfect-scrollbar.min.js?1627434794"></script>
3270 <script src="/hono/docs/js/perfect-scrollbar.jquery.min.js?1627434794"></script>
3271 <script src="/hono/docs/js/jquery.sticky.js?1627434794"></script>
3272 <script src="/hono/docs/js/featherlight.min.js?1627434794"></script>
3273 <script src="/hono/docs/js/highlight.pack.js?1627434794"></script>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]3274 <script>hljs.initHighlightingOnLoad();</script>
Hono Botd107b6f2021-07-28 01:13:41 +0000[diff] [blame^]3275 <script src="/hono/docs/js/modernizr.custom-3.6.0.js?1627434794"></script>
3276 <script src="/hono/docs/js/learn.js?1627434794"></script>
3277 <script src="/hono/docs/js/hugo-learn.js?1627434794"></script>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]3278
Hono Botd107b6f2021-07-28 01:13:41 +0000[diff] [blame^]3279 <link href="/hono/docs/mermaid/mermaid.css?1627434794" rel="stylesheet" />
3280 <script src="/hono/docs/mermaid/mermaid.js?1627434794"></script>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]3281 <script>
3282 mermaid.initialize({ startOnLoad: true });
3283 </script>
3284
3285
3286
3287
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]3288<script>
3289 (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
3290 new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
3291 j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
3292 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
3293 })(window,document,'script','dataLayer','GTM-5WLCZXC');
3294</script>
3295
3296
3297<script src="https://www.eclipse.org/eclipse.org-common/themes/solstice/public/javascript/vendor/cookieconsent/default.min.js"></script>
3298
3299 </body>
3300</html>
3301