forked from kentik/sla_dashboard_webapp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsynthetics.openapi.yaml
1245 lines (1244 loc) · 31.9 KB
/
synthetics.openapi.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:
title: Synthetics Monitoring API
version: 202101beta1
contact:
name: Kentik API Engineering
url: https://github.com/kentik/api
tags:
- name: SyntheticsDataService
- name: SyntheticsAdminService
paths:
/synthetics/v202101beta1/agents:
get:
summary: List Agents.
description: Returns a list of agents.
operationId: AgentsList
responses:
"200":
description: A successful response.
content:
application/json:
schema:
$ref: "#/components/schemas/v202101beta1ListAgentsResponse"
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
tags:
- SyntheticsAdminService
"/synthetics/v202101beta1/agents/{agent.id}":
patch:
summary: Patch an agent.
description: Partially Updates the attributes of agent specified with id and
update_mask fields.
operationId: AgentPatch
responses:
"200":
description: A successful response.
content:
application/json:
schema:
$ref: "#/components/schemas/v202101beta1PatchAgentResponse"
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
parameters:
- name: agent.id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v202101beta1PatchAgentRequest"
required: true
tags:
- SyntheticsAdminService
get:
summary: Get information about an agent.
description: Returns information about the agent specified with id.
operationId: AgentGet
responses:
"200":
description: A successful response.
content:
application/json:
schema:
$ref: "#/components/schemas/v202101beta1GetAgentResponse"
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
parameters:
- name: agent.id
in: path
required: true
schema:
type: string
tags:
- SyntheticsAdminService
delete:
summary: Delete an agent.
description: Deletes the agent specified with id.
operationId: AgentDelete
responses:
"200":
description: A successful response.
content:
application/json:
schema:
$ref: "#/components/schemas/v202101beta1DeleteAgentResponse"
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
parameters:
- name: agent.id
in: path
required: true
schema:
type: string
tags:
- SyntheticsAdminService
/synthetics/v202101beta1/health/tests:
post:
summary: Get health status for synthetics test.
description: Get synthetics health test for login user. Also returns mesh data on
request.
operationId: GetHealthForTests
responses:
"200":
description: A successful response.
content:
application/json:
schema:
$ref: "#/components/schemas/v202101beta1GetHealthForTestsResponse"
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v202101beta1GetHealthForTestsRequest"
required: true
tags:
- SyntheticsDataService
/synthetics/v202101beta1/tests:
get:
summary: List Synthetics Tests.
description: Returns a list of syntehtics tests.
operationId: TestsList
responses:
"200":
description: A successful response.
content:
application/json:
schema:
$ref: "#/components/schemas/v202101beta1ListTestsResponse"
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
parameters:
- name: preset
in: query
required: false
schema:
type: boolean
tags:
- SyntheticsAdminService
post:
summary: Create Synthetics Test.
description: Create synthetics test from request. Returns created test.
operationId: TestCreate
responses:
"200":
description: A successful response.
content:
application/json:
schema:
$ref: "#/components/schemas/v202101beta1CreateTestResponse"
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v202101beta1CreateTestRequest"
required: true
tags:
- SyntheticsAdminService
"/synthetics/v202101beta1/tests/{id}":
get:
summary: Get information about Synthetics Test.
description: Returns information about synthetics test specified with test ID.
operationId: TestGet
responses:
"200":
description: A successful response.
content:
application/json:
schema:
$ref: "#/components/schemas/v202101beta1GetTestResponse"
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
parameters:
- name: id
in: path
required: true
schema:
type: string
tags:
- SyntheticsAdminService
delete:
summary: Delete an Synthetics Test.
description: Deletes the synthetics test specified with id.
operationId: TestDelete
responses:
"200":
description: A successful response.
content:
application/json:
schema:
$ref: "#/components/schemas/v202101beta1DeleteTestResponse"
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
parameters:
- name: id
in: path
required: true
schema:
type: string
tags:
- SyntheticsAdminService
patch:
summary: Patch a Synthetics Test.
description: Partially Updates the attributes of synthetics test specified with id
and update_mask fields.
operationId: TestPatch
responses:
"200":
description: A successful response.
content:
application/json:
schema:
$ref: "#/components/schemas/v202101beta1PatchTestResponse"
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v202101beta1PatchTestRequest"
required: true
tags:
- SyntheticsAdminService
"/synthetics/v202101beta1/tests/{id}/results/trace":
post:
summary: Get trace route data.
description: Get trace route data for the specific test id.
operationId: GetTraceForTest
responses:
"200":
description: A successful response.
content:
application/json:
schema:
$ref: "#/components/schemas/v202101beta1GetTraceForTestResponse"
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
parameters:
- name: id
description: Test id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v202101beta1GetTraceForTestRequest"
required: true
tags:
- SyntheticsDataService
"/synthetics/v202101beta1/tests/{id}/status":
put:
summary: Update a test status.
description: Update the status of a test.
operationId: TestStatusUpdate
responses:
"200":
description: A successful response.
content:
application/json:
schema:
$ref: "#/components/schemas/v202101beta1SetTestStatusResponse"
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v202101beta1SetTestStatusRequest"
required: true
tags:
- SyntheticsAdminService
security:
- email: []
token: []
externalDocs:
description: More about Kentik APIs
url: https://docs.kentik.com/api
components:
securitySchemes:
email:
type: apiKey
name: X-CH-Auth-Email
in: header
token:
type: apiKey
name: X-CH-Auth-API-Token
in: header
schemas:
protobufAny:
type: object
properties:
typeUrl:
type: string
value:
type: string
format: byte
rpcStatus:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
details:
type: array
items:
$ref: "#/components/schemas/protobufAny"
v202101beta1ASN:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
v202101beta1Agent:
type: object
properties:
id:
type: string
name:
type: string
status:
$ref: "#/components/schemas/v202101beta1AgentStatus"
alias:
type: string
type:
type: string
os:
type: string
ip:
type: string
lat:
type: number
format: double
long:
type: number
format: double
lastAuthed:
type: string
format: date-time
family:
$ref: "#/components/schemas/v202101beta1IPFamily"
asn:
type: integer
format: int64
siteId:
type: string
version:
type: string
challenge:
type: string
city:
type: string
region:
type: string
country:
type: string
testIds:
type: array
items:
type: string
localIp:
type: string
v202101beta1AgentHealth:
type: object
properties:
agent:
$ref: "#/components/schemas/v202101beta1Agent"
health:
type: array
items:
$ref: "#/components/schemas/v202101beta1HealthMoment"
overallHealth:
$ref: "#/components/schemas/v202101beta1Health"
v202101beta1AgentStatus:
type: string
enum:
- AGENT_STATUS_UNSPECIFIED
- AGENT_STATUS_OK
- AGENT_STATUS_WAIT
- AGENT_STATUS_DELETED
default: AGENT_STATUS_UNSPECIFIED
v202101beta1AgentTaskConfig:
type: object
properties:
id:
type: string
format: uint64
targets:
type: array
items:
type: string
v202101beta1AgentTest:
type: object
properties:
target:
type: string
v202101beta1City:
type: object
properties:
id:
type: string
name:
type: string
latitude:
type: number
format: double
longitude:
type: number
format: double
v202101beta1Country:
type: object
properties:
code:
type: string
name:
type: string
v202101beta1CreateTestRequest:
type: object
properties:
test:
$ref: "#/components/schemas/v202101beta1Test"
v202101beta1CreateTestResponse:
type: object
properties:
test:
$ref: "#/components/schemas/v202101beta1Test"
v202101beta1DNS:
type: object
properties:
name:
type: string
v202101beta1DNSTaskDefinition:
type: object
properties:
target:
type: string
period:
type: integer
format: int64
expiry:
type: integer
format: int64
count:
type: integer
format: int64
port:
type: integer
format: int64
type:
type: string
resolver:
type: string
v202101beta1DeleteAgentResponse:
type: object
v202101beta1DeleteTestResponse:
type: object
v202101beta1DnsTest:
type: object
properties:
target:
type: string
v202101beta1FlowTest:
type: object
properties:
target:
type: string
targetRefreshIntervalMillis:
type: integer
format: int64
maxTasks:
type: integer
format: int64
type:
type: string
v202101beta1Geo:
type: object
properties:
country:
$ref: "#/components/schemas/v202101beta1Country"
region:
$ref: "#/components/schemas/v202101beta1Region"
city:
$ref: "#/components/schemas/v202101beta1City"
v202101beta1GetAgentResponse:
type: object
properties:
agent:
$ref: "#/components/schemas/v202101beta1Agent"
v202101beta1GetHealthForTestsRequest:
type: object
properties:
ids:
type: array
items:
type: string
description: List of ids of the tests to get health for.
startTime:
type: string
format: date-time
description: Start of the time interval for this query.
endTime:
type: string
format: date-time
description: End of the time interval for this query.
agentIds:
type: array
items:
type: string
title: Optionally, only look at a subset of agents
taskIds:
type: array
items:
type: string
description: Optionally only look at a subset of tasks -- this lets you limit
targets.
augment:
type: boolean
v202101beta1GetHealthForTestsResponse:
type: object
properties:
health:
type: array
items:
$ref: "#/components/schemas/v202101beta1TestHealth"
v202101beta1GetTestResponse:
type: object
properties:
test:
$ref: "#/components/schemas/v202101beta1Test"
v202101beta1GetTraceForTestRequest:
type: object
properties:
id:
type: string
title: Test id
startTime:
type: string
format: date-time
description: Start of the time interval for this query.
endTime:
type: string
format: date-time
description: End of the time interval for this query.
agentIds:
type: array
items:
type: string
title: Optionally, limit the query to these agent ids
targetIps:
type: array
items:
type: string
title: Optionally, limit the query to these destination IP addresses
v202101beta1GetTraceForTestResponse:
type: object
properties:
ipInfo:
type: array
items:
$ref: "#/components/schemas/v202101beta1IPInfo"
traceRoutes:
type: array
items:
$ref: "#/components/schemas/v202101beta1TracerouteResult"
v202101beta1HTTPTaskDefinition:
type: object
properties:
target:
type: string
period:
type: integer
format: int64
expiry:
type: integer
format: int64
v202101beta1Health:
type: object
properties:
health:
type: string
time:
type: string
format: date-time
v202101beta1HealthMoment:
type: object
properties:
time:
type: string
format: date-time
srcIp:
type: string
dstIp:
type: string
packetLoss:
type: integer
format: int64
avgLatency:
type: integer
format: int64
avgWeightedLatency:
type: integer
format: int64
rollingAvgLatency:
type: integer
format: int64
rollingStddevLatency:
type: integer
format: int64
rollingAvgWeightedLatency:
type: integer
format: int64
latencyHealth:
type: string
packetLossHealth:
type: string
overallHealth:
$ref: "#/components/schemas/v202101beta1Health"
avgJitter:
type: integer
format: int64
title: fields returned from backend grpc service
rollingAvgJitter:
type: integer
format: int64
rollingStdJitter:
type: integer
format: int64
jitterHealth:
type: string
data:
type: string
size:
type: integer
format: int64
status:
type: integer
format: int64
taskType:
type: string
v202101beta1HealthSettings:
type: object
properties:
latencyCritical:
type: number
format: float
latencyWarning:
type: number
format: float
packetLossCritical:
type: number
format: float
packetLossWarning:
type: number
format: float
jitterCritical:
type: number
format: float
jitterWarning:
type: number
format: float
httpLatencyCritical:
type: number
format: float
httpLatencyWarning:
type: number
format: float
httpValidCodes:
type: array
items:
type: integer
format: int64
dnsValidCodes:
type: array
items:
type: integer
format: int64
v202101beta1HostnameTest:
type: object
properties:
target:
type: string
v202101beta1IPFamily:
type: string
enum:
- IP_FAMILY_UNSPECIFIED
- IP_FAMILY_V4
- IP_FAMILY_V6
- IP_FAMILY_DUAL
default: IP_FAMILY_UNSPECIFIED
v202101beta1IPInfo:
type: object
properties:
ip:
type: string
asn:
$ref: "#/components/schemas/v202101beta1ASN"
geo:
$ref: "#/components/schemas/v202101beta1Geo"
dns:
$ref: "#/components/schemas/v202101beta1DNS"
v202101beta1IpTest:
type: object
properties:
targets:
type: array
items:
type: string
v202101beta1KnockTaskDefinition:
type: object
properties:
target:
type: string
period:
type: integer
format: int64
expiry:
type: integer
format: int64
count:
type: integer
format: int64
port:
type: integer
format: int64
v202101beta1ListAgentsResponse:
type: object
properties:
agents:
type: array
items:
$ref: "#/components/schemas/v202101beta1Agent"
invalidAgentsCount:
type: integer
format: int64
v202101beta1ListTestsResponse:
type: object
properties:
tests:
type: array
items:
$ref: "#/components/schemas/v202101beta1Test"
invalidTestsCount:
type: integer
format: int64
v202101beta1MeshColumn:
type: object
properties:
id:
type: string
name:
type: string
alias:
type: string
target:
type: string
metrics:
$ref: "#/components/schemas/v202101beta1MeshMetrics"
health:
type: array
items:
$ref: "#/components/schemas/v202101beta1MeshMetrics"
v202101beta1MeshMetric:
type: object
properties:
name:
type: string
health:
type: string
value:
type: string
format: int64
v202101beta1MeshMetrics:
type: object
properties:
time:
type: string
format: date-time
latency:
$ref: "#/components/schemas/v202101beta1MeshMetric"
packetLoss:
$ref: "#/components/schemas/v202101beta1MeshMetric"
jitter:
$ref: "#/components/schemas/v202101beta1MeshMetric"
v202101beta1MeshResponse:
type: object
properties:
id:
type: string
name:
type: string
localIp:
type: string
ip:
type: string
alias:
type: string
columns:
type: array
items:
$ref: "#/components/schemas/v202101beta1MeshColumn"
v202101beta1PatchAgentRequest:
type: object
properties:
agent:
$ref: "#/components/schemas/v202101beta1Agent"
mask:
type: string
v202101beta1PatchAgentResponse:
type: object
properties:
agent:
$ref: "#/components/schemas/v202101beta1Agent"
v202101beta1PatchTestRequest:
type: object
properties:
test:
$ref: "#/components/schemas/v202101beta1Test"
mask:
type: string
v202101beta1PatchTestResponse:
type: object
properties:
test:
$ref: "#/components/schemas/v202101beta1Test"
v202101beta1PingTaskDefinition:
type: object
properties:
target:
type: string
period:
type: integer
format: int64
expiry:
type: integer
format: int64
count:
type: integer
format: int64
v202101beta1Region:
type: object
properties:
id:
type: string
format: int64
name:
type: string
v202101beta1SetTestStatusRequest:
type: object
properties:
id:
type: string
status:
$ref: "#/components/schemas/v202101beta1TestStatus"
v202101beta1SetTestStatusResponse:
type: object
v202101beta1ShakeTaskDefinition:
type: object
properties:
target:
type: string
port:
type: integer
format: int64
period:
type: integer
format: int64
expiry:
type: integer
format: int64
v202101beta1SiteTest:
type: object
properties:
target:
type: string
v202101beta1TagTest:
type: object
properties:
target:
type: string
v202101beta1Task:
type: object
properties:
id:
type: string
testId:
type: string
deviceId:
type: string
state:
$ref: "#/components/schemas/v202101beta1TaskState"
status:
type: string
family:
$ref: "#/components/schemas/v202101beta1IPFamily"
ping:
$ref: "#/components/schemas/v202101beta1PingTaskDefinition"
traceroute:
$ref: "#/components/schemas/v202101beta1TraceTaskDefinition"
http:
$ref: "#/components/schemas/v202101beta1HTTPTaskDefinition"
knock:
$ref: "#/components/schemas/v202101beta1KnockTaskDefinition"
dns:
$ref: "#/components/schemas/v202101beta1DNSTaskDefinition"
shake:
$ref: "#/components/schemas/v202101beta1ShakeTaskDefinition"
v202101beta1TaskHealth:
type: object
properties:
task:
$ref: "#/components/schemas/v202101beta1Task"
agents:
type: array
items:
$ref: "#/components/schemas/v202101beta1AgentHealth"
overallHealth:
$ref: "#/components/schemas/v202101beta1Health"
targetAgent:
$ref: "#/components/schemas/v202101beta1Agent"
v202101beta1TaskState:
type: string
enum:
- TASK_STATE_UNSPECIFIED
- TASK_STATE_CREATED
- TASK_STATE_UPDATED
- TASK_STATE_DELETED
default: TASK_STATE_UNSPECIFIED
v202101beta1Test: