-
Notifications
You must be signed in to change notification settings - Fork 70
/
Copy pathBotMapping.json
918 lines (918 loc) · 43.2 KB
/
BotMapping.json
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
{
"swagger": "2.0",
"info": {
"version": "31.1.1",
"title": "Avi BotMapping Object API",
"contact": {
"name": "Avi Networks Inc.",
"url": "https://avinetworks.com/contact-us",
"email": "[email protected]"
},
"description": "CLI\n```\n- configure botmapping <key>\n- show botmapping <key>\n```\n"
},
"securityDefinitions": {
"basicAuth": {
"type": "basic",
"description": "basic authentication"
}
},
"basePath": "/api",
"paths": {
"/botmapping": {
"get": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "name",
"in": "query",
"description": "object name",
"required": false,
"type": "string"
},
{
"name": "refers_to",
"in": "query",
"description": "Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid",
"type": "string"
},
{
"name": "referred_by",
"in": "query",
"description": "Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid",
"type": "string"
},
{
"name": "fields",
"in": "query",
"description": "List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.",
"type": "string"
},
{
"name": "include_name",
"in": "query",
"description": "All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.",
"required": false,
"type": "boolean"
},
{
"name": "skip_default",
"in": "query",
"description": "Default values are not set.",
"required": false,
"type": "boolean"
},
{
"name": "join_subresources",
"in": "query",
"description": "It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.",
"type": "string"
},
{
"name": "X-Avi-Tenant",
"in": "header",
"type": "string",
"required": false,
"description": "Avi Tenant Header"
},
{
"name": "X-Avi-Tenant-UUID",
"in": "header",
"type": "string",
"required": false,
"description": "Avi Tenant Header UUID"
},
{
"name": "X-Avi-Version",
"in": "header",
"type": "string",
"required": true,
"description": "The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version."
},
{
"name": "X-CSRFToken",
"in": "header",
"type": "string",
"required": false,
"description": "Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests."
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BotMappingApiResponse"
}
},
"401": {
"description": "log in failed"
}
}
},
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-Avi-Tenant",
"in": "header",
"type": "string",
"required": false,
"description": "Avi Tenant Header"
},
{
"name": "X-Avi-Tenant-UUID",
"in": "header",
"type": "string",
"required": false,
"description": "Avi Tenant Header UUID"
},
{
"name": "X-Avi-Version",
"in": "header",
"type": "string",
"required": true,
"description": "The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version."
},
{
"name": "X-CSRFToken",
"in": "header",
"type": "string",
"required": false,
"description": "Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests."
},
{
"in": "body",
"name": "body",
"description": "BotMapping object creation",
"required": true,
"schema": {
"$ref": "#/definitions/BotMapping"
}
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BotMapping"
}
},
"401": {
"description": "log in failed"
}
}
}
},
"/botmapping/{uuid}": {
"get": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "name",
"in": "query",
"description": "object name",
"required": false,
"type": "string"
},
{
"name": "X-Avi-Tenant",
"in": "header",
"type": "string",
"required": false,
"description": "Avi Tenant Header"
},
{
"name": "X-Avi-Tenant-UUID",
"in": "header",
"type": "string",
"required": false,
"description": "Avi Tenant Header UUID"
},
{
"name": "X-Avi-Version",
"in": "header",
"type": "string",
"required": true,
"description": "The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version."
},
{
"name": "X-CSRFToken",
"in": "header",
"type": "string",
"required": false,
"description": "Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests."
},
{
"name": "uuid",
"in": "path",
"description": "UUID of the object to fetch",
"required": true,
"type": "string"
},
{
"name": "fields",
"in": "query",
"description": "List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.",
"type": "string"
},
{
"name": "include_name",
"in": "query",
"description": "All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.",
"required": false,
"type": "boolean"
},
{
"name": "skip_default",
"in": "query",
"description": "Default values are not set.",
"required": false,
"type": "boolean"
},
{
"name": "join_subresources",
"in": "query",
"description": "It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.",
"type": "string"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BotMapping"
}
},
"401": {
"description": "log in failed"
}
}
},
"put": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "name",
"description": "object name",
"required": false,
"type": "string"
},
{
"in": "header",
"name": "X-Avi-Tenant",
"type": "string",
"required": false,
"description": "Avi Tenant Header"
},
{
"name": "X-Avi-Tenant-UUID",
"in": "header",
"type": "string",
"required": false,
"description": "Avi Tenant Header UUID"
},
{
"name": "X-Avi-Version",
"in": "header",
"type": "string",
"required": true,
"description": "The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version."
},
{
"name": "X-CSRFToken",
"in": "header",
"type": "string",
"required": false,
"description": "Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests."
},
{
"in": "body",
"name": "body",
"description": "BotMapping object creation",
"required": true,
"schema": {
"$ref": "#/definitions/BotMapping"
}
},
{
"in": "path",
"name": "uuid",
"description": "UUID of the object to fetch",
"required": true,
"type": "string"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BotMapping"
}
},
"401": {
"description": "log in failed"
}
}
},
"patch": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "name",
"description": "object name",
"required": false,
"type": "string"
},
{
"in": "header",
"name": "X-Avi-Tenant",
"type": "string",
"required": false,
"description": "Avi Tenant Header"
},
{
"name": "X-Avi-Tenant-UUID",
"in": "header",
"type": "string",
"required": false,
"description": "Avi Tenant Header UUID"
},
{
"name": "X-Avi-Version",
"in": "header",
"type": "string",
"required": true,
"description": "The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version."
},
{
"name": "X-CSRFToken",
"in": "header",
"type": "string",
"required": false,
"description": "Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests."
},
{
"in": "body",
"name": "body",
"description": "BotMapping object creation",
"required": true,
"schema": {
"$ref": "#/definitions/BotMapping"
}
},
{
"in": "path",
"name": "uuid",
"description": "UUID of the object to fetch",
"required": true,
"type": "string"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BotMapping"
}
},
"401": {
"description": "log in failed"
}
}
},
"delete": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "name",
"description": "object name",
"required": false,
"type": "string"
},
{
"in": "header",
"name": "X-Avi-Tenant",
"type": "string",
"required": false,
"description": "Avi Tenant Header"
},
{
"name": "X-Avi-Tenant-UUID",
"in": "header",
"type": "string",
"required": false,
"description": "Avi Tenant Header UUID"
},
{
"name": "X-Avi-Version",
"in": "header",
"type": "string",
"required": true,
"description": "The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version."
},
{
"name": "X-CSRFToken",
"in": "header",
"type": "string",
"required": false,
"description": "Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests."
},
{
"in": "path",
"name": "uuid",
"description": "UUID of the object to fetch",
"required": true,
"type": "string"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "object deleted",
"schema": {
"type": "string"
}
},
"404": {
"description": "not found"
}
}
}
}
},
"definitions": {
"BotClassification": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "One of the system-defined Bot classification types. Enum options - HUMAN, GOOD_BOT, BAD_BOT, DANGEROUS_BOT, USER_DEFINED_BOT, UNKNOWN_CLIENT. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "string"
},
"user_defined_type": {
"description": "If 'type' has BotClassificationTypes value 'USER_DEFINED', this is the user-defined value. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "string"
}
}
},
"BotClassMatcher": {
"type": "object",
"properties": {
"client_classes": {
"description": "The list of client classes. Enum options - UNDETERMINED_CLIENT, HUMAN_CLIENT, BOT_CLIENT. Field introduced in 21.1.1. Minimum of 1 items required. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "array",
"items": {
"type": "string"
}
},
"op": {
"description": "The match operation. Enum options - IS_IN, IS_NOT_IN. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "string",
"default": "IS_IN"
}
}
},
"BotMapping": {
"type": "object",
"required": [
"name"
],
"properties": {
"_last_modified": {
"description": "UNIX time since epoch in microseconds. Units(MICROSECONDS).",
"readOnly": true,
"type": "string"
},
"mapping_rules": {
"description": "Rules for bot classification. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "array",
"items": {
"$ref": "#/definitions/BotMappingRule"
}
},
"name": {
"description": "The name of this mapping. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "string"
},
"tenant_ref": {
"description": "The unique identifier of the tenant to which this mapping belongs. It is a reference to an object of type Tenant. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "string"
},
"url": {
"description": "url",
"readOnly": true,
"type": "string"
},
"uuid": {
"description": "A unique identifier for this mapping. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "string"
}
}
},
"BotMappingApiResponse": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"results": {
"type": "array",
"items": {
"$ref": "#/definitions/BotMapping"
}
},
"next": {
"type": "string"
}
}
},
"BotMappingRule": {
"type": "object",
"required": [
"classification",
"index",
"match",
"name"
],
"properties": {
"classification": {
"description": "The assigned classification for this client. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"$ref": "#/definitions/BotClassification"
},
"index": {
"description": "Rules are processed in order of this index field. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"format": "uint32"
},
"match": {
"description": "How to match the request all the specified properties must be fulfilled. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"$ref": "#/definitions/BotMappingRuleMatchTarget"
},
"name": {
"description": "A name describing the rule in a short form. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "string"
}
}
},
"BotMappingRuleMatchTarget": {
"type": "object",
"properties": {
"class_matcher": {
"description": "How to match the BotClientClass. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"$ref": "#/definitions/BotClassMatcher"
},
"client_ip": {
"description": "Configure client ip addresses. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"$ref": "#/definitions/IpAddrMatch"
},
"component_matcher": {
"description": "The component for which this mapping is used. Enum options - BOT_DECIDER_CONSOLIDATION, BOT_DECIDER_USER_AGENT, BOT_DECIDER_IP_REPUTATION, BOT_DECIDER_IP_NETWORK_LOCATION, BOT_DECIDER_CLIENT_BEHAVIOR. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "string"
},
"hdrs": {
"description": "Configure HTTP header(s). All configured headers must match. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "array",
"items": {
"$ref": "#/definitions/HdrMatch"
}
},
"host_hdr": {
"description": "Configure the host header. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"$ref": "#/definitions/HostHdrMatch"
},
"identifier_matcher": {
"description": "The list of bot identifier names and how they're matched. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"$ref": "#/definitions/StringMatch"
},
"method": {
"description": "Configure HTTP methods. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"$ref": "#/definitions/MethodMatch"
},
"path": {
"description": "Configure request paths. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"$ref": "#/definitions/PathMatch"
},
"type_matcher": {
"description": "How to match the BotClientType. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"$ref": "#/definitions/BotTypeMatcher"
}
}
},
"BotTypeMatcher": {
"type": "object",
"properties": {
"client_types": {
"description": "The list of client types. Enum options - UNDETERMINED_CLIENT_TYPE, WEB_BROWSER, IN_APP_BROWSER, SEARCH_ENGINE, IMPERSONATOR, SPAM_SOURCE, WEB_ATTACKS, BOTNET, SCANNER, DENIAL_OF_SERVICE, CLOUD_SOURCE, SECURITY_SCANNER, SITE_MONITOR, GENERIC_APPLICATION, SUSPICIOUS_APPLICATION. Field introduced in 21.1.1. Minimum of 1 items required. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "array",
"items": {
"type": "string"
}
},
"op": {
"description": "The match operation. Enum options - IS_IN, IS_NOT_IN. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "string",
"default": "IS_IN"
}
}
},
"HdrMatch": {
"type": "object",
"required": [
"hdr",
"match_criteria"
],
"properties": {
"hdr": {
"description": "Name of the HTTP header whose value is to be matched. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "string"
},
"match_case": {
"description": "Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "string",
"default": "INSENSITIVE"
},
"match_criteria": {
"description": "Criterion to use for matching headers in the HTTP request. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "string"
},
"value": {
"description": "String values to match in the HTTP header. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"HostHdrMatch": {
"type": "object",
"required": [
"match_criteria"
],
"properties": {
"match_case": {
"description": "Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "string",
"default": "INSENSITIVE"
},
"match_criteria": {
"description": "Criterion to use for the host header value match. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "string"
},
"value": {
"description": "String value(s) in the host header. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"IpAddr": {
"type": "object",
"required": [
"addr",
"type"
],
"properties": {
"addr": {
"description": "IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "string"
},
"type": {
"description": " Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "string"
}
}
},
"IpAddrMatch": {
"type": "object",
"required": [
"match_criteria"
],
"properties": {
"addrs": {
"description": "IP address(es). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "array",
"items": {
"$ref": "#/definitions/IpAddr"
}
},
"group_refs": {
"description": "UUID of IP address group(s). It is a reference to an object of type IpAddrGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "array",
"items": {
"type": "string"
}
},
"match_criteria": {
"description": "Criterion to use for IP address matching the HTTP request. Enum options - IS_IN, IS_NOT_IN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "string"
},
"prefixes": {
"description": "IP address prefix(es). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "array",
"items": {
"$ref": "#/definitions/IpAddrPrefix"
}
},
"ranges": {
"description": "IP address range(s). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "array",
"items": {
"$ref": "#/definitions/IpAddrRange"
}
}
}
},
"IpAddrPrefix": {
"type": "object",
"required": [
"ip_addr",
"mask"
],
"properties": {
"ip_addr": {
"description": " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"$ref": "#/definitions/IpAddr"
},
"mask": {
"description": " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"format": "int32"
}
}
},
"IpAddrRange": {
"type": "object",
"required": [
"begin",
"end"
],
"properties": {
"begin": {
"description": "Starting IP address of the range. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"$ref": "#/definitions/IpAddr"
},
"end": {
"description": "Ending IP address of the range. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"$ref": "#/definitions/IpAddr"
}
}
},
"MethodMatch": {
"type": "object",
"required": [
"match_criteria"
],
"properties": {
"match_criteria": {
"description": "Criterion to use for HTTP method matching the method in the HTTP request. Enum options - IS_IN, IS_NOT_IN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "string"
},
"methods": {
"description": "Configure HTTP method(s). Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Minimum of 1 items required. Maximum of 16 items allowed. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- HTTP_METHOD_GET,HTTP_METHOD_PUT,HTTP_METHOD_POST,HTTP_METHOD_HEAD,HTTP_METHOD_OPTIONS), Basic edition(Allowed values- HTTP_METHOD_GET,HTTP_METHOD_PUT,HTTP_METHOD_POST,HTTP_METHOD_HEAD,HTTP_METHOD_OPTIONS), Enterprise with Cloud Services edition.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"PathMatch": {
"type": "object",
"required": [
"match_criteria"
],
"properties": {
"match_case": {
"description": "Case sensitivity to use for the matching. Enum options - SENSITIVE, INSENSITIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "string",
"default": "INSENSITIVE"
},
"match_criteria": {
"description": "Criterion to use for matching the path in the HTTP request URI. Enum options - BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL), Basic edition(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL), Enterprise with Cloud Services edition.",
"type": "string",
"default": "CONTAINS"
},
"match_decoded_string": {
"description": "Match against the decoded URI path. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "boolean",
"default": true
},
"match_str": {
"description": "String values. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "array",
"items": {
"type": "string"
}
},
"string_group_refs": {
"description": "UUID of the string group(s). It is a reference to an object of type StringGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"StringMatch": {
"type": "object",
"required": [
"match_criteria"
],
"properties": {
"match_criteria": {
"description": "Criterion to use for string matching the HTTP request. Enum options - BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL), Basic edition(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL), Enterprise with Cloud Services edition.",
"type": "string"
},
"match_str": {
"description": "String value(s). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "array",
"items": {
"type": "string"
}
},
"string_group_refs": {
"description": "UUID of the string group(s). It is a reference to an object of type StringGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"_comment": [
"Copyright 2021 VMware, Inc.",
"SPDX-License-Identifier: Apache License 2.0"
]
}