forked from koala73/worldmonitor
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCyberService.openapi.yaml
More file actions
280 lines (280 loc) · 12.4 KB
/
CyberService.openapi.yaml
File metadata and controls
280 lines (280 loc) · 12.4 KB
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
openapi: 3.1.0
info:
title: CyberService API
version: 1.0.0
paths:
/api/cyber/v1/list-cyber-threats:
get:
tags:
- CyberService
summary: ListCyberThreats
description: ListCyberThreats retrieves threat indicators from multiple intelligence sources.
operationId: ListCyberThreats
parameters:
- name: start
in: query
description: Start of time range (inclusive), Unix epoch milliseconds.
required: false
schema:
type: string
format: int64
- name: end
in: query
description: End of time range (inclusive), Unix epoch milliseconds.
required: false
schema:
type: string
format: int64
- name: page_size
in: query
description: Maximum items per page (1-100).
required: false
schema:
type: integer
format: int32
- name: cursor
in: query
description: Cursor for next page.
required: false
schema:
type: string
- name: type
in: query
description: Optional threat type filter.
required: false
schema:
type: string
- name: source
in: query
description: Optional source filter.
required: false
schema:
type: string
- name: min_severity
in: query
description: Optional minimum criticality filter.
required: false
schema:
type: string
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListCyberThreatsResponse'
"400":
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
type: object
properties:
message:
type: string
description: Error message (e.g., 'user not found', 'database connection failed')
description: Error is returned when a handler encounters an error. It contains a simple error message that the developer can customize.
FieldViolation:
type: object
properties:
field:
type: string
description: The field path that failed validation (e.g., 'user.email' for nested fields). For header validation, this will be the header name (e.g., 'X-API-Key')
description:
type: string
description: Human-readable description of the validation violation (e.g., 'must be a valid email address', 'required field missing')
required:
- field
- description
description: FieldViolation describes a single validation error for a specific field.
ValidationError:
type: object
properties:
violations:
type: array
items:
$ref: '#/components/schemas/FieldViolation'
description: List of validation violations
required:
- violations
description: ValidationError is returned when request validation fails. It contains a list of field violations describing what went wrong.
ListCyberThreatsRequest:
type: object
properties:
start:
type: integer
format: int64
description: 'Start of time range (inclusive), Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
end:
type: integer
format: int64
description: 'End of time range (inclusive), Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
pageSize:
type: integer
format: int32
description: Maximum items per page (1-100).
cursor:
type: string
description: Cursor for next page.
type:
type: string
enum:
- CYBER_THREAT_TYPE_UNSPECIFIED
- CYBER_THREAT_TYPE_C2_SERVER
- CYBER_THREAT_TYPE_MALWARE_HOST
- CYBER_THREAT_TYPE_PHISHING
- CYBER_THREAT_TYPE_MALICIOUS_URL
description: |-
CyberThreatType represents the classification of a cyber threat.
Maps to TS union: 'c2_server' | 'malware_host' | 'phishing' | 'malicious_url'.
source:
type: string
enum:
- CYBER_THREAT_SOURCE_UNSPECIFIED
- CYBER_THREAT_SOURCE_FEODO
- CYBER_THREAT_SOURCE_URLHAUS
- CYBER_THREAT_SOURCE_C2INTEL
- CYBER_THREAT_SOURCE_OTX
- CYBER_THREAT_SOURCE_ABUSEIPDB
description: |-
CyberThreatSource represents the intelligence source of a cyber threat.
Maps to TS union: 'feodo' | 'urlhaus' | 'c2intel' | 'otx' | 'abuseipdb'.
minSeverity:
type: string
enum:
- CRITICALITY_LEVEL_UNSPECIFIED
- CRITICALITY_LEVEL_LOW
- CRITICALITY_LEVEL_MEDIUM
- CRITICALITY_LEVEL_HIGH
- CRITICALITY_LEVEL_CRITICAL
description: |-
CriticalityLevel represents a four-tier criticality classification for cyber and risk domains.
Maps to existing TS union: 'low' | 'medium' | 'high' | 'critical'.
description: ListCyberThreatsRequest specifies filters for retrieving cyber threat indicators.
ListCyberThreatsResponse:
type: object
properties:
threats:
type: array
items:
$ref: '#/components/schemas/CyberThreat'
pagination:
$ref: '#/components/schemas/PaginationResponse'
description: ListCyberThreatsResponse contains cyber threats matching the request.
CyberThreat:
type: object
properties:
id:
type: string
minLength: 1
description: Unique threat identifier.
type:
type: string
enum:
- CYBER_THREAT_TYPE_UNSPECIFIED
- CYBER_THREAT_TYPE_C2_SERVER
- CYBER_THREAT_TYPE_MALWARE_HOST
- CYBER_THREAT_TYPE_PHISHING
- CYBER_THREAT_TYPE_MALICIOUS_URL
description: |-
CyberThreatType represents the classification of a cyber threat.
Maps to TS union: 'c2_server' | 'malware_host' | 'phishing' | 'malicious_url'.
source:
type: string
enum:
- CYBER_THREAT_SOURCE_UNSPECIFIED
- CYBER_THREAT_SOURCE_FEODO
- CYBER_THREAT_SOURCE_URLHAUS
- CYBER_THREAT_SOURCE_C2INTEL
- CYBER_THREAT_SOURCE_OTX
- CYBER_THREAT_SOURCE_ABUSEIPDB
description: |-
CyberThreatSource represents the intelligence source of a cyber threat.
Maps to TS union: 'feodo' | 'urlhaus' | 'c2intel' | 'otx' | 'abuseipdb'.
indicator:
type: string
description: Threat indicator value (IP, domain, or URL).
indicatorType:
type: string
enum:
- CYBER_THREAT_INDICATOR_TYPE_UNSPECIFIED
- CYBER_THREAT_INDICATOR_TYPE_IP
- CYBER_THREAT_INDICATOR_TYPE_DOMAIN
- CYBER_THREAT_INDICATOR_TYPE_URL
description: |-
CyberThreatIndicatorType represents the type of threat indicator.
Maps to TS union: 'ip' | 'domain' | 'url'.
location:
$ref: '#/components/schemas/GeoCoordinates'
country:
type: string
description: Country of origin (ISO 3166-1 alpha-2).
severity:
type: string
enum:
- CRITICALITY_LEVEL_UNSPECIFIED
- CRITICALITY_LEVEL_LOW
- CRITICALITY_LEVEL_MEDIUM
- CRITICALITY_LEVEL_HIGH
- CRITICALITY_LEVEL_CRITICAL
description: |-
CriticalityLevel represents a four-tier criticality classification for cyber and risk domains.
Maps to existing TS union: 'low' | 'medium' | 'high' | 'critical'.
malwareFamily:
type: string
description: Associated malware family, if known.
tags:
type: array
items:
type: string
description: Descriptive tags.
firstSeenAt:
type: integer
format: int64
description: 'First seen time, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
lastSeenAt:
type: integer
format: int64
description: 'Last seen time, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
required:
- id
description: |-
CyberThreat represents a cyber threat indicator aggregated from multiple sources.
Sources include Feodo Tracker, URLhaus, OTX, AbuseIPDB, and C2Intel.
GeoCoordinates:
type: object
properties:
latitude:
type: number
maximum: 90
minimum: -90
format: double
description: Latitude in decimal degrees (-90 to 90).
longitude:
type: number
maximum: 180
minimum: -180
format: double
description: Longitude in decimal degrees (-180 to 180).
description: GeoCoordinates represents a geographic location using WGS84 coordinates.
PaginationResponse:
type: object
properties:
nextCursor:
type: string
description: Cursor for fetching the next page. Empty string indicates no more pages.
totalCount:
type: integer
format: int32
description: Total count of items matching the query, if known. Zero if the total is unknown.
description: PaginationResponse contains pagination metadata returned alongside list results.