-
Notifications
You must be signed in to change notification settings - Fork 51
/
Copy pathopenapi-patrowl-engines.yaml
385 lines (364 loc) · 9.75 KB
/
openapi-patrowl-engines.yaml
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
openapi: "3.0.0"
info:
description: "This is the API documentation for Patrowl Engines usage."
version: "1.0.0"
title: "Swagger API-REST for Patrowl Engines"
contact:
email: "[email protected]"
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
servers:
- url: http://localhost:5001/engines/nmap/
- url: http://localhost:5004/engines/ssllabs/
- url: http://localhost:5005/engines/arachni/
- url: http://localhost:5006/engines/owl_dns/
- url: http://localhost:5007/engines/virustotal/
- url: http://localhost:5008/engines/urlvoid/
- url: http://localhost:5009/engines/cortex/
- url: http://localhost:5012/engines/owl_leaks/
- url: http://localhost:5013/engines/owl_code/
- url: http://localhost:5014/engines/sslscan/
tags:
- name: "patrowl-engine"
description: "SSLScan API documentation"
externalDocs:
description: "Find out more"
url: "https://github.com/Patrowl/PatrowlDocs"
paths:
/:
get:
tags:
- "patrowl-engine"
summary: "Index page"
description: "Return index page"
operationId: "getDefaultPage"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
/liveness:
get:
tags:
- "patrowl-engine"
summary: "Liveness page"
description: "Return liveness page"
operationId: "getLivenessPage"
responses:
200:
description: "successful operation"
/readiness:
get:
tags:
- "patrowl-engine"
summary: "Readiness page"
description: "Return liveness page"
operationId: "getReadinessPage"
responses:
200:
description: "successful operation"
/test:
get:
tags:
- "patrowl-engine"
summary: "Test page"
description: "Return test page"
operationId: "getTestPage"
responses:
200:
description: "successful operation"
/reloadconfig:
get:
tags:
- "patrowl-engine"
summary: "Configuration reloading page"
description: "Reload the configuration file."
operationId: "reloadConfigurationPage"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
/info:
get:
tags:
- "patrowl-engine"
summary: "Engine info page"
description: "Return information on engine."
operationId: "getInfoPage"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
/clean:
get:
tags:
- "patrowl-engine"
summary: "Clean all scans"
description: "Clean all current scans."
operationId: "CleanScansPage"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
/clean/{scanId}:
get:
tags:
- "patrowl-engine"
summary: "Clean scan"
description: "Clean scan identified by id."
operationId: "CleanScanPage"
parameters:
- in: path
name: scanId
schema:
type: integer
required: true
description: Numeric ID of the scan to clean
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
/status:
get:
tags:
- "patrowl-engine"
summary: "Status on all scans"
description: "Status all current scans."
operationId: "StatusScansPage"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
/status/{scanId}:
get:
tags:
- "patrowl-engine"
summary: "Status of a scan"
description: "Status of a scan identified by id."
operationId: "StatusScanPage"
parameters:
- in: path
name: scanId
schema:
type: integer
required: true
description: Numeric ID of the scan to get status
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
/stopscans:
get:
tags:
- "patrowl-engine"
summary: "Stop all scans"
description: "Stop all current scans."
operationId: "StopScansPage"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
/stop/{scanId}:
get:
tags:
- "patrowl-engine"
summary: "Stop a scan"
description: "Stop a scan identified by id."
operationId: "StopScanPage"
parameters:
- in: path
name: scanId
schema:
type: integer
required: true
description: Numeric ID of the scan to stop
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
/getfindings/{scanId}:
get:
tags:
- "patrowl-engine"
summary: "Get findings on finished scans"
description: "Get findings on finished scans."
operationId: "GetFindingPage"
parameters:
- in: path
name: scanId
schema:
type: integer
required: true
description: Numeric ID of the scan to get findings
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: '#/components/schemas/Findings'
/startscan:
post:
tags:
- "patrowl-engine"
summary: "Start a new scan"
description: "Start a new scan."
operationId: "StartScanPage"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ScanDefinition'
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
components:
schemas:
ApiResponse:
properties:
status:
type: string
page:
type: string
Findings:
type: array
items:
type: object
properties:
issue_id:
type: integer
type:
type: string
title:
type: string
description:
type: string
solution:
type: string
severity:
type: string
enum: ["info", "low", "medium", "high"]
confidence:
type: string
raw:
type: string
target_addrs:
type: array
items:
type: string
target_proto:
type: array
items:
type: string
meta_links:
type: array
items:
type: string
meta_tags:
type: array
items:
type: string
meta_vuln_refs:
type: object
properties:
cve:
type: array
items:
type: string
cwe:
type: array
items:
type: string
cpe:
type: array
items:
type: string
bid:
type: array
items:
type: string
meta_risk:
type: object
properties:
cvss_vector:
type: array
items:
type: string
cvss_base_score:
type: array
items:
type: string
exploit_available:
type: array
items:
type: string
exploitability_ease:
type: array
items:
type: string
patch_publication_date:
type: array
items:
type: string
timestamp:
type: string
format: date-time
ScanDefinition:
properties:
scan_id:
type: integer
example: 1
options:
type: object
assets:
type: array
items:
type: object
properties:
id:
type: string
example: '3'
value:
type: string
example: '8.8.8.8'
criticity:
type: string
enum: ["low", "medium", "high"]
datatype:
type: string
enum: ["ip", "ip-range", "ip-subnet", "fqdn", "domain", "url", "keyword", "person", "organisation", "path", "application"]
externalDocs:
description: "Find out more about Patrowl"
url: "https://github.com/Patrowl/PatrowlDocs"