-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathscaleway.iot.v1beta1.Api.yml
2265 lines (2253 loc) · 63 KB
/
scaleway.iot.v1beta1.Api.yml
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: IoT API
description: |
# Introduction
Scaleway IoT Hub is a PaaS enabling device-to-device and device-to-Scaleway communication, you can see it as a managed message broker.
Main features:
- Pub/Sub architecture
- MQTT protocol, with or without TLS, with or without WebSockets
- Mutual authentication available on TLS connections
- High Availability and Scalability
- Routes to Scaleway's ecosystem for data ingestion
- Multiple other IoT Networks such as SigFox or LoRa
- Usage metrics
We have planned a lot of other exciting features, do not hesitate to reach out to us and say what you would like to see next!
# Where to reach us ?
We are available on [Scaleway Community Slack](http://slack.scaleway.com) on the `#iot-hub` channel.
## Current Technical Limitations
- A single region is supported, your hub will be located in Paris, France (`fr-par`).
# Online documentation
Please refer to our [online documentation](https://www.scaleway.com/en/docs/scaleway-iothub/) to get more information.
## Getting started with IoT Hub API
- [How to use IoT API with curl](https://www.scaleway.com/en/docs/scaleway-iothub-howto-curl/)
version: v1beta1
servers:
- url: https://api.scaleway.com
tags:
- name: IoT Hubs
description: Managed message brokers
- name: IoT Devices
description: Devices allowed to connect to a Hub
- name: IoT Routes
description: Managed routes
- name: IoT Networks
description: Links to external IoT networks
components:
schemas:
scaleway.iot.v1beta1.CreateDeviceResponse:
type: object
properties:
device:
type: object
description: Created device information
properties:
id:
type: string
description: Device ID, also used as MQTT Client ID or Username
name:
type: string
description: Device name
status:
type: string
description: Device status
enum:
- error
- enabled
- disabled
default: error
hub_id:
type: string
description: Hub ID
last_activity_at:
type: string
description: Device last connection/activity date
format: date-time
is_connected:
type: boolean
description: Whether the device is connected to the Hub or not
allow_insecure:
type: boolean
description: Whether to allow device to connect without TLS mutual authentication
message_filters:
type: object
description: Filter-sets to restrict the topics the device can publish/subscribe
to
properties:
publish:
type: object
description: Filter-set to restrict topics the device can publish
to
properties:
policy:
$ref: '#/components/schemas/scaleway.iot.v1beta1.DeviceMessageFilters.Policy'
topics:
$ref: '#/components/schemas/scaleway.std.StringsValue'
x-properties-order:
- policy
- topics
subscribe:
type: object
description: Filter-set to restrict topics the device can subscribe
to
properties:
policy:
$ref: '#/components/schemas/scaleway.iot.v1beta1.DeviceMessageFilters.Policy'
topics:
$ref: '#/components/schemas/scaleway.std.StringsValue'
x-properties-order:
- policy
- topics
x-properties-order:
- publish
- subscribe
created_at:
type: string
description: Device add date
format: date-time
updated_at:
type: string
description: Device last modification date
format: date-time
organization_id:
type: string
description: Organization owning the resource
x-properties-order:
- id
- name
- status
- hub_id
- last_activity_at
- is_connected
- allow_insecure
- message_filters
- created_at
- updated_at
- organization_id
crt:
type: string
description: Device certificate
key:
type: string
description: Device certificate key
x-properties-order:
- device
- crt
- key
scaleway.iot.v1beta1.CreateNetworkResponse:
type: object
properties:
network:
type: object
description: Created network
properties:
id:
type: string
description: Network ID
name:
type: string
description: Network name
type:
type: string
description: Type of network to connect with
enum:
- unknown
- sigfox
- rest
default: unknown
endpoint:
type: string
description: Endpoint to use for interacting with the network
hub_id:
type: string
description: Hub ID to connect the Network to
created_at:
type: string
description: Network creation date
format: date-time
topic_prefix:
type: string
description: This prefix will be prepended to all topics for this Network.
region:
type: string
description: Region of the Network
organization_id:
type: string
description: Organization owning the resource
x-properties-order:
- id
- name
- type
- endpoint
- hub_id
- created_at
- topic_prefix
- region
- organization_id
secret:
type: string
description: Endpoint Key to keep secret. This cannot be retrieved later
x-properties-order:
- network
- secret
scaleway.iot.v1beta1.DatabaseRoute:
type: object
properties:
id:
type: string
description: Route ID
name:
type: string
description: Route name
organization_id:
type: string
description: Organization owning the route
hub_id:
type: string
description: ID of the route's hub
topic:
type: string
description: Topic the route subscribes to (wildcards allowed). It must
be a valid MQTT topic and up to 65535 characters
created_at:
type: string
description: Route creation date
format: date-time
query:
type: string
description: SQL query to be executed ($TOPIC and $PAYLOAD variables are
available, see documentation)
database:
type: object
description: Database settings
properties:
host:
type: string
description: Database host
port:
type: number
description: Database port
dbname:
type: string
description: Database name
username:
type: string
description: Database username. Make sure this account can execute the
provided query
password:
type: string
description: Database password
required:
- host
- port
- dbname
- username
- password
x-properties-order:
- host
- port
- dbname
- username
- password
x-properties-order:
- id
- name
- organization_id
- hub_id
- topic
- created_at
- query
- database
scaleway.iot.v1beta1.Device:
type: object
properties:
id:
type: string
description: Device ID, also used as MQTT Client ID or Username
name:
type: string
description: Device name
status:
type: string
description: Device status
enum:
- error
- enabled
- disabled
default: error
hub_id:
type: string
description: Hub ID
last_activity_at:
type: string
description: Device last connection/activity date
format: date-time
is_connected:
type: boolean
description: Whether the device is connected to the Hub or not
allow_insecure:
type: boolean
description: Whether to allow device to connect without TLS mutual authentication
message_filters:
type: object
description: Filter-sets to restrict the topics the device can publish/subscribe
to
properties:
publish:
type: object
description: Filter-set to restrict topics the device can publish to
properties:
policy:
$ref: '#/components/schemas/scaleway.iot.v1beta1.DeviceMessageFilters.Policy'
topics:
$ref: '#/components/schemas/scaleway.std.StringsValue'
x-properties-order:
- policy
- topics
subscribe:
type: object
description: Filter-set to restrict topics the device can subscribe
to
properties:
policy:
$ref: '#/components/schemas/scaleway.iot.v1beta1.DeviceMessageFilters.Policy'
topics:
$ref: '#/components/schemas/scaleway.std.StringsValue'
x-properties-order:
- policy
- topics
x-properties-order:
- publish
- subscribe
created_at:
type: string
description: Device add date
format: date-time
updated_at:
type: string
description: Device last modification date
format: date-time
organization_id:
type: string
description: Organization owning the resource
x-properties-order:
- id
- name
- status
- hub_id
- last_activity_at
- is_connected
- allow_insecure
- message_filters
- created_at
- updated_at
- organization_id
scaleway.iot.v1beta1.DeviceMessageFilters.Policy:
type: string
enum:
- unknown
- accept
- reject
default: unknown
scaleway.iot.v1beta1.Hub:
type: object
properties:
id:
type: string
description: Hub ID
name:
type: string
description: Hub name
status:
type: string
description: Current status of the Hub
enum:
- error
- enabling
- ready
- disabling
- disabled
default: error
product_plan:
type: string
description: Hub feature set
enum:
- plan_unknown
- plan_shared
- plan_dedicated
- plan_ha
default: plan_unknown
enabled:
type: boolean
description: Whether the hub has been enabled
device_count:
type: number
description: Number of registered devices
connected_device_count:
type: number
description: Number of currently connected devices
endpoint:
type: string
description: Devices should be connected to this host, port may be 1883
(MQTT), 8883 (MQTT over TLS), 80 (MQTT over Websocket) or 443 (MQTT over
Websocket over TLS).
events_enabled:
type: boolean
description: Wether Hub events are enabled or not
events_topic_prefix:
type: string
description: Hub events topic prefix
region:
type: string
description: Region of the Hub
created_at:
type: string
description: Hub creation date
format: date-time
updated_at:
type: string
description: Hub last modification date
format: date-time
organization_id:
type: string
description: Organization owning the resource
x-properties-order:
- id
- name
- status
- product_plan
- enabled
- device_count
- connected_device_count
- endpoint
- events_enabled
- events_topic_prefix
- region
- created_at
- updated_at
- organization_id
scaleway.iot.v1beta1.ListDevicesResponse:
type: object
properties:
total_count:
type: number
description: Total number of devices
devices:
type: array
description: A page of devices
items:
$ref: '#/components/schemas/scaleway.iot.v1beta1.Device'
x-properties-order:
- total_count
- devices
scaleway.iot.v1beta1.ListHubsResponse:
type: object
properties:
total_count:
type: number
description: Total number of hubs
hubs:
type: array
description: A page of hubs
items:
$ref: '#/components/schemas/scaleway.iot.v1beta1.Hub'
x-properties-order:
- total_count
- hubs
scaleway.iot.v1beta1.ListNetworksResponse:
type: object
properties:
total_count:
type: number
description: Total number of Networks
networks:
type: array
description: A page of networks
items:
$ref: '#/components/schemas/scaleway.iot.v1beta1.Network'
x-properties-order:
- total_count
- networks
scaleway.iot.v1beta1.ListRoutesResponse:
type: object
properties:
total_count:
type: number
description: Total number of routes
routes:
type: array
description: A page of routes
items:
$ref: '#/components/schemas/scaleway.iot.v1beta1.Route'
x-properties-order:
- total_count
- routes
scaleway.iot.v1beta1.Metrics:
type: object
properties:
metrics:
type: array
description: Metrics for a hub or a device, over the requested period
items:
$ref: '#/components/schemas/scaleway.iot.v1beta1.Metrics.Metric'
x-properties-order:
- metrics
scaleway.iot.v1beta1.Metrics.Metric:
type: object
properties:
name:
type: string
description: Metric name
values:
type: array
description: Metric values over the selected period
items:
$ref: '#/components/schemas/scaleway.iot.v1beta1.Metrics.Metric.Value'
x-properties-order:
- name
- values
scaleway.iot.v1beta1.Metrics.Metric.Value:
type: object
properties:
time:
type: string
description: Timestamp for the value
format: date-time
value:
type: number
description: Numeric value
x-properties-order:
- time
- value
scaleway.iot.v1beta1.Network:
type: object
properties:
id:
type: string
description: Network ID
name:
type: string
description: Network name
type:
type: string
description: Type of network to connect with
enum:
- unknown
- sigfox
- rest
default: unknown
endpoint:
type: string
description: Endpoint to use for interacting with the network
hub_id:
type: string
description: Hub ID to connect the Network to
created_at:
type: string
description: Network creation date
format: date-time
topic_prefix:
type: string
description: This prefix will be prepended to all topics for this Network.
region:
type: string
description: Region of the Network
organization_id:
type: string
description: Organization owning the resource
x-properties-order:
- id
- name
- type
- endpoint
- hub_id
- created_at
- topic_prefix
- region
- organization_id
scaleway.iot.v1beta1.RestRoute:
type: object
properties:
id:
type: string
description: Route ID
name:
type: string
description: Route name
organization_id:
type: string
description: Organization owning the route
hub_id:
type: string
description: ID of the route's hub
topic:
type: string
description: Topic the route subscribes to. It must be a valid MQTT topic
and up to 65535 characters
created_at:
type: string
description: Route creation date
format: date-time
verb:
type: string
description: HTTP Verb used to call REST URI
enum:
- get
- post
- put
- patch
- delete
default: get
uri:
type: string
description: URI of the REST endpoint
headers:
type: object
description: HTTP call extra headers
properties:
<headerKey>:
type: string
additionalProperties: true
x-properties-order:
- id
- name
- organization_id
- hub_id
- topic
- created_at
- verb
- uri
- headers
scaleway.iot.v1beta1.Route:
type: object
properties:
id:
type: string
description: Route ID
name:
type: string
description: Route name
organization_id:
type: string
description: Organization owning the resource
hub_id:
type: string
description: ID of the route's hub
topic:
type: string
description: Topic the route subscribes to. It must be a valid MQTT topic
and up to 65535 characters
type:
type: string
description: Route type
enum:
- unknown
- s3
- functions
- database
- rest
default: unknown
created_at:
type: string
description: Route creation date
format: date-time
x-properties-order:
- id
- name
- organization_id
- hub_id
- topic
- type
- created_at
scaleway.iot.v1beta1.S3Route:
type: object
properties:
id:
type: string
description: Route ID
name:
type: string
description: Route name
organization_id:
type: string
description: Organization owning the route
hub_id:
type: string
description: ID of the route's hub
topic:
type: string
description: Topic the route subscribes to. It must be a valid MQTT topic
and up to 65535 characters
created_at:
type: string
description: Route creation date
format: date-time
bucket_region:
type: string
description: Region of the S3 route's destination bucket (eg 'fr-par')
bucket_name:
type: string
description: Name of the S3 route's destination bucket
object_prefix:
type: string
description: Optional string to prefix object names with
strategy:
type: string
description: 'How the S3 route''s objects will be created: one per topic
or one per message'
enum:
- per_topic
- per_message
default: per_topic
x-properties-order:
- id
- name
- organization_id
- hub_id
- topic
- created_at
- bucket_region
- bucket_name
- object_prefix
- strategy
scaleway.std.StringsValue:
type: array
nullable: true
items:
type: string
securitySchemes:
scaleway:
in: header
name: X-Auth-Token
type: apiKey
paths:
/iot/v1beta1/regions/{region}/devices:
get:
tags:
- IoT Devices
operationId: ListDevices
summary: List devices
parameters:
- in: path
name: region
description: The region you want to target
required: true
schema:
type: string
description: The region you want to target
enum:
- fr-par
- in: query
name: page
description: Page number
schema:
type: number
description: Page number
default: 1
- in: query
name: page_size
description: Page size. The maximum value is 100
schema:
type: number
description: Page size. The maximum value is 100
default: 20
- in: query
name: order_by
description: Ordering of requested devices
schema:
type: string
description: Ordering of requested devices
enum:
- name_asc
- name_desc
- status_asc
- status_desc
- hub_id_asc
- hub_id_desc
- created_at_asc
- created_at_desc
- updated_at_asc
- updated_at_desc
- allow_insecure_asc
- allow_insecure_desc
default: name_asc
- in: query
name: organization_id
description: Filter on the organization
schema:
type: string
description: Filter on the organization
nullable: true
- in: query
name: name
description: Filter on the name
schema:
type: string
description: Filter on the name
nullable: true
- in: query
name: hub_id
description: Filter on the hub
schema:
type: string
description: Filter on the hub
nullable: true
- in: query
name: enabled
description: Deprecated, ignored filter
schema:
type: boolean
description: Deprecated, ignored filter
deprecated: true
nullable: true
deprecated: true
- in: query
name: allow_insecure
description: Filter on the allow_insecure flag
schema:
type: boolean
description: Filter on the allow_insecure flag
nullable: true
- in: query
name: is_connected
description: Deprecated, ignored filter
schema:
type: boolean
description: Deprecated, ignored filter
deprecated: true
nullable: true
deprecated: true
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.iot.v1beta1.ListDevicesResponse'
security:
- scaleway: []
post:
tags:
- IoT Devices
operationId: CreateDevice
summary: Add a device
parameters:
- in: path
name: region
description: The region you want to target
required: true
schema:
type: string
description: The region you want to target
enum:
- fr-par
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.iot.v1beta1.CreateDeviceResponse'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Device name
hub_id:
type: string
description: ID of the device's hub
allow_insecure:
type: boolean
description: Allow plain and server-authenticated SSL connections
in addition to mutually-authenticated ones
message_filters:
type: object
description: Filter-sets to authorize or deny the device to publish/subscribe
to specific topics
properties:
publish:
type: object
description: Filter-set to restrict topics the device can publish
to
properties:
policy:
$ref: '#/components/schemas/scaleway.iot.v1beta1.DeviceMessageFilters.Policy'
topics:
$ref: '#/components/schemas/scaleway.std.StringsValue'
x-properties-order:
- policy
- topics
subscribe:
type: object
description: Filter-set to restrict topics the device can subscribe
to
properties:
policy:
$ref: '#/components/schemas/scaleway.iot.v1beta1.DeviceMessageFilters.Policy'
topics:
$ref: '#/components/schemas/scaleway.std.StringsValue'
x-properties-order:
- policy
- topics
x-properties-order:
- publish
- subscribe
required:
- name
- hub_id
x-properties-order:
- name
- hub_id
- allow_insecure
- message_filters
security:
- scaleway: []
/iot/v1beta1/regions/{region}/devices/{device_id}:
get:
tags:
- IoT Devices
operationId: GetDevice
summary: Get a device
parameters:
- in: path
name: region
description: The region you want to target
required: true
schema:
type: string
description: The region you want to target
enum:
- fr-par
- in: path
name: device_id
description: Device ID
required: true
schema:
type: string
description: Device ID
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.iot.v1beta1.Device'
security:
- scaleway: []
patch:
tags:
- IoT Devices
operationId: UpdateDevice
summary: Update a device
parameters:
- in: path
name: region
description: The region you want to target
required: true
schema:
type: string
description: The region you want to target
enum:
- fr-par
- in: path
name: device_id
description: Device ID
required: true
schema:
type: string
description: Device ID
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.iot.v1beta1.Device'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Device name
nullable: true
allow_insecure:
type: boolean
description: Allow plain and server-authenticated SSL connections
in addition to mutually-authenticated ones
nullable: true
message_filters:
type: object