-
Notifications
You must be signed in to change notification settings - Fork 453
Expand file tree
/
Copy pathopenapi.yaml
More file actions
1358 lines (1286 loc) · 33.7 KB
/
openapi.yaml
File metadata and controls
1358 lines (1286 loc) · 33.7 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: Balena API Spec
description: Automated API spec generation with alphabetized resources.
version: 7.0.0
servers:
- url: https://api.balena-cloud.com
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
schemas:
api_key:
type: object
title: API key Model
properties:
id:
description: Type information not available yet
created_at:
description: Type information not available yet
is_of__actor:
description: Type information not available yet
name:
description: Type information not available yet
description:
description: Type information not available yet
device:
type: object
title: Device Model
properties:
id:
description: Type information not available yet
belongs_to__application:
description: Type information not available yet
belongs_to__user:
description: Type information not available yet
actor:
description: Type information not available yet
device_name:
description: Type information not available yet
is_of__device_type:
description: Type information not available yet
uuid:
description: Type information not available yet
is_running__release:
description: Type information not available yet
is_pinned_on__release:
description: Type information not available yet
should_be_running__release:
description: Type information not available yet
note:
description: Type information not available yet
local_id:
description: Type information not available yet
status:
description: Type information not available yet
overall_status:
description: Type information not available yet
is_online:
description: Type information not available yet
last_connectivity_event:
description: Type information not available yet
is_connected_to_vpn:
description: Type information not available yet
last_vpn_event:
description: Type information not available yet
ip_address:
description: Type information not available yet
mac_address:
description: Type information not available yet
public_address:
description: Type information not available yet
os_version:
description: Type information not available yet
os_variant:
description: Type information not available yet
should_be_operated_by__release:
description: Type information not available yet
supervisor_version:
description: Type information not available yet
should_be_managed_by__release:
description: Type information not available yet
is_managed_by__service_instance:
description: Type information not available yet
provisioning_progress:
description: Type information not available yet
provisioning_state:
description: Type information not available yet
download_progress:
description: Type information not available yet
is_web_accessible:
description: Type information not available yet
longitude:
description: Type information not available yet
latitude:
description: Type information not available yet
location:
description: Type information not available yet
custom_longitude:
description: Type information not available yet
custom_latitude:
description: Type information not available yet
is_locked_until__date:
description: Type information not available yet
is_accessible_by_support_until__date:
description: Type information not available yet
created_at:
description: Type information not available yet
is_active:
description: Type information not available yet
api_heartbeat_state:
description: Type information not available yet
memory_usage:
description: Type information not available yet
memory_total:
description: Type information not available yet
storage_block_device:
description: Type information not available yet
storage_usage:
description: Type information not available yet
storage_total:
description: Type information not available yet
cpu_temp:
description: Type information not available yet
cpu_usage:
description: Type information not available yet
cpu_id:
description: Type information not available yet
is_undervolted:
description: Type information not available yet
device_config_variable:
type: object
title: Device config variable Model
properties:
id:
description: Type information not available yet
device:
description: Type information not available yet
value:
description: Type information not available yet
name:
description: Type information not available yet
device_environment_variable:
type: object
title: Device Environment Variable Model
properties:
id:
description: Type information not available yet
created_at:
description: Type information not available yet
device:
description: Type information not available yet
name:
description: Type information not available yet
value:
description: Type information not available yet
device_service_environment_variable:
type: object
title: Device service variable Model
properties:
id:
description: Type information not available yet
created_at:
description: Type information not available yet
service_install:
description: Type information not available yet
value:
description: Type information not available yet
name:
description: Type information not available yet
device_tag:
type: object
title: Device tag Model
properties:
id:
description: Type information not available yet
device:
description: Type information not available yet
tag_key:
description: Type information not available yet
value:
description: Type information not available yet
device_type:
type: object
title: Device type Model
properties:
id:
description: Type information not available yet
slug:
description: Type information not available yet
name:
description: Type information not available yet
is_private:
description: Type information not available yet
is_of__cpu_architecture:
description: Type information not available yet
belongs_to__device_family:
description: Type information not available yet
fleet:
type: object
title: Fleet Model
properties:
id:
description: Type information not available yet
uuid:
description: Type information not available yet
organization:
description: Type information not available yet
actor:
description: Type information not available yet
app_name:
description: Type information not available yet
slug:
description: Type information not available yet
should_be_running__release:
description: Type information not available yet
application_type:
description: Type information not available yet
is_for__device_type:
description: Type information not available yet
should_track_latest_release:
description: Type information not available yet
is_accessible_by_support_until__date:
description: Type information not available yet
is_public:
description: Type information not available yet
is_host:
description: Type information not available yet
is_archived:
description: Type information not available yet
is_discoverable:
description: Type information not available yet
is_stored_at__repository_url:
description: Type information not available yet
created_at:
description: Type information not available yet
fleet_config_variable:
type: object
title: Fleet config variable Model
properties:
id:
description: Type information not available yet
application:
description: Type information not available yet
name:
description: Type information not available yet
value:
description: Type information not available yet
fleet_environment_variable:
type: object
title: Fleet environment variable Model
properties:
id:
description: Type information not available yet
created_at:
description: Type information not available yet
application:
description: Type information not available yet
name:
description: Type information not available yet
value:
description: Type information not available yet
fleet_membership_role:
type: object
title: Fleet membership role Model
properties:
id:
description: Type information not available yet
name:
description: Type information not available yet
service_environment_variable:
type: object
title: Fleet service variable Model
properties:
id:
description: Type information not available yet
created_at:
description: Type information not available yet
service_install:
description: Type information not available yet
value:
description: Type information not available yet
name:
description: Type information not available yet
fleet_tag:
type: object
title: Fleet tag Model
properties:
id:
description: Type information not available yet
application:
description: Type information not available yet
tag_key:
description: Type information not available yet
value:
description: Type information not available yet
organization:
type: object
title: Organization Model
properties:
id:
description: Type information not available yet
created_at:
description: Type information not available yet
name:
description: Type information not available yet
handle:
description: Type information not available yet
company_name:
description: Type information not available yet
website:
description: Type information not available yet
industry:
description: Type information not available yet
billing_account_code:
description: Type information not available yet
organization_membership:
type: object
title: Organization Membership Model
properties:
id:
description: Type information not available yet
created_at:
description: Type information not available yet
user:
description: Type information not available yet
is_member_of__organization:
description: Type information not available yet
organization_membership_role:
description: Type information not available yet
effective_seat_role:
description: Type information not available yet
release:
type: object
title: Release Model
properties:
id:
description: Type information not available yet
created_at:
description: Type information not available yet
belongs_to__application:
description: Type information not available yet
is_created_by__user:
description: Type information not available yet
raw_version:
description: Type information not available yet
semver:
description: Type information not available yet
semver_major:
description: Type information not available yet
semver_minor:
description: Type information not available yet
semver_patch:
description: Type information not available yet
semver_prerelease:
description: Type information not available yet
semver_build:
description: Type information not available yet
revision:
description: Type information not available yet
variant:
description: Type information not available yet
commit:
description: Type information not available yet
composition:
description: Type information not available yet
status:
description: Type information not available yet
source:
description: Type information not available yet
build_log:
description: Type information not available yet
start_timestamp:
description: Type information not available yet
end_timestamp:
description: Type information not available yet
update_timestamp:
description: Type information not available yet
is_invalidated:
description: Type information not available yet
release_version:
description: Type information not available yet
contract:
description: Type information not available yet
release_tag:
type: object
title: Release tag Model
properties:
id:
description: Type information not available yet
release:
description: Type information not available yet
tag_key:
description: Type information not available yet
value:
description: Type information not available yet
service:
type: object
title: Service Model
properties:
id:
description: Type information not available yet
created_at:
description: Type information not available yet
application:
description: Type information not available yet
service_name:
description: Type information not available yet
service_install:
type: object
title: Service install Model
properties:
id:
description: Type information not available yet
created_at:
description: Type information not available yet
device:
description: Type information not available yet
installs__service:
description: Type information not available yet
user__has__public_key:
type: object
title: SSH key Model
properties:
id:
description: Type information not available yet
user:
description: Type information not available yet
title:
description: Type information not available yet
public_key:
description: Type information not available yet
created_at:
description: Type information not available yet
team:
type: object
title: Team Model
properties:
id:
description: Type information not available yet
created_at:
description: Type information not available yet
name:
description: Type information not available yet
description:
description: Type information not available yet
belongs_to__organization:
description: Type information not available yet
team_fleet_access:
type: object
title: Team Fleet Access Model
properties:
id:
description: Type information not available yet
created_at:
description: Type information not available yet
team:
description: Type information not available yet
grants_access_to__application:
description: Type information not available yet
application_membership_role:
description: Type information not available yet
team_membership:
type: object
title: Team Membership Model
properties:
id:
description: Type information not available yet
created_at:
description: Type information not available yet
user:
description: Type information not available yet
is_member_of__team:
description: Type information not available yet
user:
type: object
title: User Model
properties:
id:
description: Type information not available yet
actor:
description: Type information not available yet
username:
description: Type information not available yet
created_at:
description: Type information not available yet
whoami:
type: object
title: Who am I Model
properties:
id:
description: Type information not available yet
username:
description: Type information not available yet
email:
description: Type information not available yet
paths:
/v7/api_key:
get:
tags:
- API key
description: |-
## API key Resource Fields
| Field |
| :--- |
| `id` |
| `created_at` |
| `is_of__actor` |
| `name` |
| `description` |
---
/v7/api_key(<ID>):
patch:
tags:
- API key
parameters:
- name: ID
in: path
required: true
description: ''
/v7/device:
get:
tags:
- Device
description: |-
## Device Resource Fields
| Field |
| :--- |
| `id` |
| `belongs_to__application` |
| `belongs_to__user` |
| `actor` |
| `device_name` |
| `is_of__device_type` |
| `uuid` |
| `is_running__release` |
| `is_pinned_on__release` |
| `should_be_running__release` |
| `note` |
| `local_id` |
| `status` |
| `overall_status` |
| `is_online` |
| `last_connectivity_event` |
| `is_connected_to_vpn` |
| `last_vpn_event` |
| `ip_address` |
| `mac_address` |
| `public_address` |
| `os_version` |
| `os_variant` |
| `should_be_operated_by__release` |
| `supervisor_version` |
| `should_be_managed_by__release` |
| `is_managed_by__service_instance` |
| `provisioning_progress` |
| `provisioning_state` |
| `download_progress` |
| `is_web_accessible` |
| `longitude` |
| `latitude` |
| `location` |
| `custom_longitude` |
| `custom_latitude` |
| `is_locked_until__date` |
| `is_accessible_by_support_until__date` |
| `created_at` |
| `is_active` |
| `api_heartbeat_state` |
| `memory_usage` |
| `memory_total` |
| `storage_block_device` |
| `storage_usage` |
| `storage_total` |
| `cpu_temp` |
| `cpu_usage` |
| `cpu_id` |
| `is_undervolted` |
---
/v7/device(<ID>):
get:
tags:
- Device
parameters:
- name: ID
in: path
required: true
description: ''
patch:
tags:
- Device
parameters:
- name: ID
in: path
required: true
description: ''
delete:
tags:
- Device
parameters:
- name: ID
in: path
required: true
description: ''
/v7/device(uuid='<UUID>'):
get:
tags:
- Device
parameters:
- name: UUID
in: path
required: true
description: ''
patch:
tags:
- Device
parameters:
- name: UUID
in: path
required: true
description: ''
/v7/device_config_variable:
get:
tags:
- Device config variable
description: |-
## Device config variable Resource Fields
| Field |
| :--- |
| `id` |
| `device` |
| `value` |
| `name` |
---
post:
tags:
- Device config variable
description: ''
/v7/device_config_variable(<ID>):
patch:
tags:
- Device config variable
parameters:
- name: ID
in: path
required: true
description: ''
delete:
tags:
- Device config variable
parameters:
- name: ID
in: path
required: true
description: ''
/v7/device_environment_variable:
get:
tags:
- Device Environment Variable
description: |-
## Device Environment Variable Resource Fields
| Field |
| :--- |
| `id` |
| `created_at` |
| `device` |
| `name` |
| `value` |
---
post:
tags:
- Device Environment Variable
description: ''
/v7/device_environment_variable(<ID>):
patch:
tags:
- Device Environment Variable
parameters:
- name: ID
in: path
required: true
description: ''
delete:
tags:
- Device Environment Variable
parameters:
- name: ID
in: path
required: true
description: ''
/v7/device_service_environment_variable:
get:
tags:
- Device service variable
description: |-
## Device service variable Resource Fields
| Field |
| :--- |
| `id` |
| `created_at` |
| `service_install` |
| `value` |
| `name` |
---
post:
tags:
- Device service variable
description: ''
/v7/device_service_environment_variable(<ID>):
patch:
tags:
- Device service variable
parameters:
- name: ID
in: path
required: true
description: ''
delete:
tags:
- Device service variable
parameters:
- name: ID
in: path
required: true
description: ''
/v7/device_tag:
get:
tags:
- Device tag
description: |-
## Device tag Resource Fields
| Field |
| :--- |
| `id` |
| `device` |
| `tag_key` |
| `value` |
---
post:
tags:
- Device tag
description: ''
/v7/device_tag(device=<DEVICE_ID>,tag_key='<EXISTING-KEY>'):
patch:
tags:
- Device tag
parameters:
- name: DEVICE_ID
in: path
required: true
- name: EXISTING-KEY
in: path
required: true
description: ''
/v7/device_tag(<TAG-ID>):
delete:
tags:
- Device tag
parameters:
- name: TAG-ID
in: path
required: true
description: ''
/v7/device_type(<ID>):
get:
tags:
- Device type
parameters:
- name: ID
in: path
required: true
description: |-
## Device type Resource Fields
| Field |
| :--- |
| `id` |
| `slug` |
| `name` |
| `is_private` |
| `is_of__cpu_architecture` |
| `belongs_to__device_family` |
---
/v7/device_type(slug='<DEVICE TYPE SLUG>'):
get:
tags:
- Device type
parameters:
- name: DEVICE TYPE SLUG
in: path
required: true
description: ''
/v7/device_type:
get:
tags:
- Device type
description: ''
/v7/application:
get:
tags:
- Fleet
description: |-
## Fleet Resource Fields
| Field |
| :--- |
| `id` |
| `uuid` |
| `organization` |
| `actor` |
| `app_name` |
| `slug` |
| `should_be_running__release` |
| `application_type` |
| `is_for__device_type` |
| `should_track_latest_release` |
| `is_accessible_by_support_until__date` |
| `is_public` |
| `is_host` |
| `is_archived` |
| `is_discoverable` |
| `is_stored_at__repository_url` |
| `created_at` |
---
post:
tags:
- Fleet
description: ''
/v7/application(<ID>):
get:
tags:
- Fleet
parameters:
- name: ID
in: path
required: true
description: ''
delete:
tags:
- Fleet
parameters:
- name: ID
in: path
required: true
description: ''
patch:
tags:
- Fleet
parameters:
- name: ID
in: path
required: true
description: ''
/v7/application(slug='<SLUG>'):
get:
tags:
- Fleet
parameters:
- name: SLUG
in: path
required: true
description: ''
patch:
tags:
- Fleet
parameters:
- name: SLUG
in: path
required: true
description: ''
/v7/application_config_variable:
get:
tags:
- Fleet config variable
description: |-
## Fleet config variable Resource Fields
| Field |
| :--- |
| `id` |
| `application` |
| `name` |
| `value` |
---
post:
tags:
- Fleet config variable
description: ''
/v7/application_config_variable(<ID>):
patch:
tags:
- Fleet config variable
parameters:
- name: ID
in: path
required: true
description: ''
delete:
tags:
- Fleet config variable
parameters:
- name: ID
in: path
required: true
description: ''
/v7/application_environment_variable:
get:
tags:
- Fleet environment variable
description: |-
## Fleet environment variable Resource Fields
| Field |
| :--- |
| `id` |
| `created_at` |
| `application` |
| `name` |
| `value` |
---
post:
tags:
- Fleet environment variable
description: ''
/v7/application_environment_variable(<ID>):
patch:
tags:
- Fleet environment variable
parameters:
- name: ID
in: path
required: true
description: ''
delete:
tags:
- Fleet environment variable
parameters:
- name: ID
in: path
required: true
description: ''
/v7/application_membership_role:
get:
tags:
- Fleet membership role
description: |-
## Fleet membership role Resource Fields
| Field |
| :--- |
| `id` |
| `name` |
---
/v7/service_environment_variable:
get:
tags:
- Fleet service variable
description: |-
## Fleet service variable Resource Fields
| Field |
| :--- |
| `id` |
| `created_at` |
| `service_install` |
| `value` |
| `name` |
---
post: