cortex-client 0.1.1

API for Cortex, a powerful observable analysis and active response engine.
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

# \AnalyzerApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_analyzer_from_definition**](AnalyzerApi.md#create_analyzer_from_definition) | **POST** /analyzer/definition/{analyzerDefinitionId} | Create a new analyzer instance from a definition
[**delete_analyzer**](AnalyzerApi.md#delete_analyzer) | **DELETE** /analyzer/{analyzerId} | Delete an analyzer
[**find_analyzers**](AnalyzerApi.md#find_analyzers) | **POST** /analyzer/_search | Find/Search analyzers
[**get_analyzer_by_id**](AnalyzerApi.md#get_analyzer_by_id) | **GET** /analyzer/{analyzerId} | Get a specific analyzer by ID
[**list_analyzer_definitions**](AnalyzerApi.md#list_analyzer_definitions) | **GET** /analyzer/definition | List all available analyzer definitions
[**list_analyzers_for_type**](AnalyzerApi.md#list_analyzers_for_type) | **GET** /analyzer/type/{dataType} | List analyzers available for a specific data type
[**scan_analyzer_definitions**](AnalyzerApi.md#scan_analyzer_definitions) | **POST** /analyzer/scan | Trigger a rescan of analyzer definitions
[**update_analyzer**](AnalyzerApi.md#update_analyzer) | **PUT** /analyzer/{analyzerId} | Update an analyzer



## create_analyzer_from_definition

> models::Worker create_analyzer_from_definition(analyzer_definition_id, analyzer_create_request)
Create a new analyzer instance from a definition

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**analyzer_definition_id** | **String** | The ID of the analyzer definition to use for creation. | [required] |
**analyzer_create_request** | [**AnalyzerCreateRequest**](AnalyzerCreateRequest.md) |  | [required] |

### Return type

[**models::Worker**](Worker.md)

### Authorization

[SessionAuth](../README.md#SessionAuth), [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)


## delete_analyzer

> delete_analyzer(analyzer_id)
Delete an analyzer

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**analyzer_id** | **String** | The ID of the analyzer | [required] |

### Return type

 (empty response body)

### Authorization

[SessionAuth](../README.md#SessionAuth), [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)


## find_analyzers

> Vec<models::Worker> find_analyzers(analyzer_find_request)
Find/Search analyzers

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**analyzer_find_request** | Option<[**AnalyzerFindRequest**](AnalyzerFindRequest.md)> |  |  |

### Return type

[**Vec<models::Worker>**](Worker.md)

### Authorization

[SessionAuth](../README.md#SessionAuth), [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_analyzer_by_id

> models::Worker get_analyzer_by_id(analyzer_id)
Get a specific analyzer by ID

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**analyzer_id** | **String** | The ID of the analyzer | [required] |

### Return type

[**models::Worker**](Worker.md)

### Authorization

[SessionAuth](../README.md#SessionAuth), [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)


## list_analyzer_definitions

> models::ListAnalyzerDefinitions200Response list_analyzer_definitions()
List all available analyzer definitions

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::ListAnalyzerDefinitions200Response**](listAnalyzerDefinitions_200_response.md)

### Authorization

[SessionAuth](../README.md#SessionAuth), [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)


## list_analyzers_for_type

> models::ListAnalyzersForType200Response list_analyzers_for_type(data_type)
List analyzers available for a specific data type

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**data_type** | **String** | The data type to filter analyzers by (e.g., ip, domain, file). | [required] |

### Return type

[**models::ListAnalyzersForType200Response**](listAnalyzersForType_200_response.md)

### Authorization

[SessionAuth](../README.md#SessionAuth), [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)


## scan_analyzer_definitions

> scan_analyzer_definitions()
Trigger a rescan of analyzer definitions

### Parameters

This endpoint does not need any parameter.

### Return type

 (empty response body)

### Authorization

[SessionAuth](../README.md#SessionAuth), [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)


## update_analyzer

> models::Worker update_analyzer(analyzer_id, request_body)
Update an analyzer

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**analyzer_id** | **String** | The ID of the analyzer | [required] |
**request_body** | [**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md) |  | [required] |

### Return type

[**models::Worker**](Worker.md)

### Authorization

[SessionAuth](../README.md#SessionAuth), [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)