-
Notifications
You must be signed in to change notification settings - Fork 82
/
Copy pathapi.spec.yaml
2231 lines (2206 loc) · 68.9 KB
/
api.spec.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
openapi: 3.0.0
info:
description: REST interface for the Insights Platform Host Inventory application.
version: 1.0.0
title: Insights Host Inventory REST Interface
paths:
/hosts:
get:
operationId: api.host.get_host_list
tags:
- hosts
summary: Read the entire list of hosts
description: >-
Read the entire list of all hosts available to the account.
<br /><br />
Required permissions: inventory:hosts:read
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/displayName'
- $ref: '#/components/parameters/fqdn'
- $ref: '#/components/parameters/hostnameOrId'
- $ref: '#/components/parameters/insightsId'
- $ref: '#/components/parameters/providerId'
- $ref: '#/components/parameters/providerType'
- $ref: '#/components/parameters/updatedStart'
- $ref: '#/components/parameters/updatedEnd'
- $ref: '#/components/parameters/groupNameListParam'
- $ref: '#/components/parameters/branchId'
- $ref: '#/components/parameters/perPageParam'
- $ref: '#/components/parameters/pageParam'
- $ref: '#/components/parameters/hostOrderByParam'
- $ref: '#/components/parameters/hostOrderHowParam'
- $ref: '#/components/parameters/stalenessParam'
- $ref: '#/components/parameters/tagsParam'
- $ref: '#/components/parameters/registered_with'
- $ref: '#/components/parameters/filter_param'
- $ref: '#/components/parameters/fields_param'
responses:
'200':
description: Successfully read the hosts list.
content:
application/json:
schema:
$ref: '#/components/schemas/HostQueryOutput'
delete:
operationId: api.host.delete_hosts_by_filter
tags:
- hosts
summary: Delete the entire list of hosts filtered by the given parameters
description: >-
Delete the entire list of hosts filtered by the given parameters.
<br /><br />
Required permissions: inventory:hosts:write
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/displayName'
- $ref: '#/components/parameters/fqdn'
- $ref: '#/components/parameters/hostnameOrId'
- $ref: '#/components/parameters/insightsId'
- $ref: '#/components/parameters/providerId'
- $ref: '#/components/parameters/providerType'
- $ref: '#/components/parameters/updatedStart'
- $ref: '#/components/parameters/updatedEnd'
- $ref: '#/components/parameters/groupNameListParam'
- $ref: '#/components/parameters/registered_with'
- $ref: '#/components/parameters/stalenessNoDefaultsParam'
- $ref: '#/components/parameters/tagsParam'
- $ref: '#/components/parameters/filter_param'
responses:
'202':
description: Request for deletion of filtered hosts has been accepted.
'400':
description: Invalid request.
/hosts/all:
delete:
operationId: api.host.delete_all_hosts
tags:
- hosts
summary: Delete all hosts on the account
description: >-
Delete all hosts on the account. The request must include "confirm_delete_all=true".
<br /><br />
Required permissions: inventory:hosts:write
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/confirmDeleteAll'
responses:
'202':
description: Request for deleting all hosts has been accepted.
'400':
description: Invalid request.
/hosts/checkin:
post:
operationId: api.host.host_checkin
tags:
- hosts
summary: Update staleness timestamps for a host matching the provided facts
description: >-
Finds a host and updates its staleness timestamps.
It uses the supplied canonical facts to determine which host to update.
By default, the staleness timestamp is set to 1 hour from when the request is received;
however, this can be overridden by supplying the interval.
<br /><br />
Required permissions: inventory:hosts:write
security:
- ApiKeyAuth: []
- BearerAuth: []
requestBody:
description: Data required to create a check-in record for a host.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCheckIn'
responses:
'201':
description: Successfully checked in Host.
content:
application/json:
schema:
$ref: '#/components/schemas/HostOut'
'404':
description: Not Found.
'/hosts/{host_id_list}':
get:
tags:
- hosts
summary: Find hosts by their IDs
description: >-
Find one or more hosts by their ID.
<br /><br />
Required permissions: inventory:hosts:read
operationId: api.host.get_host_by_id
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/hostIdList'
- $ref: '#/components/parameters/branchId'
- $ref: '#/components/parameters/perPageParam'
- $ref: '#/components/parameters/pageParam'
- $ref: '#/components/parameters/hostOrderByParam'
- $ref: '#/components/parameters/hostOrderHowParam'
- $ref: '#/components/parameters/fields_param'
responses:
'200':
description: Successfully searched for hosts.
content:
application/json:
schema:
$ref: '#/components/schemas/HostQueryOutput'
'400':
description: Invalid request.
'404':
description: Host not found.
delete:
tags:
- hosts
summary: Delete hosts by IDs
description: >-
Delete hosts by IDs
<br /><br />
Required permissions: inventory:hosts:write
operationId: api.host.delete_host_by_id
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/hostIdList'
- $ref: '#/components/parameters/branchId'
responses:
'200':
description: Successfully deleted hosts.
'400':
description: Invalid request.
'404':
description: Host not found.
patch:
tags:
- hosts
summary: Update hosts
description: >-
Update hosts
<br /><br />
Required permissions: inventory:hosts:write
operationId: api.host.patch_host_by_id
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/hostIdList'
- $ref: '#/components/parameters/branchId'
requestBody:
description: A group of fields to be updated on the hosts
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchHostIn'
responses:
'200':
description: Successfully updated the hosts.
'400':
description: Invalid request.
'404':
description: Host not found.
'/hosts/{host_id_list}/facts/{namespace}':
patch:
tags:
- hosts
summary: Merge facts under a namespace
description: >-
Merge one or multiple hosts facts under a namespace.
<br /><br />
Required permissions: inventory:hosts:write
operationId: api.host.merge_facts
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/hostIdList'
- $ref: '#/components/parameters/factsNamespace'
- $ref: '#/components/parameters/branchId'
requestBody:
description: A dictionary with the new facts to merge with the original ones.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Facts'
responses:
'200':
description: Successfully merged facts.
'400':
description: Invalid request.
'404':
description: Host or namespace not found.
put:
tags:
- hosts
summary: Replace facts under a namespace
description: >-
Replace facts under a namespace
<br /><br />
Required permissions: inventory:hosts:write
security:
- ApiKeyAuth: []
operationId: api.host.replace_facts
parameters:
- $ref: '#/components/parameters/hostIdList'
- $ref: '#/components/parameters/factsNamespace'
- $ref: '#/components/parameters/branchId'
requestBody:
description: A dictionary with the new facts to replace the original ones.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Facts'
responses:
'200':
description: Successfully replaced facts.
'400':
description: Invalid request.
'404':
description: Host or namespace not found.
'/hosts/{host_id_list}/system_profile':
get:
tags:
- hosts
summary: Return one or more hosts system profile
description: >-
Find one or more hosts by their ID and return the id and system profile
<br /><br />
Required permissions: inventory:hosts:read
operationId: api.host.get_host_system_profile_by_id
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/hostIdList'
- $ref: '#/components/parameters/perPageParam'
- $ref: '#/components/parameters/pageParam'
- $ref: '#/components/parameters/hostOrderByParam'
- $ref: '#/components/parameters/hostOrderHowParam'
- $ref: '#/components/parameters/branchId'
- $ref: '#/components/parameters/fields_param'
responses:
'200':
description: Successfully searched for hosts.
content:
application/json:
schema:
$ref: '#/components/schemas/SystemProfileByHostOut'
'400':
description: Invalid request.
'404':
description: Host not found.
'/hosts/{host_id_list}/tags':
get:
tags:
- hosts
summary: Get the tags on a host
description: >-
Get the tags on a host
<br /><br />
Required permissions: inventory:hosts:read
operationId: api.host.get_host_tags
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/hostIdList'
- $ref: '#/components/parameters/perPageParam'
- $ref: '#/components/parameters/pageParam'
- $ref: '#/components/parameters/hostOrderByParam'
- $ref: '#/components/parameters/hostOrderHowParam'
- $ref: '#/components/parameters/searchParam'
responses:
'200':
description: Successfully found tags.
content:
application/json:
schema:
$ref: '#/components/schemas/TagsOut'
'400':
description: Invalid request.
'/hosts/{host_id_list}/tags/count':
get:
tags:
- hosts
summary: Get the number of tags on a host or hosts
description: >-
Get the number of tags on a host or hosts
<br /><br />
Required permissions: inventory:hosts:read
operationId: api.host.get_host_tag_count
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/hostIdList'
- $ref: '#/components/parameters/perPageParam'
- $ref: '#/components/parameters/pageParam'
- $ref: '#/components/parameters/hostOrderByParam'
- $ref: '#/components/parameters/hostOrderHowParam'
responses:
'200':
description: Successfully found tag count.
content:
application/json:
schema:
$ref: '#/components/schemas/TagCountOut'
'400':
description: Invalid request.
'/host_exists':
get:
tags:
- hosts
summary: Find one host by insights_id, if it exists
description: >-
Find one host by insights_id, if it exists.
<br /><br />
Required permissions: inventory:hosts:read
operationId: api.host.get_host_exists
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/insightsId'
responses:
'200':
description: Found a matching host.
content:
application/json:
schema:
$ref: '#/components/schemas/HostIdOut'
'400':
description: Invalid request.
'404':
description: Host not found.
'409':
description: Multiple matching hosts detected.
/groups:
get:
operationId: api.group.get_group_list
tags:
- groups
summary: Read the entire list of groups
description: >-
Read the entire list of all groups available to the account.
<br /><br />
Required permissions: inventory:groups:read
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/groupName'
- $ref: '#/components/parameters/perPageParam'
- $ref: '#/components/parameters/pageParam'
- $ref: '#/components/parameters/groupOrderByParam'
- $ref: '#/components/parameters/groupOrderHowParam'
responses:
'200':
description: Successfully read the groups list.
content:
application/json:
schema:
$ref: '#/components/schemas/GroupQueryOutput'
'400':
description: Groups not found.
post:
operationId: api.group.create_group
tags:
- groups
summary: Create a new group matching the provided name and list of hosts IDs
description: >-
Creates a new group containing the hosts associated with the host IDs provided.
<br /><br />
Required permissions: inventory:groups:write
security:
- ApiKeyAuth: []
- BearerAuth: []
requestBody:
description: Data required to create a record for a group.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GroupIn'
responses:
'201':
description: Successfully created new Group.
content:
application/json:
schema:
$ref: '#/components/schemas/GroupOutWithHostCount'
"400":
"description": "Invalid request."
"403":
"description": "Forbidden - Invalid RBAC permission."
'/groups/{group_id}':
patch:
operationId: api.group.patch_group_by_id
tags:
- groups
summary: Update group information
description: >-
Update group information, removing any existing host associations from the group.
<br /><br />
Required permissions: inventory:groups:write
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/groupId'
requestBody:
description: A dictionary with new information with which to update the original group.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GroupIn'
responses:
'200':
description: Group information successfully updated.
content:
application/json:
schema:
$ref: '#/components/schemas/GroupOutWithHostCount'
'400':
description: Invalid request.
'404':
description: Group not found.
'/groups/{group_id_list}':
get:
operationId: api.group.get_groups_by_id
tags:
- groups
summary: Find groups by their IDs
description: >-
Find one or more groups by their IDs.
<br /><br />
Required permissions: inventory:groups:read
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/groupIdList'
- $ref: '#/components/parameters/perPageParam'
- $ref: '#/components/parameters/pageParam'
- $ref: '#/components/parameters/groupOrderByParam'
- $ref: '#/components/parameters/groupOrderHowParam'
responses:
'200':
description: Successfully searched for groups.
content:
application/json:
schema:
$ref: '#/components/schemas/GroupQueryOutput'
'400':
description: Invalid request.
'404':
description: Groups not found.
delete:
operationId: api.group.delete_groups
tags:
- groups
summary: Delete a list of groups
description: >-
Delete a list of groups.
<br /><br />
Required permissions: inventory:groups:write
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/groupIdList'
responses:
'204':
description: The groups were successfully deleted.
'400':
description: Invalid request.
'/groups/{group_id}/hosts/{host_id_list}':
delete:
operationId: api.host_group.delete_hosts_from_group
tags:
- groups
summary: Delete one or more hosts from a group
description: >-
Delete one or more hosts from a group.
<br /><br />
Required permissions: inventory:groups:write
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/groupId'
- $ref: '#/components/parameters/hostIdList'
responses:
'204':
description: Successfully deleted hosts.
'400':
description: Invalid request.
'/groups/{group_id}/hosts':
post:
operationId: api.host_group.add_host_list_to_group
tags:
- groups
summary: Add host IDs to the provided group
description: >-
Adds the host list in the request body to the provided group.
<br /><br />
Required permissions: inventory:groups:write
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/groupId'
requestBody:
description: A list of hosts IDs to associate with the provided group.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/HostIds'
responses:
'200':
description: Hosts successfully or already previously associated with group.
content:
application/json:
schema:
$ref: '#/components/schemas/GroupOutWithHostCount'
'400':
description: Invalid request.
'404':
description: Group not found.
'/groups/hosts/{host_id_list}':
delete:
operationId: api.group.delete_hosts_from_different_groups
tags:
- groups
summary: Delete a list of hosts from the groups they are in
description: >-
Delete a list of hosts from the groups they are in.
<br /><br />
Required permissions: inventory:groups:write
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/hostIdList'
responses:
'204':
description: The hosts were successfully removed from their groups.
'400':
description: Invalid request.
'404':
description: The provided hosts are ungrouped.
/resource-types:
get:
operationId: api.resource_type.get_resource_type_list
tags:
- resource-types
summary: Get the list of resource types
description: >-
Returns the list of available RBAC resource types.
<br /><br />
Required permissions: rbac:*:*
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/resourceTypesPerPageParam'
- $ref: '#/components/parameters/pageParam'
responses:
'200':
description: Successfully read the resource types list.
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceTypesQueryOutput'
'400':
description: Resource types not found.
/resource-types/inventory-groups:
get:
operationId: api.resource_type.get_resource_type_groups_list
tags:
- resource-types
summary: Get the list of inventory groups in resource-types format
description: >-
Returns the list of groups in the current account.
<br /><br />
Required permissions: rbac:*:*
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/groupName'
- $ref: '#/components/parameters/resourceTypesPerPageParam'
- $ref: '#/components/parameters/pageParam'
responses:
'200':
description: Successfully read the resource-types groups list.
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceTypesGroupsQueryOutput'
'400':
description: Groups not found.
/tags:
get:
tags:
- tags
summary: Get the active host tags for a given account
description: >-
Required permissions: inventory:hosts:read
operationId: api.tag.get_tags
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/tagsParam'
- $ref: '#/components/parameters/tagsOrderBy'
- $ref: '#/components/parameters/tagsOrderHow'
- $ref: '#/components/parameters/perPageParam'
- $ref: '#/components/parameters/pageParam'
- $ref: '#/components/parameters/stalenessParam'
- $ref: '#/components/parameters/searchParam'
- $ref: '#/components/parameters/displayName'
- $ref: '#/components/parameters/fqdn'
- $ref: '#/components/parameters/hostnameOrId'
- $ref: '#/components/parameters/insightsId'
- $ref: '#/components/parameters/providerId'
- $ref: '#/components/parameters/providerType'
- $ref: '#/components/parameters/updatedStart'
- $ref: '#/components/parameters/updatedEnd'
- $ref: '#/components/parameters/groupNameListParam'
- $ref: '#/components/parameters/registered_with'
- $ref: '#/components/parameters/filter_param'
responses:
'200':
description: Tags
content:
application/json:
schema:
$ref: '#/components/schemas/ActiveTags'
'400':
description: Invalid request.
'404':
$ref: '#/components/responses/PageOutOfBounds'
/system_profile/sap_system:
get:
tags:
- system_profile
summary: get all sap system values and counts on the account
description: >-
Required permissions: inventory:hosts:read
operationId: api.system_profile.get_sap_system
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/tagsParam'
- $ref: '#/components/parameters/perPageParam'
- $ref: '#/components/parameters/pageParam'
- $ref: '#/components/parameters/stalenessParam'
- $ref: '#/components/parameters/registered_with'
- $ref: '#/components/parameters/filter_param'
responses:
'200':
description: sap_system values and counts for the account
content:
application/json:
schema:
$ref: '#/components/schemas/SystemProfileSapSystemOut'
'400':
description: Invalid request.
'404':
$ref: '#/components/responses/PageOutOfBounds'
/system_profile/sap_sids:
get:
tags:
- system_profile
summary: get all sap sids values and counts on the account
description: >-
Required permissions: inventory:hosts:read
operationId: api.system_profile.get_sap_sids
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/searchParam'
- $ref: '#/components/parameters/tagsParam'
- $ref: '#/components/parameters/perPageParam'
- $ref: '#/components/parameters/pageParam'
- $ref: '#/components/parameters/stalenessParam'
- $ref: '#/components/parameters/registered_with'
- $ref: '#/components/parameters/filter_param'
responses:
'200':
description: sap_system values and counts for the account
content:
application/json:
schema:
$ref: '#/components/schemas/SystemProfileSapSystemOut'
'400':
description: Invalid request.
'404':
$ref: '#/components/responses/PageOutOfBounds'
/system_profile/operating_system:
get:
tags:
- system_profile
summary: get all operating system versions and counts on the account
description: >-
Required permissions: inventory:hosts:read
operationId: api.system_profile.get_operating_system
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/tagsParam'
- $ref: '#/components/parameters/perPageParam'
- $ref: '#/components/parameters/pageParam'
- $ref: '#/components/parameters/stalenessParam'
- $ref: '#/components/parameters/registered_with'
- $ref: '#/components/parameters/filter_param'
responses:
'200':
description: operating system versions and counts on the account
content:
application/json:
schema:
$ref: '#/components/schemas/SystemProfileOperatingSystemOut'
'400':
description: Invalid request.
'404':
$ref: '#/components/responses/PageOutOfBounds'
/system_profile/validate_schema:
post:
tags:
- system_profile
summary: validate system profile schema
description: >-
Validates System Profile data from recent Kafka messages against a given spec,
and compares it with the current one. Only HBI Admins can access this endpoint.
operationId: api.system_profile.validate_schema
security:
- ApiKeyAuth: []
parameters:
- in: query
name: repo_fork
schema:
type: string
description: The fork of the inventory-schemas repo to use
- in: query
name: repo_branch
schema:
type: string
description: The branch of the inventory-schemas repo to use
required: true
- in: query
name: days
schema:
type: integer
minimum: 1
description: How many days worth of data to validate
- in: query
name: max_messages
schema:
type: integer
minimum: 1
default: 10000
description: Stops polling when this number of messages has been collected
responses:
'200':
description: Host validation results
'403':
description: Forbidden
/account/staleness:
get:
operationId: api.staleness.get_staleness
tags:
- accounts_staleness
summary: Read the entire list of account staleness
description: >-
Read the entire list of all accounts staleness available.
Required permissions: staleness:staleness:read
security:
- ApiKeyAuth: []
- BearerAuth: []
responses:
'200':
description: Successfully read the staleness account.
content:
application/json:
schema:
$ref: '#/components/schemas/StalenessOutput'
'400':
description: "Invalid request."
post:
operationId: api.staleness.create_staleness
tags:
- accounts_staleness
summary: Create account staleness record
description: >-
Create account staleness record.
Required permissions: staleness:staleness:write
security:
- ApiKeyAuth: []
- BearerAuth: []
requestBody:
description: Data required to create a record for a account staleness.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StalenessIn'
responses:
'201':
description: Successfully account staleness created.
content:
application/json:
schema:
$ref: '#/components/schemas/StalenessOutput'
'400':
description: "Invalid request."
patch:
operationId: api.staleness.update_staleness
tags:
- accounts_staleness
summary: Update account staleness record
description: >-
Update account staleness record.
Required permissions: staleness:staleness:write
security:
- ApiKeyAuth: []
- BearerAuth: []
requestBody:
description: Data required to update a record for a account staleness.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StalenessIn'
responses:
'200':
description: Successfully account staleness updated.
content:
application/json:
schema:
$ref: '#/components/schemas/StalenessOutput'
'400':
description: Invalid request.
'404':
description: Staleness record not found.
delete:
operationId: api.staleness.delete_staleness
tags:
- accounts_staleness
summary: Delete an account staleness
description: >-
Delete an account staleness
<br /><br />
Required permissions: staleness:staleness:write
security:
- ApiKeyAuth: []
- BearerAuth: []
responses:
'204':
description: Successfully deleted account staleness.
'400':
description: Invalid request.
'404':
description: Account Staleness not found.
/account/staleness/defaults:
get:
operationId: api.staleness.get_default_staleness
tags:
- accounts_staleness
summary: Read the entire list of account staleness
description: >-
Read the entire list of all accounts staleness available.
Required permissions: staleness:staleness:read
security:
- ApiKeyAuth: []
- BearerAuth: []
responses:
'200':
description: Successfully read the staleness account.
content:
application/json:
schema:
$ref: '#/components/schemas/StalenessOutput'
'400':
description: "Invalid request."
/assignment-rules:
get:
operationId: api.assignment_rule.get_assignment_rules_list
tags:
- groups
summary: Read the entire list of assignment-rules [Not Implemented]
description: >-
Read the entire list of all assignment-rules available to the account. [Not Implemented]
Required permissions: inventory:groups:read
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/assignmentRuleName'
- $ref: '#/components/parameters/perPageParam'
- $ref: '#/components/parameters/pageParam'
- $ref: '#/components/parameters/assignmentRuleOrderByParam'
- $ref: '#/components/parameters/assignmentRuleOrderHowParam'
responses:
'200':
description: Successfully read the assignment-rules list.
content:
application/json:
schema:
$ref: '#/components/schemas/AssignmentRuleQueryOutput'
post:
operationId: api.assignment_rule.create_assignment_rule
tags:
- groups
summary: Create Assignment Rule object
description: >-
Create Assignment Rule object using post request
<br /><br />
Required permissions: inventory:groups:write
security:
- ApiKeyAuth: []
- BearerAuth: []
requestBody:
description: Data required to create Assignment Rule object
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssignmentRuleIn'
responses:
'201':
description: Assignment Rule created
content:
application/json:
schema:
$ref: '#/components/schemas/AssignmentRuleOut'
'/assignment-rules/{assignment_rule_id_list}':
get:
operationId: api.assignment_rule.get_assignment_rules_by_id
tags:
- groups
summary: Find assignment rules by their IDs
description: >-
Find one or more assignment rules by their IDs.
<br /><br />
Required permissions: inventory:groups:read
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/assignmentRuleIdList'
- $ref: '#/components/parameters/perPageParam'
- $ref: '#/components/parameters/pageParam'
- $ref: '#/components/parameters/assignmentRuleOrderByParam'
- $ref: '#/components/parameters/assignmentRuleOrderHowParam'