forked from jmpsec/osctrl
-
Notifications
You must be signed in to change notification settings - Fork 1
/
osctrl-api.yaml
847 lines (847 loc) · 21.7 KB
/
osctrl-api.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
openapi: 3.0.1
servers:
- url: "{server}/api/v1"
variables:
server:
default: https://osctrl.net
info:
title: osctrl-api
description: "This the API for osctrl, a fast and efficient osquery management solution."
version: 0.3.7
externalDocs:
description: osctrl documentation
url: https://osctrl.net
tags:
- name: nodes
description: Enrolled nodes in osctrl
externalDocs:
description: osctrl nodes
url: https://github.com/jmpsec/osctrl/tree/master/nodes
- name: queries
description: On-demand queries in osctrl
externalDocs:
description: on-demand queries
url: https://github.com/jmpsec/osctrl/tree/master/queries
- name: platforms
description: Platforms of enrolled nodes in osctrl
externalDocs:
description: osctrl platforms
url: https://github.com/jmpsec/osctrl/tree/master/queries
- name: environments
description: Environments within osctrl
externalDocs:
description: osctrl environments
url: https://github.com/jmpsec/osctrl/tree/master/environments
- name: tags
description: Tags for enrolled nodes in osctrl
externalDocs:
description: osctrl tags
url: https://github.com/jmpsec/osctrl/tree/master/tags
- name: settings
description: Settings for all osctrl components
externalDocs:
description: osctrl settings
url: https://github.com/jmpsec/osctrl/tree/master/settings
paths:
/nodes:
get:
tags:
- nodes
summary: Get a single node by UUID
description: Returns the osctrl node by the provided UUID
operationId: apiNodesHandler
responses:
200:
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/OsqueryNode"
403:
description: no access
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
404:
description: no nodes
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
500:
description: error getting nodes
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
security:
- Authorization:
- read
- write
/nodes/{uuid}:
get:
tags:
- nodes
summary: Get node
description: Returns all enrolled osctrl nodes
operationId: apiNodeHandler
parameters:
- name: uuid
in: path
description: UUID of the requested enrolled node
required: true
schema:
type: string
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/OsqueryNode"
403:
description: no access
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
404:
description: node not found
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
500:
description: error getting node
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
security:
- Authorization:
- read
- write
/queries:
get:
tags:
- queries
summary: Get on-demand queries
description: Returns all hidden osctrl on-demand queries
operationId: apiHiddenQueriesShowHandler
responses:
200:
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/DistributedQuery"
403:
description: no access
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
404:
description: no queries
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
500:
description: error getting queries
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
security:
- Authorization:
- read
- write
post:
tags:
- queries
summary: Run new query
description: Creates a new on-demand query to run
operationId: apiQueriesRunHandler
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/DistributedQueryRequest"
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/ApiQueriesResponse"
403:
description: no access
content: {}
404:
description: no queries
content: {}
500:
description: error getting queries
content: {}
security:
- Authorization:
- read
- write
/queries/{name}:
get:
tags:
- queries
summary: Get on-demand query
description: Returns the requested on-demand query by name
operationId: apiQueryShowHandler
parameters:
- name: name
in: path
description: Name of the requested on-demand query
required: true
schema:
type: string
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/DistributedQuery"
403:
description: no access
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
404:
description: query not found
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
500:
description: error getting query
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
security:
- Authorization:
- read
- write
/queries/results/{name}:
get:
tags:
- queries
summary: Get on-demand query results
description: Returns the requested on-demand query results by name
operationId: apiQueryResultsHandler
parameters:
- name: name
in: path
description: Name of the requested on-demand query
required: true
schema:
type: string
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/APIQueryData"
403:
description: no access
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
404:
description: query not found
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
500:
description: error getting results
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
security:
- Authorization:
- read
- write
/all-queries:
get:
tags:
- queries
summary: Get on-demand queries
description: Returns all osctrl on-demand queries
operationId: apiAllQueriesShowHandler
responses:
200:
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/DistributedQuery"
403:
description: no access
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
404:
description: no queries
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
500:
description: error getting queries
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
security:
- Authorization:
- read
- write
/platforms:
get:
tags:
- platforms
summary: Get platforms
description: Returns all osctrl platforms of enrolled nodes
operationId: apiPlatformsHandler
responses:
200:
description: successful operation
content:
application/json:
schema:
type: array
items:
type: string
403:
description: no access
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
404:
description: no queries
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
500:
description: error getting queries
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
security:
- Authorization:
- read
- write
/environments:
get:
tags:
- environments
summary: Get environments
description: Returns all osctrl environments to enroll nodes
operationId: apiEnvironmentsHandler
responses:
200:
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/TLSEnvironment"
403:
description: no access
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
404:
description: no environments
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
500:
description: error getting environments
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
security:
- Authorization:
- read
- write
/environments/{environment}:
get:
tags:
- environments
summary: Get environment
description: Returns the requested osctrl environment to enroll nodes
operationId: apiEnvironmentHandler
parameters:
- name: environment
in: path
description: Name of the requested osctrl environment to enroll nodes
required: true
schema:
type: string
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/TLSEnvironment"
403:
description: no access
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
500:
description: error getting environment
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
security:
- Authorization:
- read
- write
/tags:
get:
tags:
- tags
summary: Get tags
description: Returns all osctrl environments to enroll nodes
operationId: apiTagsHandler
responses:
200:
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/AdminTag"
403:
description: no access
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
500:
description: error getting tags
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
security:
- Authorization:
- read
- write
/settings:
get:
tags:
- settings
summary: Get settings
description: Returns all osctrl services settings
operationId: apiSettingsHandler
responses:
200:
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/SettingValue"
403:
description: no access
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
500:
description: error getting settings
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
security:
- Authorization:
- read
- write
/settings/{service}:
get:
tags:
- settings
summary: Get settings
description: Returns all osctrl settings per service
operationId: apiSettingsServiceHandler
parameters:
- name: service
in: path
description: Name of the service to retrieve settings, including JSON
required: true
schema:
type: string
responses:
200:
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/SettingValue"
403:
description: no access
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
500:
description: error getting settings
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
security:
- Authorization:
- read
- write
/settings/{service}/json:
get:
tags:
- settings
summary: Get JSON settings
description: Returns JSON osctrl settings per service
operationId: apiSettingsServiceJSONHandler
parameters:
- name: service
in: path
description: Name of the service to retrieve JSON only settings
required: true
schema:
type: string
responses:
200:
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/SettingValue"
403:
description: no access
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
500:
description: error getting settings
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorResponse"
security:
- Authorization:
- read
- write
components:
schemas:
OsqueryNode:
type: object
properties:
ID:
type: integer
format: int32
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
DeletedAt:
type: string
format: date-time
NodeKey:
type: string
UUID:
type: string
Platform:
type: string
PlatformVersion:
type: string
OsqueryVersion:
type: string
Hostname:
type: string
Localname:
type: string
Username:
type: string
OsqueryUser:
type: string
Environment:
type: string
CPU:
type: string
Memory:
type: string
HardwareSerial:
type: string
DaemonHash:
type: string
ConfigHash:
type: string
RawEnrollment:
type: string
LastStatus:
type: string
format: date-time
LastResult:
type: string
format: date-time
LastConfig:
type: string
format: date-time
LastQueryRead:
type: string
format: date-time
LastQueryWrite:
type: string
format: date-time
DistributedQuery:
type: object
properties:
ID:
type: integer
format: int32
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
DeletedAt:
type: string
format: date-time
Name:
type: string
Creator:
type: string
Query:
type: string
Expected:
type: integer
format: int32
Executions:
type: integer
format: int32
Errors:
type: integer
format: int32
Active:
type: boolean
Hidden:
type: boolean
Protected:
type: boolean
Completed:
type: boolean
Deleted:
type: boolean
Type:
type: string
Path:
type: string
DistributedQueryRequest:
type: object
properties:
environment_list:
type: array
items:
type: string
platform_list:
type: array
items:
type: string
uuid_list:
type: array
items:
type: string
host_list:
type: array
items:
type: string
query:
type: string
ApiQueriesResponse:
type: object
properties:
query_name:
type: string
ApiErrorResponse:
type: object
properties:
error:
type: string
APIQueryData:
type: object
TLSEnvironment:
type: object
properties:
ID:
type: integer
format: int32
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
DeletedAt:
type: string
format: date-time
Name:
type: string
Hostname:
type: string
Secret:
type: string
EnrollSecretPath:
type: string
EnrollExpire:
type: string
format: date-time
RemoveSecretPath:
type: string
RemoveExpire:
type: string
format: date-time
Type:
type: string
DebugHTTP:
type: boolean
Icon:
type: string
Configuration:
type: string
Flags:
type: string
Certificate:
type: string
ConfigTLS:
type: boolean
ConfigInterval:
type: integer
format: int32
LoggingTLS:
type: boolean
LogInterval:
type: integer
format: int32
QueryTLS:
type: boolean
QueryInterval:
type: integer
format: int32
CarvesTLS:
type: boolean
EnrollPath:
type: string
LogPath:
type: string
ConfigPath:
type: string
QueryReadPath:
type: string
QueryWritePath:
type: string
CarverInitPath:
type: string
CarverBlockPath:
type: string
AdminTag:
type: object
properties:
ID:
type: integer
format: int32
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
DeletedAt:
type: string
format: date-time
Name:
type: string
Description:
type: string
Color:
type: string
Icon:
type: string
SettingValue:
type: object
properties:
ID:
type: integer
format: int32
CreatedAt:
type: string
format: date-time
UpdatedAt:
type: string
format: date-time
DeletedAt:
type: string
format: date-time
Service:
type: string
JSON:
type: boolean
Type:
type: string
String:
type: string
Boolean:
type: boolean
Integer:
type: integer
format: int64
Info:
type: string
securitySchemes:
Authorization:
type: http
scheme: bearer
bearerFormat: JWT