Skip to content

Commit e7d0414

Browse files
gpratte-flaregpratte-flare
authored
Merge pull request #132 from jenip13/remove-identifiers-from-global-search-response
Remove identifiers from global search response
2 parents c1f8730 + 3ba311f commit e7d0414

File tree

2 files changed

+244
-2
lines changed

2 files changed

+244
-2
lines changed

‎docs/api-reference/v4/endpoints/global-search.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ api: "POST https://api.flare.io/firework/v4/events/global/_search"
44
authMethod: "bearer"
55
---
66

7-
import EventSearchCommon from '/snippets/endpoint-event-search-common.mdx';
7+
import GlobalSearchEvent from '/snippets/endpoint-global-search-event.mdx';
88
import GlobalSearchApiQuotaNote from '/snippets/global-search-api-quota-note.mdx';
99

1010
<GlobalSearchApiQuotaNote />
@@ -14,4 +14,4 @@ import GlobalSearchApiQuotaNote from '/snippets/global-search-api-quota-note.mdx
1414
See the guide for using this endpoint:
1515
[Search in All of Flare's Events <Icon icon="book" size={16} />](/guides/global-search).
1616

17-
<EventSearchCommon />
17+
<GlobalSearchEvent />

‎docs/snippets/endpoint-global-search-event.mdx‎

Lines changed: 242 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,242 @@
1+
<ResponseExample>
2+
3+
```json Response Example
4+
{
5+
"items": [
6+
{
7+
"metadata": {
8+
"estimated_created_at": "2019-09-20T16:30:37.589388Z",
9+
"matched_at": "2019-09-21T10:15:22.123456Z",
10+
"type": "listing",
11+
"uid": "listing/apollon_market/9861",
12+
"severity": "critical"
13+
},
14+
"tenant_metadata": {
15+
"severity": {
16+
"original": "low",
17+
"override": "critical"
18+
},
19+
"tags": [
20+
"important",
21+
],
22+
"notes": "This reason why this is tagged as 'important' is: ..."
23+
},
24+
"highlights": {
25+
"description": [
26+
"Bank Statement PSD <mark>Template</mark>\r\n\r\nWe promise:\r\n- Your order will be delivered instantly."
27+
],
28+
"title": [
29+
"Bank Statement PSD <mark>Template</mark>"
30+
]
31+
}
32+
}
33+
],
34+
"next": "WzE1Njg5OTcwMzc1ODksICJsaXN0aW5nL2Fwb2xsb25fbWFya2V0Lzk4NjEiXQ%3D%3D"
35+
}
36+
```
37+
38+
</ResponseExample>
39+
40+
## Paging
41+
42+
This endpoint supports the
43+
[Flare standard paging pattern <Icon icon="book" size={16} />](/concepts/paging).
44+
45+
## Body Parameters
46+
47+
<ParamField body="query" type="object">
48+
One of the supported queries. {queryComment}
49+
<CodeGroup>
50+
```json Domain
51+
{
52+
"type": "domain",
53+
"fqdn": "<string>"
54+
}
55+
```
56+
```json Email
57+
{
58+
"type": "email",
59+
"email": "<string>"
60+
}
61+
```
62+
```json Keyword
63+
{
64+
"type": "keyword",
65+
"keyword": "<string>"
66+
}
67+
```
68+
```json Query String
69+
{
70+
"type": "query_string",
71+
"query_string": "<string>"
72+
}
73+
```
74+
```json Username
75+
{
76+
"type": "username",
77+
"username": "<string>"
78+
}
79+
```
80+
```json GitHub Repository
81+
{
82+
"type": "github_repository",
83+
"repo_owner": "<string>"
84+
"repo_name": "<string>"
85+
}
86+
```
87+
```json Brand
88+
{
89+
"type": "brand",
90+
"name": "<string>"
91+
}
92+
```
93+
```json Name
94+
{
95+
"type": "name",
96+
"first_name": "<string>"
97+
"last_name": "<string>"
98+
"is_strict": "<boolean>"
99+
}
100+
```
101+
```json CC Bin
102+
{
103+
"type": "bin",
104+
"bin": "<string>"
105+
}
106+
```
107+
```json IP
108+
{
109+
"type": "ip",
110+
"ip": "<string>"
111+
}
112+
```
113+
```json Credentials
114+
{
115+
"type": "credentials",
116+
"username": "<string>"
117+
"password": "<string>"
118+
}
119+
```
120+
```json Secret
121+
{
122+
"type": "secret",
123+
"secret": "<string>"
124+
}
125+
```
126+
```json Azure Tenant
127+
{
128+
"type": "azure_tenant",
129+
"tenant_id": "<string>"
130+
}
131+
```
132+
</CodeGroup>
133+
</ParamField>
134+
135+
<ParamField body="size" type="number" initialValue="1">
136+
Limit number of events that will be returned. (Max 10)
137+
</ParamField>
138+
139+
<ParamField body="from" type="string">
140+
The `next` value from the last response.
141+
</ParamField>
142+
143+
<ParamField body="order" type="string" default="desc">
144+
The order in which the results will be returned.
145+
146+
<Expandable title="valid order values">
147+
`asc`
148+
`desc`
149+
</Expandable>
150+
</ParamField>
151+
152+
<ParamField body="filters" type="object">
153+
<Expandable defaultOpen>
154+
<ParamField body="severity" type="string[]">
155+
If a string value is specified, results will contain events that have a greater than or equal severity. Otherwise, if an array of severities is specified, results will only contain events that exactly match one of them.
156+
157+
<Expandable title="valid severity values">
158+
`info`
159+
`low`
160+
`medium`
161+
`high`
162+
`critical`
163+
</Expandable>
164+
</ParamField>
165+
166+
<ParamField body="type" type="string[]">
167+
<Expandable title="valid type values">
168+
`illicit_networks`
169+
`open_web`
170+
`leak`
171+
`domain`
172+
`listing`
173+
`forum_content`
174+
`blog_content`
175+
`blog_post`
176+
`profile`
177+
`chat_message`
178+
`ransomleak`
179+
`infected_devices`
180+
`financial_data`
181+
`bot`
182+
`stealer_log`
183+
`paste`
184+
`social_media`
185+
`source_code`
186+
`source_code_files`
187+
`stack_exchange`
188+
`google`
189+
`service`
190+
`buckets`
191+
`bucket`
192+
`bucket_object`
193+
</Expandable>
194+
195+
Learn more about [Event Source Filters <Icon icon="book" size={16} />](/advanced/event-source-filters).
196+
</ParamField>
197+
198+
<ParamField body="estimated_created_at" type="object">
199+
<Expandable>
200+
<ParamField
201+
body="gt"
202+
type="string"
203+
placeholder="Example: 2024-01-01T00:00:00+00:00"
204+
>
205+
Matches values greater than the specified timestamp.
206+
207+
Format: ISO-8601
208+
</ParamField>
209+
210+
<ParamField
211+
body="gte"
212+
type="string"
213+
placeholder="Example: 2024-01-01T00:00:00+00:00"
214+
>
215+
Matches values greater than or equal to the specified timestamp.
216+
217+
Format: ISO-8601
218+
</ParamField>
219+
220+
<ParamField
221+
body="lt"
222+
type="string"
223+
placeholder="Example: 2024-01-01T00:00:00+00:00"
224+
>
225+
Matches values lesser than the specified timestamp.
226+
227+
Format: ISO-8601
228+
</ParamField>
229+
230+
<ParamField
231+
body="lte"
232+
type="string"
233+
placeholder="Example: 2024-01-01T00:00:00+00:00"
234+
>
235+
Matches values lesser than or equal to the specified timestamp.
236+
237+
Format: ISO-8601
238+
</ParamField>
239+
</Expandable>
240+
</ParamField>
241+
</Expandable>
242+
</ParamField>

0 commit comments

Comments
 (0)