forked from koala73/worldmonitor
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathInfrastructureService.openapi.yaml
More file actions
994 lines (994 loc) · 41.3 KB
/
InfrastructureService.openapi.yaml
File metadata and controls
994 lines (994 loc) · 41.3 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
openapi: 3.1.0
info:
title: InfrastructureService API
version: 1.0.0
paths:
/api/infrastructure/v1/list-internet-outages:
get:
tags:
- InfrastructureService
summary: ListInternetOutages
description: ListInternetOutages retrieves detected internet outages from Cloudflare Radar.
operationId: ListInternetOutages
parameters:
- name: start
in: query
description: Start of time range (inclusive), Unix epoch milliseconds.
required: false
schema:
type: string
format: int64
- name: end
in: query
description: End of time range (inclusive), Unix epoch milliseconds.
required: false
schema:
type: string
format: int64
- name: page_size
in: query
description: Maximum items per page.
required: false
schema:
type: integer
format: int32
- name: cursor
in: query
description: Cursor for next page.
required: false
schema:
type: string
- name: country
in: query
description: Optional country filter (ISO 3166-1 alpha-2).
required: false
schema:
type: string
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListInternetOutagesResponse'
"400":
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/infrastructure/v1/list-service-statuses:
get:
tags:
- InfrastructureService
summary: ListServiceStatuses
description: ListServiceStatuses retrieves operational status of monitored external services.
operationId: ListServiceStatuses
parameters:
- name: status
in: query
description: Optional status filter. Returns only services in this state.
required: false
schema:
type: string
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListServiceStatusesResponse'
"400":
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/infrastructure/v1/get-temporal-baseline:
get:
tags:
- InfrastructureService
summary: GetTemporalBaseline
description: GetTemporalBaseline retrieves historical baseline data for a specific signal.
operationId: GetTemporalBaseline
parameters:
- name: type
in: query
description: 'Activity type: "military_flights", "vessels", "protests", "news", "ais_gaps", "satellite_fires".'
required: false
schema:
type: string
- name: region
in: query
description: Geographic region key, defaults to "global".
required: false
schema:
type: string
- name: count
in: query
description: Current observed count to compare against baseline.
required: false
schema:
type: number
format: double
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/GetTemporalBaselineResponse'
"400":
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/infrastructure/v1/get-ip-geo:
get:
tags:
- InfrastructureService
summary: GetIpGeo
description: GetIpGeo retrieves geographic information based on the caller's IP address.
operationId: GetIpGeo
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/GetIpGeoResponse'
"400":
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/infrastructure/v1/reverse-geocode:
get:
tags:
- InfrastructureService
summary: ReverseGeocode
description: ReverseGeocode resolves geographic coordinates to a postal address/country.
operationId: ReverseGeocode
parameters:
- name: lat
in: query
required: false
schema:
type: number
format: double
- name: lon
in: query
required: false
schema:
type: number
format: double
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ReverseGeocodeResponse'
"400":
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/infrastructure/v1/get-bootstrap-data:
get:
tags:
- InfrastructureService
summary: GetBootstrapData
description: GetBootstrapData fetches multiple data points from the system cache in a single call.
operationId: GetBootstrapData
parameters:
- name: tier
in: query
description: Predefined tiers or specific keys.
required: false
schema:
type: string
- name: keys
in: query
required: false
schema:
type: string
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/GetBootstrapDataResponse'
"400":
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/infrastructure/v1/record-baseline-snapshot:
post:
tags:
- InfrastructureService
summary: RecordBaselineSnapshot
description: RecordBaselineSnapshot batch-updates baseline statistics using Welford's online algorithm.
operationId: RecordBaselineSnapshot
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RecordBaselineSnapshotRequest'
required: true
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/RecordBaselineSnapshotResponse'
"400":
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/infrastructure/v1/get-cable-health:
get:
tags:
- InfrastructureService
summary: GetCableHealth
description: GetCableHealth computes health status for submarine cables from NGA maritime warning signals.
operationId: GetCableHealth
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/GetCableHealthResponse'
"400":
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/infrastructure/v1/list-temporal-anomalies:
get:
tags:
- InfrastructureService
summary: ListTemporalAnomalies
description: ListTemporalAnomalies returns server-computed temporal anomalies for news and satellite_fires.
operationId: ListTemporalAnomalies
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListTemporalAnomaliesResponse'
"400":
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/infrastructure/v1/list-internet-ddos-attacks:
get:
tags:
- InfrastructureService
summary: ListInternetDdosAttacks
description: ListInternetDdosAttacks retrieves L3/L4 DDoS attack summaries from Cloudflare Radar.
operationId: ListInternetDdosAttacks
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListInternetDdosAttacksResponse'
"400":
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/infrastructure/v1/list-internet-traffic-anomalies:
get:
tags:
- InfrastructureService
summary: ListInternetTrafficAnomalies
description: ListInternetTrafficAnomalies retrieves traffic anomaly events from Cloudflare Radar.
operationId: ListInternetTrafficAnomalies
parameters:
- name: country
in: query
description: Optional ISO 3166-1 alpha-2 country code filter.
required: false
schema:
type: string
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListInternetTrafficAnomaliesResponse'
"400":
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
type: object
properties:
message:
type: string
description: Error message (e.g., 'user not found', 'database connection failed')
description: Error is returned when a handler encounters an error. It contains a simple error message that the developer can customize.
FieldViolation:
type: object
properties:
field:
type: string
description: The field path that failed validation (e.g., 'user.email' for nested fields). For header validation, this will be the header name (e.g., 'X-API-Key')
description:
type: string
description: Human-readable description of the validation violation (e.g., 'must be a valid email address', 'required field missing')
required:
- field
- description
description: FieldViolation describes a single validation error for a specific field.
ValidationError:
type: object
properties:
violations:
type: array
items:
$ref: '#/components/schemas/FieldViolation'
description: List of validation violations
required:
- violations
description: ValidationError is returned when request validation fails. It contains a list of field violations describing what went wrong.
ListInternetOutagesRequest:
type: object
properties:
start:
type: integer
format: int64
description: 'Start of time range (inclusive), Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
end:
type: integer
format: int64
description: 'End of time range (inclusive), Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
pageSize:
type: integer
format: int32
description: Maximum items per page.
cursor:
type: string
description: Cursor for next page.
country:
type: string
description: Optional country filter (ISO 3166-1 alpha-2).
description: ListInternetOutagesRequest specifies filters for retrieving internet outages.
ListInternetOutagesResponse:
type: object
properties:
outages:
type: array
items:
$ref: '#/components/schemas/InternetOutage'
pagination:
$ref: '#/components/schemas/PaginationResponse'
description: ListInternetOutagesResponse contains internet outages matching the request.
InternetOutage:
type: object
properties:
id:
type: string
minLength: 1
description: Unique outage identifier.
title:
type: string
description: Outage title.
link:
type: string
description: URL to the outage report.
description:
type: string
description: Outage description.
detectedAt:
type: integer
format: int64
description: 'Detection time, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
country:
type: string
description: Affected country (ISO 3166-1 alpha-2).
region:
type: string
description: Affected region within the country.
location:
$ref: '#/components/schemas/GeoCoordinates'
severity:
type: string
enum:
- OUTAGE_SEVERITY_UNSPECIFIED
- OUTAGE_SEVERITY_PARTIAL
- OUTAGE_SEVERITY_MAJOR
- OUTAGE_SEVERITY_TOTAL
description: |-
OutageSeverity represents the severity of an internet outage.
Maps to TS union: 'partial' | 'major' | 'total'.
categories:
type: array
items:
type: string
description: Affected infrastructure categories.
cause:
type: string
description: Root cause, if determined.
outageType:
type: string
description: Outage type classification.
endedAt:
type: integer
format: int64
description: 'End time of the outage, as Unix epoch milliseconds. Zero if ongoing.. Warning: Values > 2^53 may lose precision in JavaScript'
required:
- id
description: InternetOutage represents a detected internet outage event from Cloudflare Radar.
GeoCoordinates:
type: object
properties:
latitude:
type: number
maximum: 90
minimum: -90
format: double
description: Latitude in decimal degrees (-90 to 90).
longitude:
type: number
maximum: 180
minimum: -180
format: double
description: Longitude in decimal degrees (-180 to 180).
description: GeoCoordinates represents a geographic location using WGS84 coordinates.
PaginationResponse:
type: object
properties:
nextCursor:
type: string
description: Cursor for fetching the next page. Empty string indicates no more pages.
totalCount:
type: integer
format: int32
description: Total count of items matching the query, if known. Zero if the total is unknown.
description: PaginationResponse contains pagination metadata returned alongside list results.
ListServiceStatusesRequest:
type: object
properties:
status:
type: string
enum:
- SERVICE_OPERATIONAL_STATUS_UNSPECIFIED
- SERVICE_OPERATIONAL_STATUS_OPERATIONAL
- SERVICE_OPERATIONAL_STATUS_DEGRADED
- SERVICE_OPERATIONAL_STATUS_PARTIAL_OUTAGE
- SERVICE_OPERATIONAL_STATUS_MAJOR_OUTAGE
- SERVICE_OPERATIONAL_STATUS_MAINTENANCE
description: ServiceOperationalStatus represents the current status of a service.
description: ListServiceStatusesRequest specifies filters for retrieving service statuses.
ListServiceStatusesResponse:
type: object
properties:
statuses:
type: array
items:
$ref: '#/components/schemas/ServiceStatus'
description: ListServiceStatusesResponse contains service operational statuses.
ServiceStatus:
type: object
properties:
id:
type: string
description: Service identifier.
name:
type: string
description: Service display name.
status:
type: string
enum:
- SERVICE_OPERATIONAL_STATUS_UNSPECIFIED
- SERVICE_OPERATIONAL_STATUS_OPERATIONAL
- SERVICE_OPERATIONAL_STATUS_DEGRADED
- SERVICE_OPERATIONAL_STATUS_PARTIAL_OUTAGE
- SERVICE_OPERATIONAL_STATUS_MAJOR_OUTAGE
- SERVICE_OPERATIONAL_STATUS_MAINTENANCE
description: ServiceOperationalStatus represents the current status of a service.
description:
type: string
description: Status description.
url:
type: string
description: Service URL or homepage.
checkedAt:
type: integer
format: int64
description: 'Last status check time, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
latencyMs:
type: integer
format: int32
description: Response latency in milliseconds.
description: ServiceStatus represents the operational status of a monitored external service.
GetTemporalBaselineRequest:
type: object
properties:
type:
type: string
minLength: 1
description: 'Activity type: "military_flights", "vessels", "protests", "news", "ais_gaps", "satellite_fires".'
region:
type: string
description: Geographic region key, defaults to "global".
count:
type: number
format: double
description: Current observed count to compare against baseline.
required:
- type
description: GetTemporalBaselineRequest checks current activity count against stored baseline.
GetTemporalBaselineResponse:
type: object
properties:
anomaly:
$ref: '#/components/schemas/BaselineAnomaly'
baseline:
$ref: '#/components/schemas/BaselineStats'
learning:
type: boolean
description: True if insufficient samples have been collected.
sampleCount:
type: integer
format: int32
description: Current number of samples stored.
samplesNeeded:
type: integer
format: int32
description: Minimum samples required before anomaly detection activates.
error:
type: string
description: Error message if request was invalid.
description: GetTemporalBaselineResponse returns anomaly info or learning status.
BaselineAnomaly:
type: object
properties:
zScore:
type: number
format: double
description: Number of standard deviations from the mean.
severity:
type: string
description: 'Severity label: "critical", "high", "medium", "normal".'
multiplier:
type: number
format: double
description: Ratio of current count to baseline mean.
description: BaselineAnomaly describes a detected deviation from historical baseline.
BaselineStats:
type: object
properties:
mean:
type: number
format: double
description: Running mean of observed counts.
stdDev:
type: number
format: double
description: Standard deviation derived from Welford's M2.
sampleCount:
type: integer
format: int32
description: Number of samples incorporated so far.
description: BaselineStats contains the running statistics for a baseline key.
GetIpGeoRequest:
type: object
description: GetIpGeoRequest defined for future parameters (e.g., specific IP).
GetIpGeoResponse:
type: object
properties:
country:
type: string
description: ISO 3166-1 alpha-2 country code.
region:
type: string
description: Region or city (if available).
city:
type: string
description: GetIpGeoResponse contains geographic information derived from the request IP.
ReverseGeocodeRequest:
type: object
properties:
lat:
type: number
format: double
lon:
type: number
format: double
description: ReverseGeocodeRequest parameters for coordinate-to-address lookups.
ReverseGeocodeResponse:
type: object
properties:
country:
type: string
description: Human-readable country name.
code:
type: string
description: ISO country code.
displayName:
type: string
description: Full display name/address.
error:
type: string
description: Optional error message.
description: ReverseGeocodeResponse containing the resolved location details.
GetBootstrapDataRequest:
type: object
properties:
tier:
type: string
description: Predefined tiers or specific keys.
keys:
type: array
items:
type: string
description: GetBootstrapDataRequest parameters for multi-key fetching.
GetBootstrapDataResponse:
type: object
properties:
data:
type: object
additionalProperties:
type: string
description: Map of keys to JSON-encoded data strings.
missing:
type: array
items:
type: string
description: List of keys that were not found in cache.
description: GetBootstrapDataResponse containing pooled data objects.
DataEntry:
type: object
properties:
key:
type: string
value:
type: string
RecordBaselineSnapshotRequest:
type: object
properties:
updates:
type: array
items:
$ref: '#/components/schemas/BaselineUpdate'
description: RecordBaselineSnapshotRequest batch-updates baselines using Welford's online algorithm.
BaselineUpdate:
type: object
properties:
type:
type: string
minLength: 1
description: Activity type key.
region:
type: string
description: Geographic region key, defaults to "global".
count:
type: number
format: double
description: Observed count value.
required:
- type
description: BaselineUpdate is a single metric observation to incorporate into the running baseline.
RecordBaselineSnapshotResponse:
type: object
properties:
updated:
type: integer
format: int32
description: Number of baselines that were written.
error:
type: string
description: Error message if the request was invalid.
description: RecordBaselineSnapshotResponse reports how many baselines were successfully updated.
GetCableHealthRequest:
type: object
description: GetCableHealthRequest requests the current health status of all monitored submarine cables.
GetCableHealthResponse:
type: object
properties:
generatedAt:
type: integer
format: int64
description: 'Generation timestamp, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
cables:
type: object
additionalProperties:
$ref: '#/components/schemas/CableHealthRecord'
description: Health records keyed by cable identifier.
description: GetCableHealthResponse contains health status for submarine cables with active signals.
CablesEntry:
type: object
properties:
key:
type: string
value:
$ref: '#/components/schemas/CableHealthRecord'
CableHealthRecord:
type: object
properties:
status:
type: string
enum:
- CABLE_HEALTH_STATUS_UNSPECIFIED
- CABLE_HEALTH_STATUS_OK
- CABLE_HEALTH_STATUS_DEGRADED
- CABLE_HEALTH_STATUS_FAULT
description: CableHealthStatus represents the computed health status of a submarine cable.
score:
type: number
format: double
description: Composite health score (0.0 = healthy, 1.0 = confirmed fault).
confidence:
type: number
format: double
description: Confidence in the health assessment (0.0–1.0).
lastUpdated:
type: integer
format: int64
description: 'Last signal update time, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
evidence:
type: array
items:
$ref: '#/components/schemas/CableHealthEvidence'
description: CableHealthRecord contains the computed health status and supporting evidence for a cable.
CableHealthEvidence:
type: object
properties:
source:
type: string
description: Evidence source (e.g. "NGA").
summary:
type: string
description: Human-readable summary of the evidence.
ts:
type: integer
format: int64
description: 'Evidence timestamp, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
description: CableHealthEvidence represents a single piece of evidence supporting a health assessment.
ListTemporalAnomaliesRequest:
type: object
ListTemporalAnomaliesResponse:
type: object
properties:
anomalies:
type: array
items:
$ref: '#/components/schemas/TemporalAnomaly'
trackedTypes:
type: array
items:
type: string
computedAt:
type: string
TemporalAnomaly:
type: object
properties:
type:
type: string
region:
type: string
currentCount:
type: integer
format: int32
expectedCount:
type: integer
format: int32
zScore:
type: number
format: double
severity:
type: string
multiplier:
type: number
format: double
message:
type: string
ListInternetDdosAttacksRequest:
type: object
description: ListInternetDdosAttacksRequest specifies filters for retrieving DDoS attack summaries.
ListInternetDdosAttacksResponse:
type: object
properties:
protocol:
type: array
items:
$ref: '#/components/schemas/DdosAttackSummaryEntry'
vector:
type: array
items:
$ref: '#/components/schemas/DdosAttackSummaryEntry'
dateRangeStart:
type: string
description: ISO 8601 start of the data window.
dateRangeEnd:
type: string
description: ISO 8601 end of the data window.
topTargetLocations:
type: array
items:
$ref: '#/components/schemas/DdosLocationHit'
description: ListInternetDdosAttacksResponse contains DDoS attack protocol and vector breakdowns.
DdosAttackSummaryEntry:
type: object
properties:
label:
type: string
description: Protocol or vector name (e.g. "TCP", "UDP", "networkFlood").
percentage:
type: number
format: float
description: Percentage share of total DDoS traffic (0–100).
description: DdosAttackSummaryEntry represents a single protocol or vector and its share of DDoS traffic.
DdosLocationHit:
type: object
properties:
countryCode:
type: string
description: ISO 3166-1 alpha-2 country code.
countryName:
type: string
description: Country display name.
percentage:
type: number
format: float
description: Percentage share of total DDoS traffic targeting this location (0-100).
latitude:
type: number
format: float
description: Latitude of the target location.
longitude:
type: number
format: float
description: Longitude of the target location.
description: DdosLocationHit represents a top DDoS target location with geo coordinates.
ListInternetTrafficAnomaliesRequest:
type: object
properties:
country:
type: string
description: Optional ISO 3166-1 alpha-2 country code filter.
description: ListInternetTrafficAnomaliesRequest specifies filters for traffic anomalies.
ListInternetTrafficAnomaliesResponse:
type: object
properties:
anomalies:
type: array
items:
$ref: '#/components/schemas/TrafficAnomaly'
totalCount:
type: integer
format: int32
description: Total anomaly count before filtering.
description: ListInternetTrafficAnomaliesResponse contains detected traffic anomalies.
TrafficAnomaly:
type: object
properties:
uuid:
type: string
description: Unique identifier for the anomaly.
type:
type: string
description: Anomaly type (e.g. "ANOMALY_DNS", "ANOMALY_BGP").
status:
type: string
description: Current status ("ONGOING" or "HISTORICAL").
startDate:
type: integer
format: int64
description: 'Start of the anomaly, Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
endDate:
type: integer
format: int64
description: 'End of the anomaly, Unix epoch milliseconds. Zero if ongoing.. Warning: Values > 2^53 may lose precision in JavaScript'
asn:
type: string
description: Autonomous System Number affected.
asnName:
type: string
description: ASN display name.
locationCode:
type: string
description: ISO 3166-1 alpha-2 country code.
locationName:
type: string
description: Country display name.
latitude:
type: number
format: float
description: Latitude of the affected location.
longitude:
type: number
format: float
description: Longitude of the affected location.
description: TrafficAnomaly represents an anomalous traffic pattern detected by Cloudflare Radar.