zap_api 0.0.2

The Rust implementation to access the OWASP ZAP API
Documentation
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
/* Zed Attack Proxy (ZAP) and its related class files.
 *
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 *
 * Copyright 2019 the ZAP development team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use super::ZapApiError;
use super::ZapService;
use serde_json::Value;
use std::collections::HashMap;

/**
 * This file was automatically generated.
 */
pub fn status(service: &ZapService, scanid: String) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("scanId".to_string(), scanid);
    super::call(service, "ascan", "view", "status", params)
}

pub fn scan_progress(service: &ZapService, scanid: String) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("scanId".to_string(), scanid);
    super::call(service, "ascan", "view", "scanProgress", params)
}

/**
 * Gets the IDs of the messages sent during the scan with the given ID. A message can be obtained with 'message' core view.
*/
pub fn messages_ids(service: &ZapService, scanid: String) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("scanId".to_string(), scanid);
    super::call(service, "ascan", "view", "messagesIds", params)
}

/**
 * Gets the IDs of the alerts raised during the scan with the given ID. An alert can be obtained with 'alert' core view.
*/
pub fn alerts_ids(service: &ZapService, scanid: String) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("scanId".to_string(), scanid);
    super::call(service, "ascan", "view", "alertsIds", params)
}

pub fn scans(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "scans", params)
}

pub fn scan_policy_names(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "scanPolicyNames", params)
}

/**
 * Gets the regexes of URLs excluded from the active scans.
*/
pub fn excluded_from_scan(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "excludedFromScan", params)
}

/**
 * Gets the scanners, optionally, of the given scan policy and/or scanner policy/category ID.
*/
pub fn scanners(
    service: &ZapService,
    scanpolicyname: String,
    policyid: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("scanPolicyName".to_string(), scanpolicyname);
    params.insert("policyId".to_string(), policyid);
    super::call(service, "ascan", "view", "scanners", params)
}

pub fn policies(
    service: &ZapService,
    scanpolicyname: String,
    policyid: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("scanPolicyName".to_string(), scanpolicyname);
    params.insert("policyId".to_string(), policyid);
    super::call(service, "ascan", "view", "policies", params)
}

pub fn attack_mode_queue(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "attackModeQueue", params)
}

/**
 * Gets all the parameters that are excluded. For each parameter the following are shown: the name, the URL, and the parameter type.
*/
pub fn excluded_params(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "excludedParams", params)
}

/**
 * Use view excludedParams instead.
 * Deprecated
*/
pub fn option_excluded_param_list(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "optionExcludedParamList", params)
}

/**
 * Gets all the types of excluded parameters. For each type the following are shown: the ID and the name.
*/
pub fn excluded_param_types(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "excludedParamTypes", params)
}

pub fn option_attack_policy(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "optionAttackPolicy", params)
}

pub fn option_default_policy(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "optionDefaultPolicy", params)
}

pub fn option_delay_in_ms(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "optionDelayInMs", params)
}

pub fn option_handle_anti_csrf_tokens(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(
        service,
        "ascan",
        "view",
        "optionHandleAntiCSRFTokens",
        params,
    )
}

pub fn option_host_per_scan(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "optionHostPerScan", params)
}

pub fn option_max_chart_time_in_mins(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "optionMaxChartTimeInMins", params)
}

pub fn option_max_results_to_list(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "optionMaxResultsToList", params)
}

pub fn option_max_rule_duration_in_mins(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(
        service,
        "ascan",
        "view",
        "optionMaxRuleDurationInMins",
        params,
    )
}

pub fn option_max_scan_duration_in_mins(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(
        service,
        "ascan",
        "view",
        "optionMaxScanDurationInMins",
        params,
    )
}

pub fn option_max_scans_in_ui(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "optionMaxScansInUI", params)
}

pub fn option_target_params_enabled_rpc(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(
        service,
        "ascan",
        "view",
        "optionTargetParamsEnabledRPC",
        params,
    )
}

pub fn option_target_params_injectable(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(
        service,
        "ascan",
        "view",
        "optionTargetParamsInjectable",
        params,
    )
}

pub fn option_thread_per_host(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "optionThreadPerHost", params)
}

/**
 * Tells whether or not the active scanner should add a query parameter to GET request that don't have parameters to start with.
*/
pub fn option_add_query_param(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "optionAddQueryParam", params)
}

pub fn option_allow_attack_on_start(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "optionAllowAttackOnStart", params)
}

/**
 * Tells whether or not the active scanner should inject the HTTP request header X-ZAP-Scan-ID, with the ID of the scanner that's sending the requests.
*/
pub fn option_inject_plugin_id_in_header(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(
        service,
        "ascan",
        "view",
        "optionInjectPluginIdInHeader",
        params,
    )
}

pub fn option_prompt_in_attack_mode(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "optionPromptInAttackMode", params)
}

pub fn option_prompt_to_clear_finished_scans(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(
        service,
        "ascan",
        "view",
        "optionPromptToClearFinishedScans",
        params,
    )
}

pub fn option_rescan_in_attack_mode(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "optionRescanInAttackMode", params)
}

/**
 * Tells whether or not the HTTP Headers of all requests should be scanned. Not just requests that send parameters, through the query or request body.
*/
pub fn option_scan_headers_all_requests(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(
        service,
        "ascan",
        "view",
        "optionScanHeadersAllRequests",
        params,
    )
}

pub fn option_show_advanced_dialog(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "view", "optionShowAdvancedDialog", params)
}

/**
 * Runs the active scanner against the given URL and/or Context. Optionally, the 'recurse' parameter can be used to scan URLs under the given URL, the parameter 'inScopeOnly' can be used to constrain the scan to URLs that are in scope (ignored if a Context is specified), the parameter 'scanPolicyName' allows to specify the scan policy (if none is given it uses the default scan policy), the parameters 'method' and 'postData' allow to select a given request in conjunction with the given URL.
*/
#[allow(clippy::too_many_arguments)]
pub fn scan(
    service: &ZapService,
    url: String,
    recurse: String,
    inscopeonly: String,
    scanpolicyname: String,
    method: String,
    postdata: String,
    contextid: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("url".to_string(), url);
    params.insert("recurse".to_string(), recurse);
    params.insert("inScopeOnly".to_string(), inscopeonly);
    params.insert("scanPolicyName".to_string(), scanpolicyname);
    params.insert("method".to_string(), method);
    params.insert("postData".to_string(), postdata);
    params.insert("contextId".to_string(), contextid);
    super::call(service, "ascan", "action", "scan", params)
}

/**
 * Active Scans from the perspective of a User, obtained using the given Context ID and User ID. See 'scan' action for more details.
*/
#[allow(clippy::too_many_arguments)]
pub fn scan_as_user(
    service: &ZapService,
    url: String,
    contextid: String,
    userid: String,
    recurse: String,
    scanpolicyname: String,
    method: String,
    postdata: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("url".to_string(), url);
    params.insert("contextId".to_string(), contextid);
    params.insert("userId".to_string(), userid);
    params.insert("recurse".to_string(), recurse);
    params.insert("scanPolicyName".to_string(), scanpolicyname);
    params.insert("method".to_string(), method);
    params.insert("postData".to_string(), postdata);
    super::call(service, "ascan", "action", "scanAsUser", params)
}

pub fn pause(service: &ZapService, scanid: String) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("scanId".to_string(), scanid);
    super::call(service, "ascan", "action", "pause", params)
}

pub fn resume(service: &ZapService, scanid: String) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("scanId".to_string(), scanid);
    super::call(service, "ascan", "action", "resume", params)
}

pub fn stop(service: &ZapService, scanid: String) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("scanId".to_string(), scanid);
    super::call(service, "ascan", "action", "stop", params)
}

pub fn remove_scan(service: &ZapService, scanid: String) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("scanId".to_string(), scanid);
    super::call(service, "ascan", "action", "removeScan", params)
}

pub fn pause_all_scans(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "action", "pauseAllScans", params)
}

pub fn resume_all_scans(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "action", "resumeAllScans", params)
}

pub fn stop_all_scans(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "action", "stopAllScans", params)
}

pub fn remove_all_scans(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "action", "removeAllScans", params)
}

/**
 * Clears the regexes of URLs excluded from the active scans.
*/
pub fn clear_excluded_from_scan(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "ascan", "action", "clearExcludedFromScan", params)
}

/**
 * Adds a regex of URLs that should be excluded from the active scans.
*/
pub fn exclude_from_scan(service: &ZapService, regex: String) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("regex".to_string(), regex);
    super::call(service, "ascan", "action", "excludeFromScan", params)
}

/**
 * Enables all scanners of the scan policy with the given name, or the default if none given.
*/
pub fn enable_all_scanners(
    service: &ZapService,
    scanpolicyname: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("scanPolicyName".to_string(), scanpolicyname);
    super::call(service, "ascan", "action", "enableAllScanners", params)
}

/**
 * Disables all scanners of the scan policy with the given name, or the default if none given.
*/
pub fn disable_all_scanners(
    service: &ZapService,
    scanpolicyname: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("scanPolicyName".to_string(), scanpolicyname);
    super::call(service, "ascan", "action", "disableAllScanners", params)
}

/**
 * Enables the scanners with the given IDs (comma separated list of IDs) of the scan policy with the given name, or the default if none given.
*/
pub fn enable_scanners(
    service: &ZapService,
    ids: String,
    scanpolicyname: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("ids".to_string(), ids);
    params.insert("scanPolicyName".to_string(), scanpolicyname);
    super::call(service, "ascan", "action", "enableScanners", params)
}

/**
 * Disables the scanners with the given IDs (comma separated list of IDs) of the scan policy with the given name, or the default if none given.
*/
pub fn disable_scanners(
    service: &ZapService,
    ids: String,
    scanpolicyname: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("ids".to_string(), ids);
    params.insert("scanPolicyName".to_string(), scanpolicyname);
    super::call(service, "ascan", "action", "disableScanners", params)
}

pub fn set_enabled_policies(
    service: &ZapService,
    ids: String,
    scanpolicyname: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("ids".to_string(), ids);
    params.insert("scanPolicyName".to_string(), scanpolicyname);
    super::call(service, "ascan", "action", "setEnabledPolicies", params)
}

pub fn set_policy_attack_strength(
    service: &ZapService,
    id: String,
    attackstrength: String,
    scanpolicyname: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("id".to_string(), id);
    params.insert("attackStrength".to_string(), attackstrength);
    params.insert("scanPolicyName".to_string(), scanpolicyname);
    super::call(
        service,
        "ascan",
        "action",
        "setPolicyAttackStrength",
        params,
    )
}

pub fn set_policy_alert_threshold(
    service: &ZapService,
    id: String,
    alertthreshold: String,
    scanpolicyname: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("id".to_string(), id);
    params.insert("alertThreshold".to_string(), alertthreshold);
    params.insert("scanPolicyName".to_string(), scanpolicyname);
    super::call(
        service,
        "ascan",
        "action",
        "setPolicyAlertThreshold",
        params,
    )
}

pub fn set_scanner_attack_strength(
    service: &ZapService,
    id: String,
    attackstrength: String,
    scanpolicyname: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("id".to_string(), id);
    params.insert("attackStrength".to_string(), attackstrength);
    params.insert("scanPolicyName".to_string(), scanpolicyname);
    super::call(
        service,
        "ascan",
        "action",
        "setScannerAttackStrength",
        params,
    )
}

pub fn set_scanner_alert_threshold(
    service: &ZapService,
    id: String,
    alertthreshold: String,
    scanpolicyname: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("id".to_string(), id);
    params.insert("alertThreshold".to_string(), alertthreshold);
    params.insert("scanPolicyName".to_string(), scanpolicyname);
    super::call(
        service,
        "ascan",
        "action",
        "setScannerAlertThreshold",
        params,
    )
}

pub fn add_scan_policy(
    service: &ZapService,
    scanpolicyname: String,
    alertthreshold: String,
    attackstrength: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("scanPolicyName".to_string(), scanpolicyname);
    params.insert("alertThreshold".to_string(), alertthreshold);
    params.insert("attackStrength".to_string(), attackstrength);
    super::call(service, "ascan", "action", "addScanPolicy", params)
}

pub fn remove_scan_policy(
    service: &ZapService,
    scanpolicyname: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("scanPolicyName".to_string(), scanpolicyname);
    super::call(service, "ascan", "action", "removeScanPolicy", params)
}

pub fn update_scan_policy(
    service: &ZapService,
    scanpolicyname: String,
    alertthreshold: String,
    attackstrength: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("scanPolicyName".to_string(), scanpolicyname);
    params.insert("alertThreshold".to_string(), alertthreshold);
    params.insert("attackStrength".to_string(), attackstrength);
    super::call(service, "ascan", "action", "updateScanPolicy", params)
}

/**
 * Imports a Scan Policy using the given file system path.
*/
pub fn import_scan_policy(service: &ZapService, path: String) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("path".to_string(), path);
    super::call(service, "ascan", "action", "importScanPolicy", params)
}

/**
 * Adds a new parameter excluded from the scan, using the specified name. Optionally sets if the new entry applies to a specific URL (default, all URLs) and sets the ID of the type of the parameter (default, ID of any type). The type IDs can be obtained with the view excludedParamTypes.
*/
pub fn add_excluded_param(
    service: &ZapService,
    name: String,
    typ: String,
    url: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("name".to_string(), name);
    params.insert("type".to_string(), typ);
    params.insert("url".to_string(), url);
    super::call(service, "ascan", "action", "addExcludedParam", params)
}

/**
 * Modifies a parameter excluded from the scan. Allows to modify the name, the URL and the type of parameter. The parameter is selected with its index, which can be obtained with the view excludedParams.
*/
pub fn modify_excluded_param(
    service: &ZapService,
    idx: String,
    name: String,
    typ: String,
    url: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("idx".to_string(), idx);
    params.insert("name".to_string(), name);
    params.insert("type".to_string(), typ);
    params.insert("url".to_string(), url);
    super::call(service, "ascan", "action", "modifyExcludedParam", params)
}

/**
 * Removes a parameter excluded from the scan, with the given index. The index can be obtained with the view excludedParams.
*/
pub fn remove_excluded_param(service: &ZapService, idx: String) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("idx".to_string(), idx);
    super::call(service, "ascan", "action", "removeExcludedParam", params)
}

/**
 * Skips the scanner using the given IDs of the scan and the scanner.
*/
pub fn skip_scanner(
    service: &ZapService,
    scanid: String,
    scannerid: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("scanId".to_string(), scanid);
    params.insert("scannerId".to_string(), scannerid);
    super::call(service, "ascan", "action", "skipScanner", params)
}

pub fn set_option_attack_policy(
    service: &ZapService,
    string: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("String".to_string(), string);
    super::call(service, "ascan", "action", "setOptionAttackPolicy", params)
}

pub fn set_option_default_policy(
    service: &ZapService,
    string: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("String".to_string(), string);
    super::call(service, "ascan", "action", "setOptionDefaultPolicy", params)
}

/**
 * Sets whether or not the active scanner should add a query param to GET requests which do not have parameters to start with.
*/
pub fn set_option_add_query_param(
    service: &ZapService,
    boolean: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Boolean".to_string(), boolean);
    super::call(service, "ascan", "action", "setOptionAddQueryParam", params)
}

pub fn set_option_allow_attack_on_start(
    service: &ZapService,
    boolean: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Boolean".to_string(), boolean);
    super::call(
        service,
        "ascan",
        "action",
        "setOptionAllowAttackOnStart",
        params,
    )
}

pub fn set_option_delay_in_ms(service: &ZapService, integer: String) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Integer".to_string(), integer);
    super::call(service, "ascan", "action", "setOptionDelayInMs", params)
}

pub fn set_option_handle_anti_csrf_tokens(
    service: &ZapService,
    boolean: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Boolean".to_string(), boolean);
    super::call(
        service,
        "ascan",
        "action",
        "setOptionHandleAntiCSRFTokens",
        params,
    )
}

pub fn set_option_host_per_scan(
    service: &ZapService,
    integer: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Integer".to_string(), integer);
    super::call(service, "ascan", "action", "setOptionHostPerScan", params)
}

/**
 * Sets whether or not the active scanner should inject the HTTP request header X-ZAP-Scan-ID, with the ID of the scanner that's sending the requests.
*/
pub fn set_option_inject_plugin_id_in_header(
    service: &ZapService,
    boolean: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Boolean".to_string(), boolean);
    super::call(
        service,
        "ascan",
        "action",
        "setOptionInjectPluginIdInHeader",
        params,
    )
}

pub fn set_option_max_chart_time_in_mins(
    service: &ZapService,
    integer: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Integer".to_string(), integer);
    super::call(
        service,
        "ascan",
        "action",
        "setOptionMaxChartTimeInMins",
        params,
    )
}

pub fn set_option_max_results_to_list(
    service: &ZapService,
    integer: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Integer".to_string(), integer);
    super::call(
        service,
        "ascan",
        "action",
        "setOptionMaxResultsToList",
        params,
    )
}

pub fn set_option_max_rule_duration_in_mins(
    service: &ZapService,
    integer: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Integer".to_string(), integer);
    super::call(
        service,
        "ascan",
        "action",
        "setOptionMaxRuleDurationInMins",
        params,
    )
}

pub fn set_option_max_scan_duration_in_mins(
    service: &ZapService,
    integer: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Integer".to_string(), integer);
    super::call(
        service,
        "ascan",
        "action",
        "setOptionMaxScanDurationInMins",
        params,
    )
}

pub fn set_option_max_scans_in_ui(
    service: &ZapService,
    integer: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Integer".to_string(), integer);
    super::call(service, "ascan", "action", "setOptionMaxScansInUI", params)
}

pub fn set_option_prompt_in_attack_mode(
    service: &ZapService,
    boolean: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Boolean".to_string(), boolean);
    super::call(
        service,
        "ascan",
        "action",
        "setOptionPromptInAttackMode",
        params,
    )
}

pub fn set_option_prompt_to_clear_finished_scans(
    service: &ZapService,
    boolean: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Boolean".to_string(), boolean);
    super::call(
        service,
        "ascan",
        "action",
        "setOptionPromptToClearFinishedScans",
        params,
    )
}

pub fn set_option_rescan_in_attack_mode(
    service: &ZapService,
    boolean: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Boolean".to_string(), boolean);
    super::call(
        service,
        "ascan",
        "action",
        "setOptionRescanInAttackMode",
        params,
    )
}

/**
 * Sets whether or not the HTTP Headers of all requests should be scanned. Not just requests that send parameters, through the query or request body.
*/
pub fn set_option_scan_headers_all_requests(
    service: &ZapService,
    boolean: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Boolean".to_string(), boolean);
    super::call(
        service,
        "ascan",
        "action",
        "setOptionScanHeadersAllRequests",
        params,
    )
}

pub fn set_option_show_advanced_dialog(
    service: &ZapService,
    boolean: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Boolean".to_string(), boolean);
    super::call(
        service,
        "ascan",
        "action",
        "setOptionShowAdvancedDialog",
        params,
    )
}

pub fn set_option_target_params_enabled_rpc(
    service: &ZapService,
    integer: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Integer".to_string(), integer);
    super::call(
        service,
        "ascan",
        "action",
        "setOptionTargetParamsEnabledRPC",
        params,
    )
}

pub fn set_option_target_params_injectable(
    service: &ZapService,
    integer: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Integer".to_string(), integer);
    super::call(
        service,
        "ascan",
        "action",
        "setOptionTargetParamsInjectable",
        params,
    )
}

pub fn set_option_thread_per_host(
    service: &ZapService,
    integer: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Integer".to_string(), integer);
    super::call(service, "ascan", "action", "setOptionThreadPerHost", params)
}