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

/* 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.
 */
/**
 * Statistics
*/
pub fn stats(service: &ZapService, keyprefix: String) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("keyPrefix".to_string(), keyprefix);
    super::call(service, "stats", "view", "stats", params)
}

/**
 * Gets all of the site based statistics, optionally filtered by a key prefix
*/
pub fn all_sites_stats(service: &ZapService, keyprefix: String) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("keyPrefix".to_string(), keyprefix);
    super::call(service, "stats", "view", "allSitesStats", params)
}

/**
 * Gets all of the global statistics, optionally filtered by a key prefix
*/
pub fn site_stats(
    service: &ZapService,
    site: String,
    keyprefix: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("site".to_string(), site);
    params.insert("keyPrefix".to_string(), keyprefix);
    super::call(service, "stats", "view", "siteStats", params)
}

/**
 * Gets the Statsd service hostname
*/
pub fn option_statsd_host(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "stats", "view", "optionStatsdHost", params)
}

/**
 * Gets the Statsd service port
*/
pub fn option_statsd_port(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "stats", "view", "optionStatsdPort", params)
}

/**
 * Gets the prefix to be applied to all stats sent to the configured Statsd service
*/
pub fn option_statsd_prefix(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "stats", "view", "optionStatsdPrefix", params)
}

/**
 * Returns 'true' if in memory statistics are enabled, otherwise returns 'false'
*/
pub fn option_in_memory_enabled(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "stats", "view", "optionInMemoryEnabled", params)
}

/**
 * Returns 'true' if a Statsd server has been correctly configured, otherwise returns 'false'
*/
pub fn option_statsd_enabled(service: &ZapService) -> Result<Value, ZapApiError> {
    let params = HashMap::new();
    super::call(service, "stats", "view", "optionStatsdEnabled", params)
}

/**
 * Clears all of the statistics
*/
pub fn clear_stats(service: &ZapService, keyprefix: String) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("keyPrefix".to_string(), keyprefix);
    super::call(service, "stats", "action", "clearStats", params)
}

/**
 * Sets the Statsd service hostname, supply an empty string to stop using a Statsd service
*/
pub fn set_option_statsd_host(service: &ZapService, string: String) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("String".to_string(), string);
    super::call(service, "stats", "action", "setOptionStatsdHost", params)
}

/**
 * Sets the prefix to be applied to all stats sent to the configured Statsd service
*/
pub fn set_option_statsd_prefix(
    service: &ZapService,
    string: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("String".to_string(), string);
    super::call(service, "stats", "action", "setOptionStatsdPrefix", params)
}

/**
 * Sets whether in memory statistics are enabled
*/
pub fn set_option_in_memory_enabled(
    service: &ZapService,
    boolean: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Boolean".to_string(), boolean);
    super::call(
        service,
        "stats",
        "action",
        "setOptionInMemoryEnabled",
        params,
    )
}

/**
 * Sets the Statsd service port
*/
pub fn set_option_statsd_port(service: &ZapService, integer: String) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("Integer".to_string(), integer);
    super::call(service, "stats", "action", "setOptionStatsdPort", params)
}