misp-client-rs 0.1.0

A Rust client library for interacting with MISP (Malware Information Sharing Platform) instances via their REST 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

# \WarninglistsApi

All URIs are relative to *https://misp.local*

Method | HTTP request | Description
------------- | ------------- | -------------
[**check_value_warninglists_matches**](WarninglistsApi.md#check_value_warninglists_matches) | **POST** /warninglists/checkValue | Check if a list of values matches any warninglists
[**get_warninglist_by_id**](WarninglistsApi.md#get_warninglist_by_id) | **GET** /warninglists/view/{warninglistId} | Get warninglist by ID
[**get_warninglists**](WarninglistsApi.md#get_warninglists) | **GET** /warninglists | Get a list of warninglists
[**search_warninglists**](WarninglistsApi.md#search_warninglists) | **POST** /warninglists | Search warninglists
[**toggle_enable_warninglist**](WarninglistsApi.md#toggle_enable_warninglist) | **POST** /warninglists/toggleEnable | Enable/disable warninglists
[**update_warninglists**](WarninglistsApi.md#update_warninglists) | **POST** /warninglists/update | Update warninglists



## check_value_warninglists_matches

> serde_json::Value check_value_warninglists_matches(request_body)
Check if a list of values matches any warninglists

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**request_body** | Option<[**Vec<String>**](String.md)> |  |  |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_warninglist_by_id

> models::GetWarninglists200ResponseWarninglistsInner get_warninglist_by_id(warninglist_id)
Get warninglist by ID

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**warninglist_id** | **String** | Numeric ID of the warninglist | [required] |

### Return type

[**models::GetWarninglists200ResponseWarninglistsInner**](getWarninglists_200_response_Warninglists_inner.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_warninglists

> models::GetWarninglists200Response get_warninglists()
Get a list of warninglists

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::GetWarninglists200Response**](getWarninglists_200_response.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## search_warninglists

> models::GetWarninglists200Response search_warninglists(value, enabled)
Search warninglists

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**value** | Option<**String**> | Search term to be used to match warninglists name, description or type. |  |
**enabled** | Option<**bool**> |  |  |

### Return type

[**models::GetWarninglists200Response**](getWarninglists_200_response.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## toggle_enable_warninglist

> models::ToggleEnableWarninglist200Response toggle_enable_warninglist(id, name, enabled)
Enable/disable warninglists

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | Option<[**Vec<String>**](String.md)> | One or more warninglist IDs. For a single ID, provide an array with one element. |  |
**name** | Option<[**Vec<String>**](String.md)> | One or more warninglist name patterns (e.g., \\\"%search term%\\\"). For a single pattern, provide an array with one element. |  |
**enabled** | Option<**bool**> |  |  |

### Return type

[**models::ToggleEnableWarninglist200Response**](toggleEnableWarninglist_200_response.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_warninglists

> models::UpdateWarninglists200Response update_warninglists()
Update warninglists

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::UpdateWarninglists200Response**](updateWarninglists_200_response.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)