-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathopenapi.yaml
More file actions
22955 lines (21950 loc) · 688 KB
/
openapi.yaml
File metadata and controls
22955 lines (21950 loc) · 688 KB
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: azion-api
version: 4.0.0
description: The AZION v4 REST API.
license:
name: MIT
url: https://github.com/aziontech/azionapi-v4-openapi/blob/main/LICENSE
contact:
name: Azion Support
url: https://www.azion.com/en/support/
email: support@azion.com
servers:
- url: https://api.azion.com/v4
tags:
- name: Applications
description: Manage Applications and their configurations.
- name: Applications - Cache Settings
description: Configure cache settings for Applications.
- name: Applications - Device Groups
description: Manage device groups for Applications.
- name: Applications - Function
description: Manage Functions attached to Applications.
- name: Applications - Request Rules
description: Configure request rules for Applications.
- name: Applications - Response Rules
description: Configure response rules for Applications.
- name: Auth - Login
description: Authentication endpoints for user login.
- name: Auth - MFA TOTP Device
description: Manage Multi-Factor Authentication TOTP devices.
- name: Auth - Refresh Access Token
description: Refresh access tokens for continued authentication.
- name: Auth - Revoke
description: Revoke authentication tokens.
- name: Connectors
description: Manage Connectors.
- name: Custom Pages
description: Manage custom error pages.
- name: DNS - DNSSEC
description: Manage DNSSEC configuration for DNS zones.
- name: DNS - Records
description: Manage DNS records within zones.
- name: DNS - Zones
description: Manage DNS zones.
- name: Data Stream - Data Sources
description: Manage data sources for Data Stream.
- name: Data Stream - Streams
description: Manage data streams.
- name: Data Stream - Templates
description: Manage templates for Data Stream.
- name: Digital Certificates - Certificate Revocation Lists
description: Manage Certificate Revocation Lists (CRLs).
- name: Digital Certificates - Certificate Signing Requests
description: Manage Certificate Signing Requests (CSRs).
- name: Digital Certificates - Certificates
description: Manage digital certificates.
- name: Digital Certificates - Request a Certificate
description: Request new digital certificates.
- name: Firewalls
description: Manage Firewalls.
- name: Firewalls - Function
description: Manage Functions attached to Firewalls.
- name: Firewalls - Rules Engine
description: Configure rules engine for Firewalls.
- name: Functions
description: Manage Functions.
- name: Network Lists
description: Manage network lists for access control.
- name: Purge
description: Purge cached content.
- name: SQL
description: Execute SQL queries on databases.
- name: Storage - Buckets
description: Manage Storage buckets.
- name: Storage - Credentials
description: Manage credentials for Storage.
- name: Storage - Objects
description: Manage objects within Storage buckets.
- name: WAFs
description: Manage Web Application Firewalls.
- name: WAFs - Exceptions
description: Manage WAF exceptions and allowed rules.
- name: Workload Deployments
description: Manage workload deployments.
- name: Workloads
description: Manage workloads.
x-tagGroups:
- name: Authentication
tags:
- Auth - Login
- Auth - MFA TOTP Device
- Auth - Refresh Access Token
- Auth - Revoke
- name: Applications
tags:
- Applications
- Applications - Cache Settings
- Applications - Device Groups
- Applications - Function
- Applications - Request Rules
- Applications - Response Rules
- Custom Pages
- name: Firewall
tags:
- Firewalls
- Firewalls - Function
- Firewalls - Rules Engine
- Network Lists
- WAFs
- WAFs - Exceptions
- name: Functions
tags:
- Functions
- name: SQL
tags:
- SQL
- name: Storage
tags:
- Storage - Buckets
- Storage - Credentials
- Storage - Objects
- name: Intelligent DNS
tags:
- DNS - DNSSEC
- DNS - Records
- DNS - Zones
- name: Digital Certificates
tags:
- Digital Certificates - Certificate Revocation Lists
- Digital Certificates - Certificate Signing Requests
- Digital Certificates - Certificates
- Digital Certificates - Request a Certificate
- name: Data Stream
tags:
- Connectors
- Data Stream - Data Sources
- Data Stream - Streams
- Data Stream - Templates
- name: Real-Time Purge
tags:
- Purge
- name: Workloads
tags:
- Workloads
- name: Workload Deployments
tags:
- Workload Deployments
paths:
/workspace/applications:
get:
operationId: list_applications
description: List all Applications owned by your account.
summary: List Applications
parameters:
- in: query
name: active
schema:
type: boolean
description: Filter by active status.
- $ref: '#/components/parameters/FieldsParam'
- in: query
name: id
schema:
type: integer
description: Filter by id (accepts comma-separated values).
- in: query
name: last_editor
schema:
type: string
description: Filter by last editor (case-insensitive, partial match).
- in: query
name: last_modified__gte
schema:
type: string
format: date-time
description: Filter by last modified date (greater than or equal).
- in: query
name: last_modified__lte
schema:
type: string
format: date-time
description: Filter by last modified date (less than or equal).
- in: query
name: name
schema:
type: string
description: Filter by name (case-insensitive, partial match).
- $ref: '#/components/parameters/OrderingParam'
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PageSizeParam'
- $ref: '#/components/parameters/SearchParam'
tags:
- Applications
security:
- TokenAuth: []
- BearerAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedApplicationList'
description: List of applications retrieved successfully.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
post:
operationId: create_application
description: Create a new Application in your account.
summary: Create an Application
tags:
- Applications
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationRequest'
required: true
security:
- TokenAuth: []
- BearerAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationResponse'
description: Application created successfully.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
/workspace/applications/{application_id}:
get:
operationId: retrieve_application
description: Retrieve details of a specific Application in your account.
summary: Retrieve details of an Application
parameters:
- in: path
name: application_id
schema:
type: integer
description: A unique integer value identifying the application.
required: true
- $ref: '#/components/parameters/FieldsParam'
tags:
- Applications
security:
- TokenAuth: []
- BearerAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationResponse'
description: Application details retrieved successfully.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
put:
operationId: update_application
description: Update an existing Application. This replaces the entire Application
with the new data provided.
summary: Update an Application
parameters:
- in: path
name: application_id
schema:
type: integer
description: A unique integer value identifying the application.
required: true
tags:
- Applications
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationRequest'
required: true
security:
- TokenAuth: []
- BearerAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationResponse'
description: Application updated successfully.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
patch:
operationId: partial_update_application
description: Update one or more fields of an existing Application without affecting
other fields.
summary: Partially update an Application
parameters:
- in: path
name: application_id
schema:
type: integer
description: A unique integer value identifying the application.
required: true
tags:
- Applications
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedApplicationRequest'
security:
- TokenAuth: []
- BearerAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationResponse'
description: Application partially updated successfully.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
delete:
operationId: delete_application
description: Delete a specific Application in your account.
summary: Delete an Application
parameters:
- in: path
name: application_id
schema:
type: integer
description: A unique integer value identifying the application.
required: true
tags:
- Applications
security:
- TokenAuth: []
- BearerAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteResponse'
description: Application deleted successfully.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
/workspace/applications/{application_id}/clone:
post:
operationId: clone_application
description: Create a new Application by performing a deep copy of an existing
Application, including its Cache Settings, Origins, Error Responses, Function
Instances, and Rules Engine.
summary: Clone an Application
parameters:
- in: path
name: application_id
schema:
type: integer
description: A unique integer value identifying the application.
required: true
tags:
- Applications
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CloneApplicationRequest'
required: true
security:
- TokenAuth: []
- BearerAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationResponse'
description: Application cloned successfully.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
/workspace/applications/{application_id}/cache_settings:
get:
operationId: list_cache_settings
description: List all Cache Settings owned by your account.
summary: List all Applications Cache Settings
parameters:
- in: path
name: application_id
schema:
type: integer
description: A unique integer value identifying the application.
required: true
- $ref: '#/components/parameters/FieldsParam'
- in: query
name: id
schema:
type: integer
description: Filter by id (accepts comma-separated values).
- in: query
name: name
schema:
type: string
description: Filter by name (case-insensitive, partial match).
- $ref: '#/components/parameters/OrderingParam'
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PageSizeParam'
- $ref: '#/components/parameters/SearchParam'
tags:
- Applications - Cache Settings
security:
- TokenAuth: []
- BearerAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedCacheSettingList'
description: List of cache settings retrieved successfully.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
post:
operationId: create_cache_setting
description: Create a new Cache Setting in your account.
summary: Create an Applications Cache Setting
parameters:
- in: path
name: application_id
schema:
type: integer
description: A unique integer value identifying the application.
required: true
tags:
- Applications - Cache Settings
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CacheSettingRequest'
required: true
security:
- TokenAuth: []
- BearerAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CacheSettingResponse'
description: Cache setting created successfully.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
/workspace/applications/{application_id}/cache_settings/{cache_setting_id}:
get:
operationId: retrieve_cache_setting
description: Retrieve details of a specific Cache Setting in your account.
summary: Retrieve details of an Applications Cache Setting
parameters:
- in: path
name: application_id
schema:
type: integer
description: A unique integer value identifying the application.
required: true
- in: path
name: cache_setting_id
schema:
type: integer
description: A unique integer value identifying the cache setting.
required: true
- $ref: '#/components/parameters/FieldsParam'
tags:
- Applications - Cache Settings
security:
- TokenAuth: []
- BearerAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CacheSetting'
description: Cache setting details retrieved successfully.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
put:
operationId: update_cache_setting
description: Update an existing Cache Setting. This replaces the entire Cache
Setting with the new data provided.
summary: Update an Applications Cache Setting
parameters:
- in: path
name: application_id
schema:
type: integer
description: A unique integer value identifying the application.
required: true
- in: path
name: cache_setting_id
schema:
type: integer
description: A unique integer value identifying the cache setting.
required: true
tags:
- Applications - Cache Settings
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CacheSettingRequest'
required: true
security:
- TokenAuth: []
- BearerAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CacheSettingResponse'
description: Cache setting updated successfully.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
patch:
operationId: partial_update_cache_setting
description: Update one or more fields of an existing Cache Setting without
affecting other fields.
summary: Partially update an Applications Cache Setting
parameters:
- in: path
name: application_id
schema:
type: integer
description: A unique integer value identifying the application.
required: true
- in: path
name: cache_setting_id
schema:
type: integer
description: A unique integer value identifying the cache setting.
required: true
tags:
- Applications - Cache Settings
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedCacheSettingRequest'
security:
- TokenAuth: []
- BearerAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CacheSettingResponse'
description: Cache setting partially updated successfully.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
delete:
operationId: delete_cache_setting
description: Delete a specific Cache Setting in your account.
summary: Delete an Applications Cache Setting
parameters:
- in: path
name: application_id
schema:
type: integer
description: A unique integer value identifying the application.
required: true
- in: path
name: cache_setting_id
schema:
type: integer
description: A unique integer value identifying the cache setting.
required: true
tags:
- Applications - Cache Settings
security:
- TokenAuth: []
- BearerAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteResponse'
description: Cache setting deleted successfully.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
/workspace/applications/{application_id}/device_groups:
get:
operationId: list_device_groups
description: List all Device Groups owned by your account.
summary: List Applications Device Groups
parameters:
- in: path
name: application_id
schema:
type: integer
description: A unique integer value identifying the application.
required: true
- $ref: '#/components/parameters/FieldsParam'
- in: query
name: id
schema:
type: integer
description: Filter by id (accepts comma-separated values).
- in: query
name: name
schema:
type: string
description: Filter by name (case-insensitive, partial match).
- $ref: '#/components/parameters/OrderingParam'
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PageSizeParam'
- $ref: '#/components/parameters/SearchParam'
- in: query
name: user_agent
schema:
type: string
description: Filter by user agent (case-insensitive, partial match).
tags:
- Applications - Device Groups
security:
- TokenAuth: []
- BearerAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedDeviceGroupList'
description: List of device groups retrieved successfully.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
post:
operationId: create_device_group
description: Create a new Device Group in your account.
summary: Create an Applications Device Group
parameters:
- in: path
name: application_id
schema:
type: integer
description: A unique integer value identifying the application.
required: true
tags:
- Applications - Device Groups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceGroupRequest'
required: true
security:
- TokenAuth: []
- BearerAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceGroupResponse'
description: Device group created successfully.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
/workspace/applications/{application_id}/device_groups/{device_group_id}:
get:
operationId: retrieve_device_group
description: Retrieve details of a specific Device Group in your account.
summary: Retrieve details of a Device Group
parameters:
- in: path
name: application_id
schema:
type: integer
description: A unique integer value identifying the application.
required: true
- in: path
name: device_group_id
schema:
type: integer
description: A unique integer value identifying the device group.
required: true
- $ref: '#/components/parameters/FieldsParam'
tags:
- Applications - Device Groups
security:
- TokenAuth: []
- BearerAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceGroupResponse'
description: Device group details retrieved successfully.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
put:
operationId: update_device_group
description: Update an existing Device Group. This replaces the entire Device
Group with the new data provided.
summary: Update an Applications Device Group
parameters:
- in: path
name: application_id
schema:
type: integer
description: A unique integer value identifying the application.
required: true
- in: path
name: device_group_id
schema:
type: integer
description: A unique integer value identifying the device group.
required: true
tags:
- Applications - Device Groups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceGroupRequest'
required: true
security:
- TokenAuth: []
- BearerAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceGroupResponse'
description: Device group updated successfully.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
patch:
operationId: partial_update_device_group
description: Update one or more fields of an existing Device Group without affecting
other fields.
summary: Partially update an Applications Device Group
parameters:
- in: path
name: application_id
schema:
type: integer
description: A unique integer value identifying the application.
required: true
- in: path
name: device_group_id
schema:
type: integer
description: A unique integer value identifying the device group.
required: true
tags:
- Applications - Device Groups
requestBody:
content:
application/json:
schema: