This repository has been archived by the owner on Nov 18, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7
/
openapi.yml
1057 lines (1057 loc) · 28.3 KB
/
openapi.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
description: Swagger Specifications for public APIs
version: beta
title: Sophos Public API
termsOfService: https://www.sophos.com/en-us/legal/sophos-end-user-license-agreement.aspx
contact:
name: Sophos-public-api-handler
url: https://cloud.sophos.com/
email: [email protected]
license:
name: Sophos Central License
url: https://www.sophos.com/en-us/legal/sophos-professional-services.aspx
tags:
- name: event-controller-v-1-impl
description: Retrieve events for a given customer
- name: alert-controller-v-1-impl
description: Retrieve alerts for a given customer
- name: sec-migration-controller-v-1-impl
description: API to provide data required for migration to cloud
paths:
/migration-tool/v1/deployment/agent/locations:
get:
tags:
- sec-migration-controller-v-1-impl
summary: Get the installer information.
operationId: getInstallerInfoUsingGET_1
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/InstallerInfoResponse"
"400":
description: Bad Request
"401":
description: customer not authorized to make api call
"403":
description: Forbidden
"404":
description: Not Found
"500":
description: Internal Server Error
security:
- api_key: []
parameters:
- name: x-api-key
in: header
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
- name: X-Timestamp
in: header
required: false
schema:
type: string
/migration-tool/v1/download/hashes:
get:
tags:
- sec-migration-controller-v-1-impl
summary: Get SHA1 hashes for all available installer templates.
operationId: hashesUsingGET_1
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/HashesResponse"
"400":
description: Bad Request
"401":
description: customer not authorized to make api call
"403":
description: Forbidden
"404":
description: Not Found
"500":
description: Internal Server Error
security:
- api_key: []
parameters:
- name: x-api-key
in: header
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
- name: X-Timestamp
in: header
required: false
schema:
type: string
/migration-tool/v1/endpoints:
get:
tags:
- sec-migration-controller-v-1-impl
summary: Get endpoints for customer based on the parameters provided
operationId: endpointsUsingGET_1
parameters:
- name: since
in: query
description: The timestamp to start searching from
required: false
schema:
type: string
- name: offset
in: query
description: The paging offset
required: false
schema:
type: integer
format: int32
- name: x-api-key
in: header
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
- name: X-Timestamp
in: header
required: false
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/EndpointsResponse"
"400":
description: Bad Request
"401":
description: customer not authorized to make api call
"403":
description: Forbidden
"404":
description: Not Found
"500":
description: Internal Server Error
security:
- api_key: []
/migration-tool/v1/features/current:
get:
tags:
- sec-migration-controller-v-1-impl
summary: Get current features for a customer
operationId: getCustomerFeaturesUsingGET_1
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/CustomerFeaturesResponse"
"400":
description: Bad Request
"401":
description: customer not authorized to make api call
"403":
description: Forbidden
"404":
description: Not Found
"500":
description: Internal Server Error
security:
- api_key: []
parameters:
- name: x-api-key
in: header
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
- name: X-Timestamp
in: header
required: false
schema:
type: string
/migration-tool/v1/licenses/current:
get:
tags:
- sec-migration-controller-v-1-impl
summary: Get current licenses for customer
operationId: getCurrentLicensesUsingGET_1
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/CurrentLicensesResponse"
"400":
description: Bad Request
"401":
description: customer not authorized to make api call
"403":
description: Forbidden
"404":
description: Not Found
"500":
description: Internal Server Error
security:
- api_key: []
parameters:
- name: x-api-key
in: header
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
- name: X-Timestamp
in: header
required: false
schema:
type: string
/siem/v1/alerts:
get:
tags:
- alert-controller-v-1-impl
summary: Get alerts for customer based on the parameters provided
description: "Note: Alerts are retrieved for timestamps within last 24 hours"
operationId: getAlertsUsingGET_1
parameters:
- name: limit
in: query
description: The maximum number of items to return, default is 200, max is 1000
required: false
schema:
type: integer
format: int32
minimum: 200
maximum: 1000
default: 200
- name: from_date
in: query
description: The starting date from which alerts will be retrieved defined as
Unix timestamp in UTC. Ignored if cursor is set. Must be within last
24 hours.
required: false
schema:
type: integer
format: int64
- name: cursor
in: query
description: Identifier for next item in the list, this value is available in
response as next_cursor. Response will default to last 24 hours if
cursor is not within last 24 hours.
required: false
schema:
type: string
- name: x-api-key
in: header
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
- name: X-Timestamp
in: header
required: false
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/AlertAggregate"
"400":
description: Bad Request
"401":
description: customer not authorized to make api call
"403":
description: Forbidden
"404":
description: Not Found
"500":
description: Internal Server Error
security:
- api_key: []
/siem/v1/events:
get:
tags:
- event-controller-v-1-impl
summary: Get events for customer based on the parameters provided
description: "Note: Events are retrieved for timestamps within last 24 hours"
operationId: getEventsUsingGET_1
parameters:
- name: limit
in: query
description: The maximum number of items to return, default is 200, max is 1000
required: false
schema:
type: integer
format: int32
minimum: 200
maximum: 1000
default: 200
- name: cursor
in: query
description: Identifier for next item in the list, this value is available in
response as next_cursor. Response will default to last 24 hours if
cursor is not within last 24 hours.
required: false
schema:
type: string
- name: from_date
in: query
description: The starting date from which alerts will be retrieved defined as
Unix timestamp in UTC.Ignored if cursor is set. Must be within last
24 hours
required: false
schema:
type: integer
format: int64
- name: exclude_types
in: query
description: The String of list of types of events to be excluded
required: false
schema:
type: string
- name: x-api-key
in: header
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
- name: X-Timestamp
in: header
required: false
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/EventAggregate"
"400":
description: Bad Request
"401":
description: customer not authorized to make api call
"403":
description: Forbidden
"404":
description: Not Found
"500":
description: Internal Server Error
security:
- api_key: []
servers:
- url: https://api1.central.sophos.com/gateway
components:
securitySchemes:
api_key:
type: apiKey
name: x-api-key
in: header
schemas:
EndpointsResponse:
type: object
properties:
filtered:
type: integer
format: int32
items:
type: array
items:
$ref: "#/components/schemas/EndpointEntity"
next_key:
type: string
total:
type: integer
format: int32
description: Sophos Central Endpoints Model
InstallerHashesEntity:
type: object
AlertAggregate:
type: object
properties:
has_more:
type: boolean
items:
type: array
items:
$ref: "#/components/schemas/AlertEntity"
next_cursor:
type: string
description: Value of the next cursor. This will be used to make next call of api
description: Sophos Central Alert Model
EndpointCoreEventCertificate:
type: object
properties:
signer:
type: string
thumbprint:
type: string
DateTime:
type: object
properties:
afterNow:
type: boolean
beforeNow:
type: boolean
centuryOfEra:
type: integer
format: int32
chronology:
$ref: "#/components/schemas/Chronology"
dayOfMonth:
type: integer
format: int32
dayOfWeek:
type: integer
format: int32
dayOfYear:
type: integer
format: int32
equalNow:
type: boolean
era:
type: integer
format: int32
hourOfDay:
type: integer
format: int32
millis:
type: integer
format: int64
millisOfDay:
type: integer
format: int32
millisOfSecond:
type: integer
format: int32
minuteOfDay:
type: integer
format: int32
minuteOfHour:
type: integer
format: int32
monthOfYear:
type: integer
format: int32
secondOfDay:
type: integer
format: int32
secondOfMinute:
type: integer
format: int32
weekOfWeekyear:
type: integer
format: int32
weekyear:
type: integer
format: int32
year:
type: integer
format: int32
yearOfCentury:
type: integer
format: int32
yearOfEra:
type: integer
format: int32
zone:
$ref: "#/components/schemas/DateTimeZone"
EventDetailProperty:
type: object
properties:
property:
type: string
type:
type: string
enum:
- CORE_EVENT_REQUEST_ID
- CORE_EVENT_RESPONSE_STATUS
- HMPA_EVENT_REPORT
- HMPA_EVENT_TYPE
- HMPA_PROCESS_VERSION
- HMPA_PROCESS_PID
- HMPA_PROCESS_PATH
- HOME_FAMILY_ID
- HOME_SCAN_LABEL
- HOME_SCAN_STATE
- HOME_SCAN_CLEAN
- HOME_SCAN_REBOOT
- HOME_COOKIES_COUNT
- HOME_COOKIES_DOMAINS
- HOME_REMNANT_FAMILY
- HOME_REMNANT_NAME
- HOME_REMNANT_PATHS
EventAggregate:
type: object
properties:
has_more:
type: boolean
items:
type: array
items:
$ref: "#/components/schemas/LegacyEventEntity"
next_cursor:
type: string
description: Value of the next cursor. This will be used to make next call of api
description: Sophos Central Event Model
AlertEntity:
type: object
properties:
created_at:
type: string
description: The date at which the alert was created
customer_id:
type: string
description: The unique identifier of the customer linked with this record
data:
type: object
additionalProperties:
type: object
description:
type: string
description: The description of the alert that was generated
event_service_event_id:
type: string
description: The Event Services event id
id:
type: string
description: Identifier for the alert
info:
type: object
additionalProperties:
type: object
location:
type: string
description: The location captured for this record
severity:
type: string
description: The severity for this alert
enum:
- LOW
- MEDIUM
- HIGH
source:
type: string
description: Describes the source from alert was generated
threat:
type: string
description: The name of the threat responsible for the generation of alert
threat_cleanable:
type: boolean
type:
type: string
description: Describes the type of the device on which alert was generated
when:
type: string
description: The date at which the alert was created
description: This model wraps up an Alert. This contains various fields that contain
information regarding the alert that was generated.
TamperProtectionEntity:
type: object
properties:
enabled:
type: boolean
globally_enabled:
type: boolean
password:
type: string
previous_passwords:
type: array
items:
$ref: "#/components/schemas/PreviousPasswordEntity"
Chronology:
type: object
properties:
zone:
$ref: "#/components/schemas/DateTimeZone"
InstallerInfoResponse:
type: object
properties:
installerInfo:
type: array
items:
$ref: "#/components/schemas/InstallerInfo"
description: Sophos Central Installer Info Model
PreviousPasswordEntity:
type: object
properties:
invalidated:
$ref: "#/components/schemas/DateTime"
password:
type: string
CoreRemedyItems:
type: object
properties:
items:
type: array
items:
$ref: "#/components/schemas/CoreRemedyItem"
totalItems:
type: integer
format: int32
CustomerLicense:
type: object
properties:
expired:
type: boolean
expires_on:
$ref: "#/components/schemas/DateTime"
id:
$ref: "#/components/schemas/ObjectId"
license_code:
type: string
license_id:
type: string
license_type:
type: string
enum:
- ALPHA
- BETA
- EAP
- ENTERPRISE
- FULL
- FREE
- MONTHLY
- MSP
- TERMED
- TRIAL
- VIRTUAL
quota:
type: integer
format: int32
starts_on:
$ref: "#/components/schemas/DateTime"
suspended:
type: boolean
ObjectId:
type: object
properties:
counter:
type: integer
format: int32
date:
type: string
format: date-time
machineIdentifier:
type: integer
format: int32
processIdentifier:
type: integer
format: int32
time:
type: integer
format: int64
timeSecond:
type: integer
format: int32
timestamp:
type: integer
format: int32
EndpointAdSyncInfo:
type: object
properties:
dn:
type: string
external_id:
type: string
from_ad_sync:
type: boolean
name:
type: string
CurrentLicensesResponse:
type: object
properties:
licenses:
type: array
items:
$ref: "#/components/schemas/CustomerLicense"
description: Sophos Central License Model
EndpointWhitelistProperties:
type: object
properties:
property:
type: string
type:
type: string
enum:
- SHA_256
- CERTIFICATE_SIGNER
- PATH
- THUMBPRINT
- PROCESS_NAME
CustomerFeature:
type: object
properties:
expirationProcessed:
type: boolean
expired:
type: boolean
expiresOn:
$ref: "#/components/schemas/DateTime"
featureCode:
type: string
enum:
- f_invalid
- f_srv
- f_srv_av
- f_srv_appctl
- f_srv_devctl
- f_srv_devctl_block
- f_srv_dlp
- f_srv_lockdown
- f_srv_web
- f_srv_mtd
- f_srv_xpd
- f_srv_hbt
- f_srv_stac
- f_srv_ml
- f_srv_efw
- f_srv_extsup_win2k3
- f_srv_fim
- f_srv_edr
- f_srv_mdr
- f_srv_blocklisting
- f_srv_isolation
- f_srv_file_submission_l2
- f_srv_file_submission_l3
- f_srv_on_demand_rca
- f_srv_forensic_snapshot
- f_virt_ep_av
- f_virt_srv_av
- f_ep
- f_ep_appctl
- f_ep_devctl
- f_ep_dlp
- f_ep_av
- f_ep_web
- f_ep_efw
- f_ep_denc_deprecated
- f_ep_denc
- f_ep_fenc
- f_ep_xpd
- f_ep_stac
- f_ep_ntp
- f_ep_ntp_adv
- f_ep_ntp_xg
- f_ep_hbt
- f_ep_hbt_adv
- f_ep_hbt_xg
- f_ep_extsup_winxp
- f_ep_ml
- f_ep_edr
- f_ep_mdr
- f_ep_blocklisting
- f_ep_isolation
- f_ep_file_submission_l2
- f_ep_file_submission_l3
- f_ep_on_demand_rca
- f_ep_forensic_snapshot
- f_mob
- f_mob_lock
- f_mob_locate
- f_mob_wipe
- f_mob_policy_compliance
- f_mob_policy_exchange
- f_mob_policy_passcode
- f_mob_policy_restrictions
- f_mob_policy_vpn
- f_mob_policy_wifi
- f_mob_container_email
- f_mob_container_mcm
- f_mob_container_docs
- f_mob_container_browser
- f_smc_migration
- f_smsec
- f_smsec_webfiltering
- f_csg
- f_multi_policies
- f_support
- f_user_specific
- f_ad_sync
- f_xgemail
- f_xgemail_antispam
- f_xgemail_av
- f_xgemail_eminbox
- f_xgemail_quarantine
- f_xgemail_ssp
- f_xgemail_ad_sync
- f_xgemail_dkim
- f_xgemail_spf
- f_xgemail_anti_phish
- f_xgemail_att_policy
- f_xgemail_dmarc
- f_xgemail_toc_url_protect
- f_xgemail_sandbox
- f_xgemail_content_filter
- f_xgemail_content_filter_v2
- f_xgemail_user_policy
- f_xgemail_encryption
- f_xgemail_smart_banner
- f_wifi_entry_standard
- f_wifi_performance_standard
- f_central_wifi_standard
- f_phish_training
generatedFromLicenseId:
type: string
licenseCode:
type: string
protection:
type: boolean
valid:
type: boolean
DateTimeZone:
type: object
properties:
fixed:
type: boolean
id:
type: string
CoreRemedyItem:
type: object
properties:
descriptor:
type: string
result:
type: string
enum:
- NOT_APPLICABLE
- SUCCESS
- NOT_FOUND
- DELETED
- FAILED_TO_DELETE
- WHITELISTED
- OTHER_ERROR
- FAILED_TO_DELETE_SYSTEM_PROTECTED
type:
type: string
InstallerInfo:
type: object
properties:
beta:
type: boolean
command:
type: string
platform:
type: string
productName:
type: string
url:
type: string
CustomerFeaturesResponse:
type: object
properties:
features:
type: array
items:
$ref: "#/components/schemas/CustomerFeature"
description: Sophos Central Customer Feature Model
LegacyEventEntity:
type: object
properties:
appCerts:
type: array
description: Certificate info of the application associated with the threat, if
available
items:
$ref: "#/components/schemas/EndpointCoreEventCertificate"
appSha256:
type: string
description: SHA 256 hash of the application associated with the threat, if
available
core_remedy_items:
$ref: "#/components/schemas/CoreRemedyItems"
created_at:
type: string
description: The date at which the event was created
customer_id:
type: string
description: The identifier of the customer for which record is created
details:
type: array
items:
$ref: "#/components/schemas/EventDetailProperty"
endpoint_id:
type: string
description: The corresponding endpoint id associated with the record
endpoint_type:
type: string
description: The corresponding endpoint type associated with the record
group:
type: string
description: The group associated with the group
id:
type: string
description: The Identifier for the event
location:
type: string
description: The location captured for this record
name:
type: string
description: The name of the record created
origin:
type: string
description: originating component of a detection
severity:
type: string
description: The severity for this alert
enum:
- NONE
- LOW
- MEDIUM
- HIGH
- CRITICAL
source:
type: string
description: The source for this record
source_info:
type: object
description: Detailed source information for this record
additionalProperties:
type: string
threat:
type: string
description: The threat associated with the record
type:
type: string
description: The type of this record
user_id:
type: string
description: The identifier of the user for which record is created
when:
type: string
description: The date at which the event was created
whitelist_properties:
type: array
items:
$ref: "#/components/schemas/EndpointWhitelistProperties"
description: This model wraps up an Event. This contains various fields that contain
information regarding the event that was generated.
HashesResponse:
type: object
properties:
hashes:
$ref: "#/components/schemas/InstallerHashesEntity"
description: Sophos Central Hashes Model
EndpointEntity:
type: object
properties:
adSyncInfo:
$ref: "#/components/schemas/EndpointAdSyncInfo"
alert_status:
type: integer
format: int32
assignedProducts:
type: array
items:
type: string
awsInfo:
type: object
additionalProperties:
type: string
azureInfo:
type: object
additionalProperties:
type: string
beta:
type: boolean
cloned:
type: boolean