| 1 | {
|
| 2 | "version": "1.0",
|
| 3 | "examples": {
|
| 4 | "CreateIPSet": [
|
| 5 | {
|
| 6 | "input": {
|
| 7 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 8 | "Name": "MyIPSetFriendlyName"
|
| 9 | },
|
| 10 | "output": {
|
| 11 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 12 | "IPSet": {
|
| 13 | "IPSetDescriptors": [
|
| 14 | {
|
| 15 | "Type": "IPV4",
|
| 16 | "Value": "192.0.2.44/32"
|
| 17 | }
|
| 18 | ],
|
| 19 | "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
|
| 20 | "Name": "MyIPSetFriendlyName"
|
| 21 | }
|
| 22 | },
|
| 23 | "comments": {
|
| 24 | "input": {
|
| 25 | },
|
| 26 | "output": {
|
| 27 | }
|
| 28 | },
|
| 29 | "description": "The following example creates an IP match set named MyIPSetFriendlyName.",
|
| 30 | "id": "createipset-1472501003122",
|
| 31 | "title": "To create an IP set"
|
| 32 | }
|
| 33 | ],
|
| 34 | "CreateRule": [
|
| 35 | {
|
| 36 | "input": {
|
| 37 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 38 | "MetricName": "WAFByteHeaderRule",
|
| 39 | "Name": "WAFByteHeaderRule"
|
| 40 | },
|
| 41 | "output": {
|
| 42 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 43 | "Rule": {
|
| 44 | "MetricName": "WAFByteHeaderRule",
|
| 45 | "Name": "WAFByteHeaderRule",
|
| 46 | "Predicates": [
|
| 47 | {
|
| 48 | "DataId": "MyByteMatchSetID",
|
| 49 | "Negated": false,
|
| 50 | "Type": "ByteMatch"
|
| 51 | }
|
| 52 | ],
|
| 53 | "RuleId": "WAFRule-1-Example"
|
| 54 | }
|
| 55 | },
|
| 56 | "comments": {
|
| 57 | "input": {
|
| 58 | },
|
| 59 | "output": {
|
| 60 | }
|
| 61 | },
|
| 62 | "description": "The following example creates a rule named WAFByteHeaderRule.",
|
| 63 | "id": "createrule-1474072675555",
|
| 64 | "title": "To create a rule"
|
| 65 | }
|
| 66 | ],
|
| 67 | "CreateSizeConstraintSet": [
|
| 68 | {
|
| 69 | "input": {
|
| 70 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 71 | "Name": "MySampleSizeConstraintSet"
|
| 72 | },
|
| 73 | "output": {
|
| 74 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 75 | "SizeConstraintSet": {
|
| 76 | "Name": "MySampleSizeConstraintSet",
|
| 77 | "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
|
| 78 | "SizeConstraints": [
|
| 79 | {
|
| 80 | "ComparisonOperator": "GT",
|
| 81 | "FieldToMatch": {
|
| 82 | "Type": "QUERY_STRING"
|
| 83 | },
|
| 84 | "Size": 0,
|
| 85 | "TextTransformation": "NONE"
|
| 86 | }
|
| 87 | ]
|
| 88 | }
|
| 89 | },
|
| 90 | "comments": {
|
| 91 | "input": {
|
| 92 | },
|
| 93 | "output": {
|
| 94 | }
|
| 95 | },
|
| 96 | "description": "The following example creates size constraint set named MySampleSizeConstraintSet.",
|
| 97 | "id": "createsizeconstraint-1474299140754",
|
| 98 | "title": "To create a size constraint"
|
| 99 | }
|
| 100 | ],
|
| 101 | "CreateSqlInjectionMatchSet": [
|
| 102 | {
|
| 103 | "input": {
|
| 104 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 105 | "Name": "MySQLInjectionMatchSet"
|
| 106 | },
|
| 107 | "output": {
|
| 108 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 109 | "SqlInjectionMatchSet": {
|
| 110 | "Name": "MySQLInjectionMatchSet",
|
| 111 | "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
|
| 112 | "SqlInjectionMatchTuples": [
|
| 113 | {
|
| 114 | "FieldToMatch": {
|
| 115 | "Type": "QUERY_STRING"
|
| 116 | },
|
| 117 | "TextTransformation": "URL_DECODE"
|
| 118 | }
|
| 119 | ]
|
| 120 | }
|
| 121 | },
|
| 122 | "comments": {
|
| 123 | "input": {
|
| 124 | },
|
| 125 | "output": {
|
| 126 | }
|
| 127 | },
|
| 128 | "description": "The following example creates a SQL injection match set named MySQLInjectionMatchSet.",
|
| 129 | "id": "createsqlinjectionmatchset-1474492796105",
|
| 130 | "title": "To create a SQL injection match set"
|
| 131 | }
|
| 132 | ],
|
| 133 | "CreateWebACL": [
|
| 134 | {
|
| 135 | "input": {
|
| 136 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 137 | "DefaultAction": {
|
| 138 | "Type": "ALLOW"
|
| 139 | },
|
| 140 | "MetricName": "CreateExample",
|
| 141 | "Name": "CreateExample"
|
| 142 | },
|
| 143 | "output": {
|
| 144 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 145 | "WebACL": {
|
| 146 | "DefaultAction": {
|
| 147 | "Type": "ALLOW"
|
| 148 | },
|
| 149 | "MetricName": "CreateExample",
|
| 150 | "Name": "CreateExample",
|
| 151 | "Rules": [
|
| 152 | {
|
| 153 | "Action": {
|
| 154 | "Type": "ALLOW"
|
| 155 | },
|
| 156 | "Priority": 1,
|
| 157 | "RuleId": "WAFRule-1-Example"
|
| 158 | }
|
| 159 | ],
|
| 160 | "WebACLId": "example-46da-4444-5555-example"
|
| 161 | }
|
| 162 | },
|
| 163 | "comments": {
|
| 164 | "input": {
|
| 165 | },
|
| 166 | "output": {
|
| 167 | }
|
| 168 | },
|
| 169 | "description": "The following example creates a web ACL named CreateExample.",
|
| 170 | "id": "createwebacl-1472061481310",
|
| 171 | "title": "To create a web ACL"
|
| 172 | }
|
| 173 | ],
|
| 174 | "CreateXssMatchSet": [
|
| 175 | {
|
| 176 | "input": {
|
| 177 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 178 | "Name": "MySampleXssMatchSet"
|
| 179 | },
|
| 180 | "output": {
|
| 181 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 182 | "XssMatchSet": {
|
| 183 | "Name": "MySampleXssMatchSet",
|
| 184 | "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
|
| 185 | "XssMatchTuples": [
|
| 186 | {
|
| 187 | "FieldToMatch": {
|
| 188 | "Type": "QUERY_STRING"
|
| 189 | },
|
| 190 | "TextTransformation": "URL_DECODE"
|
| 191 | }
|
| 192 | ]
|
| 193 | }
|
| 194 | },
|
| 195 | "comments": {
|
| 196 | "input": {
|
| 197 | },
|
| 198 | "output": {
|
| 199 | }
|
| 200 | },
|
| 201 | "description": "The following example creates an XSS match set named MySampleXssMatchSet.",
|
| 202 | "id": "createxssmatchset-1474560868500",
|
| 203 | "title": "To create an XSS match set"
|
| 204 | }
|
| 205 | ],
|
| 206 | "DeleteByteMatchSet": [
|
| 207 | {
|
| 208 | "input": {
|
| 209 | "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5",
|
| 210 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
|
| 211 | },
|
| 212 | "output": {
|
| 213 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
|
| 214 | },
|
| 215 | "comments": {
|
| 216 | "input": {
|
| 217 | },
|
| 218 | "output": {
|
| 219 | }
|
| 220 | },
|
| 221 | "description": "The following example deletes a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.",
|
| 222 | "id": "deletebytematchset-1473367566229",
|
| 223 | "title": "To delete a byte match set"
|
| 224 | }
|
| 225 | ],
|
| 226 | "DeleteIPSet": [
|
| 227 | {
|
| 228 | "input": {
|
| 229 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 230 | "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
|
| 231 | },
|
| 232 | "output": {
|
| 233 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
|
| 234 | },
|
| 235 | "comments": {
|
| 236 | "input": {
|
| 237 | },
|
| 238 | "output": {
|
| 239 | }
|
| 240 | },
|
| 241 | "description": "The following example deletes an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.",
|
| 242 | "id": "deleteipset-1472767434306",
|
| 243 | "title": "To delete an IP set"
|
| 244 | }
|
| 245 | ],
|
| 246 | "DeleteRule": [
|
| 247 | {
|
| 248 | "input": {
|
| 249 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 250 | "RuleId": "WAFRule-1-Example"
|
| 251 | },
|
| 252 | "output": {
|
| 253 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
|
| 254 | },
|
| 255 | "comments": {
|
| 256 | "input": {
|
| 257 | },
|
| 258 | "output": {
|
| 259 | }
|
| 260 | },
|
| 261 | "description": "The following example deletes a rule with the ID WAFRule-1-Example.",
|
| 262 | "id": "deleterule-1474073108749",
|
| 263 | "title": "To delete a rule"
|
| 264 | }
|
| 265 | ],
|
| 266 | "DeleteSizeConstraintSet": [
|
| 267 | {
|
| 268 | "input": {
|
| 269 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 270 | "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
|
| 271 | },
|
| 272 | "output": {
|
| 273 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
|
| 274 | },
|
| 275 | "comments": {
|
| 276 | "input": {
|
| 277 | },
|
| 278 | "output": {
|
| 279 | }
|
| 280 | },
|
| 281 | "description": "The following example deletes a size constraint set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.",
|
| 282 | "id": "deletesizeconstraintset-1474299857905",
|
| 283 | "title": "To delete a size constraint set"
|
| 284 | }
|
| 285 | ],
|
| 286 | "DeleteSqlInjectionMatchSet": [
|
| 287 | {
|
| 288 | "input": {
|
| 289 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 290 | "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
|
| 291 | },
|
| 292 | "output": {
|
| 293 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
|
| 294 | },
|
| 295 | "comments": {
|
| 296 | "input": {
|
| 297 | },
|
| 298 | "output": {
|
| 299 | }
|
| 300 | },
|
| 301 | "description": "The following example deletes a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.",
|
| 302 | "id": "deletesqlinjectionmatchset-1474493373197",
|
| 303 | "title": "To delete a SQL injection match set"
|
| 304 | }
|
| 305 | ],
|
| 306 | "DeleteWebACL": [
|
| 307 | {
|
| 308 | "input": {
|
| 309 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 310 | "WebACLId": "example-46da-4444-5555-example"
|
| 311 | },
|
| 312 | "output": {
|
| 313 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
|
| 314 | },
|
| 315 | "comments": {
|
| 316 | "input": {
|
| 317 | },
|
| 318 | "output": {
|
| 319 | }
|
| 320 | },
|
| 321 | "description": "The following example deletes a web ACL with the ID example-46da-4444-5555-example.",
|
| 322 | "id": "deletewebacl-1472767755931",
|
| 323 | "title": "To delete a web ACL"
|
| 324 | }
|
| 325 | ],
|
| 326 | "DeleteXssMatchSet": [
|
| 327 | {
|
| 328 | "input": {
|
| 329 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 330 | "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
|
| 331 | },
|
| 332 | "output": {
|
| 333 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
|
| 334 | },
|
| 335 | "comments": {
|
| 336 | "input": {
|
| 337 | },
|
| 338 | "output": {
|
| 339 | }
|
| 340 | },
|
| 341 | "description": "The following example deletes an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.",
|
| 342 | "id": "deletexssmatchset-1474561302618",
|
| 343 | "title": "To delete an XSS match set"
|
| 344 | }
|
| 345 | ],
|
| 346 | "GetByteMatchSet": [
|
| 347 | {
|
| 348 | "input": {
|
| 349 | "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5"
|
| 350 | },
|
| 351 | "output": {
|
| 352 | "ByteMatchSet": {
|
| 353 | "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5",
|
| 354 | "ByteMatchTuples": [
|
| 355 | {
|
| 356 | "FieldToMatch": {
|
| 357 | "Data": "referer",
|
| 358 | "Type": "HEADER"
|
| 359 | },
|
| 360 | "PositionalConstraint": "CONTAINS",
|
| 361 | "TargetString": "badrefer1",
|
| 362 | "TextTransformation": "NONE"
|
| 363 | }
|
| 364 | ],
|
| 365 | "Name": "ByteMatchNameExample"
|
| 366 | }
|
| 367 | },
|
| 368 | "comments": {
|
| 369 | "input": {
|
| 370 | },
|
| 371 | "output": {
|
| 372 | }
|
| 373 | },
|
| 374 | "description": "The following example returns the details of a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.",
|
| 375 | "id": "getbytematchset-1473273311532",
|
| 376 | "title": "To get a byte match set"
|
| 377 | }
|
| 378 | ],
|
| 379 | "GetChangeToken": [
|
| 380 | {
|
| 381 | "input": {
|
| 382 | },
|
| 383 | "output": {
|
| 384 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
|
| 385 | },
|
| 386 | "comments": {
|
| 387 | "input": {
|
| 388 | },
|
| 389 | "output": {
|
| 390 | }
|
| 391 | },
|
| 392 | "description": "The following example returns a change token to use for a create, update or delete operation.",
|
| 393 | "id": "get-change-token-example-1471635120794",
|
| 394 | "title": "To get a change token"
|
| 395 | }
|
| 396 | ],
|
| 397 | "GetChangeTokenStatus": [
|
| 398 | {
|
| 399 | "input": {
|
| 400 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
|
| 401 | },
|
| 402 | "output": {
|
| 403 | "ChangeTokenStatus": "PENDING"
|
| 404 | },
|
| 405 | "comments": {
|
| 406 | "input": {
|
| 407 | },
|
| 408 | "output": {
|
| 409 | }
|
| 410 | },
|
| 411 | "description": "The following example returns the status of a change token with the ID abcd12f2-46da-4fdb-b8d5-fbd4c466928f.",
|
| 412 | "id": "getchangetokenstatus-1474658417107",
|
| 413 | "title": "To get the change token status"
|
| 414 | }
|
| 415 | ],
|
| 416 | "GetIPSet": [
|
| 417 | {
|
| 418 | "input": {
|
| 419 | "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
|
| 420 | },
|
| 421 | "output": {
|
| 422 | "IPSet": {
|
| 423 | "IPSetDescriptors": [
|
| 424 | {
|
| 425 | "Type": "IPV4",
|
| 426 | "Value": "192.0.2.44/32"
|
| 427 | }
|
| 428 | ],
|
| 429 | "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
|
| 430 | "Name": "MyIPSetFriendlyName"
|
| 431 | }
|
| 432 | },
|
| 433 | "comments": {
|
| 434 | "input": {
|
| 435 | },
|
| 436 | "output": {
|
| 437 | }
|
| 438 | },
|
| 439 | "description": "The following example returns the details of an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.",
|
| 440 | "id": "getipset-1474658688675",
|
| 441 | "title": "To get an IP set"
|
| 442 | }
|
| 443 | ],
|
| 444 | "GetRule": [
|
| 445 | {
|
| 446 | "input": {
|
| 447 | "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
|
| 448 | },
|
| 449 | "output": {
|
| 450 | "Rule": {
|
| 451 | "MetricName": "WAFByteHeaderRule",
|
| 452 | "Name": "WAFByteHeaderRule",
|
| 453 | "Predicates": [
|
| 454 | {
|
| 455 | "DataId": "MyByteMatchSetID",
|
| 456 | "Negated": false,
|
| 457 | "Type": "ByteMatch"
|
| 458 | }
|
| 459 | ],
|
| 460 | "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
|
| 461 | }
|
| 462 | },
|
| 463 | "comments": {
|
| 464 | "input": {
|
| 465 | },
|
| 466 | "output": {
|
| 467 | }
|
| 468 | },
|
| 469 | "description": "The following example returns the details of a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.",
|
| 470 | "id": "getrule-1474659238790",
|
| 471 | "title": "To get a rule"
|
| 472 | }
|
| 473 | ],
|
| 474 | "GetSampledRequests": [
|
| 475 | {
|
| 476 | "input": {
|
| 477 | "MaxItems": 100,
|
| 478 | "RuleId": "WAFRule-1-Example",
|
| 479 | "TimeWindow": {
|
| 480 | "EndTime": "2016-09-27T15:50Z",
|
| 481 | "StartTime": "2016-09-27T15:50Z"
|
| 482 | },
|
| 483 | "WebAclId": "createwebacl-1472061481310"
|
| 484 | },
|
| 485 | "output": {
|
| 486 | "PopulationSize": 50,
|
| 487 | "SampledRequests": [
|
| 488 | {
|
| 489 | "Action": "BLOCK",
|
| 490 | "Request": {
|
| 491 | "ClientIP": "192.0.2.44",
|
| 492 | "Country": "US",
|
| 493 | "HTTPVersion": "HTTP/1.1",
|
| 494 | "Headers": [
|
| 495 | {
|
| 496 | "Name": "User-Agent",
|
| 497 | "Value": "BadBot "
|
| 498 | }
|
| 499 | ],
|
| 500 | "Method": "HEAD"
|
| 501 | },
|
| 502 | "Timestamp": "2016-09-27T14:55Z",
|
| 503 | "Weight": 1
|
| 504 | }
|
| 505 | ],
|
| 506 | "TimeWindow": {
|
| 507 | "EndTime": "2016-09-27T15:50Z",
|
| 508 | "StartTime": "2016-09-27T14:50Z"
|
| 509 | }
|
| 510 | },
|
| 511 | "comments": {
|
| 512 | "input": {
|
| 513 | },
|
| 514 | "output": {
|
| 515 | }
|
| 516 | },
|
| 517 | "description": "The following example returns detailed information about 100 requests --a sample-- that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received between the time period 2016-09-27T15:50Z to 2016-09-27T15:50Z.",
|
| 518 | "id": "getsampledrequests-1474927997195",
|
| 519 | "title": "To get a sampled requests"
|
| 520 | }
|
| 521 | ],
|
| 522 | "GetSizeConstraintSet": [
|
| 523 | {
|
| 524 | "input": {
|
| 525 | "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
|
| 526 | },
|
| 527 | "output": {
|
| 528 | "SizeConstraintSet": {
|
| 529 | "Name": "MySampleSizeConstraintSet",
|
| 530 | "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
|
| 531 | "SizeConstraints": [
|
| 532 | {
|
| 533 | "ComparisonOperator": "GT",
|
| 534 | "FieldToMatch": {
|
| 535 | "Type": "QUERY_STRING"
|
| 536 | },
|
| 537 | "Size": 0,
|
| 538 | "TextTransformation": "NONE"
|
| 539 | }
|
| 540 | ]
|
| 541 | }
|
| 542 | },
|
| 543 | "comments": {
|
| 544 | "input": {
|
| 545 | },
|
| 546 | "output": {
|
| 547 | }
|
| 548 | },
|
| 549 | "description": "The following example returns the details of a size constraint match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.",
|
| 550 | "id": "getsizeconstraintset-1475005422493",
|
| 551 | "title": "To get a size constraint set"
|
| 552 | }
|
| 553 | ],
|
| 554 | "GetSqlInjectionMatchSet": [
|
| 555 | {
|
| 556 | "input": {
|
| 557 | "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
|
| 558 | },
|
| 559 | "output": {
|
| 560 | "SqlInjectionMatchSet": {
|
| 561 | "Name": "MySQLInjectionMatchSet",
|
| 562 | "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
|
| 563 | "SqlInjectionMatchTuples": [
|
| 564 | {
|
| 565 | "FieldToMatch": {
|
| 566 | "Type": "QUERY_STRING"
|
| 567 | },
|
| 568 | "TextTransformation": "URL_DECODE"
|
| 569 | }
|
| 570 | ]
|
| 571 | }
|
| 572 | },
|
| 573 | "comments": {
|
| 574 | "input": {
|
| 575 | },
|
| 576 | "output": {
|
| 577 | }
|
| 578 | },
|
| 579 | "description": "The following example returns the details of a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.",
|
| 580 | "id": "getsqlinjectionmatchset-1475005940137",
|
| 581 | "title": "To get a SQL injection match set"
|
| 582 | }
|
| 583 | ],
|
| 584 | "GetWebACL": [
|
| 585 | {
|
| 586 | "input": {
|
| 587 | "WebACLId": "createwebacl-1472061481310"
|
| 588 | },
|
| 589 | "output": {
|
| 590 | "WebACL": {
|
| 591 | "DefaultAction": {
|
| 592 | "Type": "ALLOW"
|
| 593 | },
|
| 594 | "MetricName": "CreateExample",
|
| 595 | "Name": "CreateExample",
|
| 596 | "Rules": [
|
| 597 | {
|
| 598 | "Action": {
|
| 599 | "Type": "ALLOW"
|
| 600 | },
|
| 601 | "Priority": 1,
|
| 602 | "RuleId": "WAFRule-1-Example"
|
| 603 | }
|
| 604 | ],
|
| 605 | "WebACLId": "createwebacl-1472061481310"
|
| 606 | }
|
| 607 | },
|
| 608 | "comments": {
|
| 609 | "input": {
|
| 610 | },
|
| 611 | "output": {
|
| 612 | }
|
| 613 | },
|
| 614 | "description": "The following example returns the details of a web ACL with the ID createwebacl-1472061481310.",
|
| 615 | "id": "getwebacl-1475006348525",
|
| 616 | "title": "To get a web ACL"
|
| 617 | }
|
| 618 | ],
|
| 619 | "GetXssMatchSet": [
|
| 620 | {
|
| 621 | "input": {
|
| 622 | "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
|
| 623 | },
|
| 624 | "output": {
|
| 625 | "XssMatchSet": {
|
| 626 | "Name": "MySampleXssMatchSet",
|
| 627 | "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
|
| 628 | "XssMatchTuples": [
|
| 629 | {
|
| 630 | "FieldToMatch": {
|
| 631 | "Type": "QUERY_STRING"
|
| 632 | },
|
| 633 | "TextTransformation": "URL_DECODE"
|
| 634 | }
|
| 635 | ]
|
| 636 | }
|
| 637 | },
|
| 638 | "comments": {
|
| 639 | "input": {
|
| 640 | },
|
| 641 | "output": {
|
| 642 | }
|
| 643 | },
|
| 644 | "description": "The following example returns the details of an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.",
|
| 645 | "id": "getxssmatchset-1475187879017",
|
| 646 | "title": "To get an XSS match set"
|
| 647 | }
|
| 648 | ],
|
| 649 | "ListIPSets": [
|
| 650 | {
|
| 651 | "input": {
|
| 652 | "Limit": 100
|
| 653 | },
|
| 654 | "output": {
|
| 655 | "IPSets": [
|
| 656 | {
|
| 657 | "IPSetId": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 658 | "Name": "MyIPSetFriendlyName"
|
| 659 | }
|
| 660 | ]
|
| 661 | },
|
| 662 | "comments": {
|
| 663 | "input": {
|
| 664 | },
|
| 665 | "output": {
|
| 666 | }
|
| 667 | },
|
| 668 | "description": "The following example returns an array of up to 100 IP match sets.",
|
| 669 | "id": "listipsets-1472235676229",
|
| 670 | "title": "To list IP sets"
|
| 671 | }
|
| 672 | ],
|
| 673 | "ListRules": [
|
| 674 | {
|
| 675 | "input": {
|
| 676 | "Limit": 100
|
| 677 | },
|
| 678 | "output": {
|
| 679 | "Rules": [
|
| 680 | {
|
| 681 | "Name": "WAFByteHeaderRule",
|
| 682 | "RuleId": "WAFRule-1-Example"
|
| 683 | }
|
| 684 | ]
|
| 685 | },
|
| 686 | "comments": {
|
| 687 | "input": {
|
| 688 | },
|
| 689 | "output": {
|
| 690 | }
|
| 691 | },
|
| 692 | "description": "The following example returns an array of up to 100 rules.",
|
| 693 | "id": "listrules-1475258406433",
|
| 694 | "title": "To list rules"
|
| 695 | }
|
| 696 | ],
|
| 697 | "ListSizeConstraintSets": [
|
| 698 | {
|
| 699 | "input": {
|
| 700 | "Limit": 100
|
| 701 | },
|
| 702 | "output": {
|
| 703 | "SizeConstraintSets": [
|
| 704 | {
|
| 705 | "Name": "MySampleSizeConstraintSet",
|
| 706 | "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
|
| 707 | }
|
| 708 | ]
|
| 709 | },
|
| 710 | "comments": {
|
| 711 | "input": {
|
| 712 | },
|
| 713 | "output": {
|
| 714 | }
|
| 715 | },
|
| 716 | "description": "The following example returns an array of up to 100 size contraint match sets.",
|
| 717 | "id": "listsizeconstraintsets-1474300067597",
|
| 718 | "title": "To list a size constraint sets"
|
| 719 | }
|
| 720 | ],
|
| 721 | "ListSqlInjectionMatchSets": [
|
| 722 | {
|
| 723 | "input": {
|
| 724 | "Limit": 100
|
| 725 | },
|
| 726 | "output": {
|
| 727 | "SqlInjectionMatchSets": [
|
| 728 | {
|
| 729 | "Name": "MySQLInjectionMatchSet",
|
| 730 | "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
|
| 731 | }
|
| 732 | ]
|
| 733 | },
|
| 734 | "comments": {
|
| 735 | "input": {
|
| 736 | },
|
| 737 | "output": {
|
| 738 | }
|
| 739 | },
|
| 740 | "description": "The following example returns an array of up to 100 SQL injection match sets.",
|
| 741 | "id": "listsqlinjectionmatchset-1474493560103",
|
| 742 | "title": "To list SQL injection match sets"
|
| 743 | }
|
| 744 | ],
|
| 745 | "ListWebACLs": [
|
| 746 | {
|
| 747 | "input": {
|
| 748 | "Limit": 100
|
| 749 | },
|
| 750 | "output": {
|
| 751 | "WebACLs": [
|
| 752 | {
|
| 753 | "Name": "WebACLexample",
|
| 754 | "WebACLId": "webacl-1472061481310"
|
| 755 | }
|
| 756 | ]
|
| 757 | },
|
| 758 | "comments": {
|
| 759 | "input": {
|
| 760 | },
|
| 761 | "output": {
|
| 762 | }
|
| 763 | },
|
| 764 | "description": "The following example returns an array of up to 100 web ACLs.",
|
| 765 | "id": "listwebacls-1475258732691",
|
| 766 | "title": "To list Web ACLs"
|
| 767 | }
|
| 768 | ],
|
| 769 | "ListXssMatchSets": [
|
| 770 | {
|
| 771 | "input": {
|
| 772 | "Limit": 100
|
| 773 | },
|
| 774 | "output": {
|
| 775 | "XssMatchSets": [
|
| 776 | {
|
| 777 | "Name": "MySampleXssMatchSet",
|
| 778 | "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
|
| 779 | }
|
| 780 | ]
|
| 781 | },
|
| 782 | "comments": {
|
| 783 | "input": {
|
| 784 | },
|
| 785 | "output": {
|
| 786 | }
|
| 787 | },
|
| 788 | "description": "The following example returns an array of up to 100 XSS match sets.",
|
| 789 | "id": "listxssmatchsets-1474561481168",
|
| 790 | "title": "To list XSS match sets"
|
| 791 | }
|
| 792 | ],
|
| 793 | "UpdateByteMatchSet": [
|
| 794 | {
|
| 795 | "input": {
|
| 796 | "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5",
|
| 797 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 798 | "Updates": [
|
| 799 | {
|
| 800 | "Action": "DELETE",
|
| 801 | "ByteMatchTuple": {
|
| 802 | "FieldToMatch": {
|
| 803 | "Data": "referer",
|
| 804 | "Type": "HEADER"
|
| 805 | },
|
| 806 | "PositionalConstraint": "CONTAINS",
|
| 807 | "TargetString": "badrefer1",
|
| 808 | "TextTransformation": "NONE"
|
| 809 | }
|
| 810 | }
|
| 811 | ]
|
| 812 | },
|
| 813 | "output": {
|
| 814 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
|
| 815 | },
|
| 816 | "comments": {
|
| 817 | "input": {
|
| 818 | },
|
| 819 | "output": {
|
| 820 | }
|
| 821 | },
|
| 822 | "description": "The following example deletes a ByteMatchTuple object (filters) in an byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.",
|
| 823 | "id": "updatebytematchset-1475259074558",
|
| 824 | "title": "To update a byte match set"
|
| 825 | }
|
| 826 | ],
|
| 827 | "UpdateIPSet": [
|
| 828 | {
|
| 829 | "input": {
|
| 830 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 831 | "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
|
| 832 | "Updates": [
|
| 833 | {
|
| 834 | "Action": "DELETE",
|
| 835 | "IPSetDescriptor": {
|
| 836 | "Type": "IPV4",
|
| 837 | "Value": "192.0.2.44/32"
|
| 838 | }
|
| 839 | }
|
| 840 | ]
|
| 841 | },
|
| 842 | "output": {
|
| 843 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
|
| 844 | },
|
| 845 | "comments": {
|
| 846 | "input": {
|
| 847 | },
|
| 848 | "output": {
|
| 849 | }
|
| 850 | },
|
| 851 | "description": "The following example deletes an IPSetDescriptor object in an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.",
|
| 852 | "id": "updateipset-1475259733625",
|
| 853 | "title": "To update an IP set"
|
| 854 | }
|
| 855 | ],
|
| 856 | "UpdateRule": [
|
| 857 | {
|
| 858 | "input": {
|
| 859 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 860 | "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
|
| 861 | "Updates": [
|
| 862 | {
|
| 863 | "Action": "DELETE",
|
| 864 | "Predicate": {
|
| 865 | "DataId": "MyByteMatchSetID",
|
| 866 | "Negated": false,
|
| 867 | "Type": "ByteMatch"
|
| 868 | }
|
| 869 | }
|
| 870 | ]
|
| 871 | },
|
| 872 | "output": {
|
| 873 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
|
| 874 | },
|
| 875 | "comments": {
|
| 876 | "input": {
|
| 877 | },
|
| 878 | "output": {
|
| 879 | }
|
| 880 | },
|
| 881 | "description": "The following example deletes a Predicate object in a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.",
|
| 882 | "id": "updaterule-1475260064720",
|
| 883 | "title": "To update a rule"
|
| 884 | }
|
| 885 | ],
|
| 886 | "UpdateSizeConstraintSet": [
|
| 887 | {
|
| 888 | "input": {
|
| 889 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 890 | "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
|
| 891 | "Updates": [
|
| 892 | {
|
| 893 | "Action": "DELETE",
|
| 894 | "SizeConstraint": {
|
| 895 | "ComparisonOperator": "GT",
|
| 896 | "FieldToMatch": {
|
| 897 | "Type": "QUERY_STRING"
|
| 898 | },
|
| 899 | "Size": 0,
|
| 900 | "TextTransformation": "NONE"
|
| 901 | }
|
| 902 | }
|
| 903 | ]
|
| 904 | },
|
| 905 | "output": {
|
| 906 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
|
| 907 | },
|
| 908 | "comments": {
|
| 909 | "input": {
|
| 910 | },
|
| 911 | "output": {
|
| 912 | }
|
| 913 | },
|
| 914 | "description": "The following example deletes a SizeConstraint object (filters) in a size constraint set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.",
|
| 915 | "id": "updatesizeconstraintset-1475531697891",
|
| 916 | "title": "To update a size constraint set"
|
| 917 | }
|
| 918 | ],
|
| 919 | "UpdateSqlInjectionMatchSet": [
|
| 920 | {
|
| 921 | "input": {
|
| 922 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 923 | "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
|
| 924 | "Updates": [
|
| 925 | {
|
| 926 | "Action": "DELETE",
|
| 927 | "SqlInjectionMatchTuple": {
|
| 928 | "FieldToMatch": {
|
| 929 | "Type": "QUERY_STRING"
|
| 930 | },
|
| 931 | "TextTransformation": "URL_DECODE"
|
| 932 | }
|
| 933 | }
|
| 934 | ]
|
| 935 | },
|
| 936 | "output": {
|
| 937 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
|
| 938 | },
|
| 939 | "comments": {
|
| 940 | "input": {
|
| 941 | },
|
| 942 | "output": {
|
| 943 | }
|
| 944 | },
|
| 945 | "description": "The following example deletes a SqlInjectionMatchTuple object (filters) in a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.",
|
| 946 | "id": "updatesqlinjectionmatchset-1475532094686",
|
| 947 | "title": "To update a SQL injection match set"
|
| 948 | }
|
| 949 | ],
|
| 950 | "UpdateWebACL": [
|
| 951 | {
|
| 952 | "input": {
|
| 953 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 954 | "DefaultAction": {
|
| 955 | "Type": "ALLOW"
|
| 956 | },
|
| 957 | "Updates": [
|
| 958 | {
|
| 959 | "Action": "DELETE",
|
| 960 | "ActivatedRule": {
|
| 961 | "Action": {
|
| 962 | "Type": "ALLOW"
|
| 963 | },
|
| 964 | "Priority": 1,
|
| 965 | "RuleId": "WAFRule-1-Example"
|
| 966 | }
|
| 967 | }
|
| 968 | ],
|
| 969 | "WebACLId": "webacl-1472061481310"
|
| 970 | },
|
| 971 | "output": {
|
| 972 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
|
| 973 | },
|
| 974 | "comments": {
|
| 975 | "input": {
|
| 976 | },
|
| 977 | "output": {
|
| 978 | }
|
| 979 | },
|
| 980 | "description": "The following example deletes an ActivatedRule object in a WebACL with the ID webacl-1472061481310.",
|
| 981 | "id": "updatewebacl-1475533627385",
|
| 982 | "title": "To update a Web ACL"
|
| 983 | }
|
| 984 | ],
|
| 985 | "UpdateXssMatchSet": [
|
| 986 | {
|
| 987 | "input": {
|
| 988 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
|
| 989 | "Updates": [
|
| 990 | {
|
| 991 | "Action": "DELETE",
|
| 992 | "XssMatchTuple": {
|
| 993 | "FieldToMatch": {
|
| 994 | "Type": "QUERY_STRING"
|
| 995 | },
|
| 996 | "TextTransformation": "URL_DECODE"
|
| 997 | }
|
| 998 | }
|
| 999 | ],
|
| 1000 | "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
|
| 1001 | },
|
| 1002 | "output": {
|
| 1003 | "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
|
| 1004 | },
|
| 1005 | "comments": {
|
| 1006 | "input": {
|
| 1007 | },
|
| 1008 | "output": {
|
| 1009 | }
|
| 1010 | },
|
| 1011 | "description": "The following example deletes an XssMatchTuple object (filters) in an XssMatchSet with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.",
|
| 1012 | "id": "updatexssmatchset-1475534098881",
|
| 1013 | "title": "To update an XSS match set"
|
| 1014 | }
|
| 1015 | ]
|
| 1016 | }
|
| 1017 | }
|