Skip to content

Commit c5f2bea

Browse files
xvaieraviau
xvaier
authored and
aviau
committed
events: main event types with example payloads
1 parent 13725a8 commit c5f2bea

File tree

20 files changed

+1910
-5
lines changed

20 files changed

+1910
-5
lines changed

‎docs/api-reference/v2/endpoints/activities/get-fireworkv2activities-.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ openapi: firework-v2-openapi get /firework/v2/activities/
33
title: Retrieve Event
44
---
55

6+
This response changes based on the event type, for more information the various possible responses, see
7+
[Event Types <Icon icon="book" size={16} />](/event-types/).
8+
69
<Note>
710
For backwards compatibility, this endpoint is also available as `/firework/v2/activities/{index}/{source}/{id}`.
811
</Note>

‎docs/changelog/overview.mdx‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ This page lists changes to Flare's API.
1212
Release notes for the Flare Platform can be found on the [product documentation website](https://docs.flare.io/releases).
1313
</Note>
1414

15+
<Update label="2025-10" description="API - October 2025">
16+
Added documentation for
17+
[Flare API Event Types <Icon icon="book" size={16} />](/event-types/overview).
18+
</Update>
19+
1520
<Update label="2025-08" description="API - August 2025">
1621
API endpoints using the `/leaksdb/` prefix were changed to `/astp/`.
1722
The old prefix remains available as an alias and there are no plans to deprecate it.
@@ -20,7 +25,7 @@ Release notes for the Flare Platform can be found on the [product documentation
2025
<Update label="2025-07" description="MCP - July 2025">
2126
Released the
2227
[Flare API Documentation MCP Server <Icon icon="book" size={16} />](/sdk/mcp).
23-
28+
2429
This is useful for developers building Flare API automations with AI-powered integrated development environments (IDE).
2530
</Update>
2631

@@ -46,7 +51,7 @@ Release notes for the Flare Platform can be found on the [product documentation
4651
</Update>
4752

4853
<Update label="2025-04" description="API - April 2025">
49-
Released a new version of the List All Credentials endpoint,
54+
Released a new version of the List All Credentials endpoint,
5055
[List All Credentials V2 <Icon icon="code" size={16} />](/api-reference/leaksdb/endpoints/get-credentials-v2),
5156
which supports the
5257
[Flare standard paging pattern <Icon icon="book" size={16} />](/concepts/paging).

‎docs/docs.json‎

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,33 @@
260260
}
261261
]
262262
},
263+
{
264+
"tab": "Event Types",
265+
"groups": [
266+
{
267+
"group": "Events",
268+
"pages": [
269+
"event-types/overview",
270+
"event-types/blog-post",
271+
"event-types/bucket-object",
272+
"event-types/bucket",
273+
"event-types/document",
274+
"event-types/domain",
275+
"event-types/experimental",
276+
"event-types/forum-post",
277+
"event-types/forum-topic",
278+
"event-types/google",
279+
"event-types/leak",
280+
"event-types/listing",
281+
"event-types/paste",
282+
"event-types/profile",
283+
"event-types/seller",
284+
"event-types/source-code",
285+
"event-types/stealer-log"
286+
]
287+
}
288+
]
289+
},
263290
{
264291
"tab": "Changelog",
265292
"groups": [
@@ -296,9 +323,7 @@
296323
"display": "interactive"
297324
},
298325
"mdx": {
299-
"server": [
300-
"http://api.flare.io/"
301-
],
326+
"server": ["http://api.flare.io/"],
302327
"auth": {
303328
"method": "bearer"
304329
}

‎docs/event-types/blog-post.mdx‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
title: "Blog Post"
3+
---
4+
5+
The `blog_post` type represents blog-style documents and text-based publications that have been discovered and indexed by Flare across document-sharing or content-hosting platforms such as Scribd, Medium, or public paste/document repositories.
6+
These records generally include technical manuals, guides, or articles that are accessible to the public, potentially containing sensitive, proprietary, or copyrighted materials.
7+
8+
```json Example Content
9+
{
10+
"id": "example-id-12345",
11+
"title": "Example Technical Document | PDF | Mechanical Part | Component Type",
12+
"description": "Example Product Line Full Description",
13+
"content": "Brief summary of the document contents",
14+
"url": "https://example.com/document/example-id-12345",
15+
"browser_url": "https://example.com/document/example-id-12345",
16+
"metadata": {
17+
"estimated_created_at": "2025-10-27T05:51:19.667458+00:00",
18+
"event_id": null,
19+
"first_crawled_at": "2025-10-27T05:51:19.667458+00:00",
20+
"last_crawled_at": "2025-10-27T05:51:19.667458+00:00",
21+
"payload_digest": "hashvalue123abc",
22+
"scraped_at": "2025-10-27T05:51:22.483346+00:00",
23+
"source": "example_source",
24+
"crawled_by": null,
25+
"flare_url": "https://app.flare.io/#/blog_post/scribd/example-id-12345"
26+
},
27+
"header": {
28+
"actor": "John Doe",
29+
"actor_id": null,
30+
"category_name": "",
31+
"content_hash": "hashvalue123abc",
32+
"content_preview": "Short excerpt from the document text",
33+
"country": null,
34+
"duplicates": [],
35+
"es_score": 1.0,
36+
"expiration": null,
37+
"highlights": {},
38+
"id": "example-id-12345",
39+
"parent_id": null,
40+
"parent_title": null,
41+
"parent_title_en": null,
42+
"parent_uid": null,
43+
"parent_uids": [],
44+
"risk": { "score": 2 },
45+
"similar_items_count": 0,
46+
"source": "example_source",
47+
"source_name": "Example Platform",
48+
"target_name": "Example Platform",
49+
"tags": [],
50+
"notes": null,
51+
"state_code": null,
52+
"timestamp": "2025-10-27T05:51:19.667458+00:00",
53+
"title": "Example Technical Document | PDF | Mechanical Part | Component Type",
54+
"type": "blog_post",
55+
"uid": "blog_post/example_source/example-id-12345",
56+
"user_risk_score": null,
57+
"user_notes": null,
58+
"ignored_at": null,
59+
"remediated_at": null,
60+
"verb": "posted",
61+
"external_url": null,
62+
"external_netloc": null,
63+
"can_have_duplicates": true,
64+
"priority_action_uuid_related": false,
65+
"victim_name": null,
66+
"contains_secrets": null,
67+
"secrets_metadata": null
68+
},
69+
"duplicates": [],
70+
"history_logs": null,
71+
"similar_items": []
72+
}
73+
74+
```

‎docs/event-types/bucket-object.mdx‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
---
2+
title: "Bucket Object"
3+
---
4+
5+
The `bucket_object` type represents individual files (objects) discovered within publicly exposed cloud storage buckets, such as those hosted on Amazon S3, Azure Blob Storage, or Google Cloud Storage.
6+
Each record identifies a single accessible object, typically containing metadata like its bucket location, provider, file path, and exposure source.
7+
8+
```json Example Content
9+
{
10+
"id": "example-id-67890",
11+
"title": "Example Bucket Object example-user@example.com.json",
12+
"content": null,
13+
"content_en": null,
14+
"url": null,
15+
"browser_url": null,
16+
"metadata": {
17+
"estimated_created_at": "2022-09-29T05:41:31.384630+00:00",
18+
"event_id": null,
19+
"first_crawled_at": "2022-09-29T05:41:31.384630+00:00",
20+
"last_crawled_at": "2022-10-03T01:32:45.841604+00:00",
21+
"payload_digest": null,
22+
"scraped_at": "2022-10-03T01:32:45.845075+00:00",
23+
"source": "example_source",
24+
"crawled_by": null,
25+
"flare_url": "https://app.flare.io/#/bucket_object/grayhat_warfare/example-id-67890"
26+
},
27+
"bucket": {
28+
"host": "example.blob.core.windows.net",
29+
"bucket_id": "example-bucket-id",
30+
"id": "azure/example-bucket-id",
31+
"provider": "azure"
32+
},
33+
"commit": {
34+
"author_email": null,
35+
"author_id": null,
36+
"author_name": null,
37+
"committer_email": null,
38+
"committer_id": null,
39+
"committer_name": null,
40+
"sha": null,
41+
"patch_url": null
42+
},
43+
"code": {
44+
"commit_name": null,
45+
"commit_date": null,
46+
"path": null,
47+
"commit_email": null
48+
},
49+
"drill_type": "bucket_object",
50+
"dork_name": null,
51+
"html_url": null,
52+
"is_secret_detection_rule_match": null,
53+
"issue": {
54+
"id": null,
55+
"state": null,
56+
"title": null,
57+
"tags": null,
58+
"assignee_id": null,
59+
"assignee_name": null
60+
},
61+
"project_name": null,
62+
"project": {
63+
"owner_name": null,
64+
"owner_id": null,
65+
"owner_type": null,
66+
"tags": null,
67+
"last_activity_at": null,
68+
"language": null,
69+
"followers_count": null,
70+
"forks_count": null,
71+
"is_fork": null
72+
},
73+
"resource_url": [
74+
"https://example.blob.core.windows.net/publiccontainer/Users/example-user@example.com.json"
75+
],
76+
"secret_detection_rule_id": null,
77+
"snippets": null,
78+
"user": {
79+
"email": null,
80+
"company": null,
81+
"full_name": null,
82+
"location": null,
83+
"followers_count": null
84+
},
85+
"features": {
86+
"domains": ["example.blob.core.windows.net"],
87+
"emails": null,
88+
"ip_addresses": null,
89+
"ip_addresses_cidr": null,
90+
"reversed_domains": ["net.windows.core.blob.example"],
91+
"urls": ["https://example.blob.core.windows.net/publiccontainer/Users/example-user@example.com.json"],
92+
"usernames": null,
93+
"vulnerabilities": null
94+
},
95+
"duplicates": [],
96+
"header": {
97+
"actor": "",
98+
"actor_id": null,
99+
"category_name": "Drill",
100+
"content_hash": "bucket_object/example_source/example-id-67890",
101+
"content_preview": "example-user@example.com.json on Azure at example.blob.core.windows.net",
102+
"country": null,
103+
"duplicates": [],
104+
"es_score": 1.0,
105+
"expiration": null,
106+
"highlights": {},
107+
"host": null,
108+
"id": "example-id-67890",
109+
"infection_date": null,
110+
"parent_id": null,
111+
"parent_title": null,
112+
"parent_title_en": null,
113+
"parent_uid": null,
114+
"parent_uids": [],
115+
"risk": { "score": 2 },
116+
"similar_items_count": 0,
117+
"source": "example_source",
118+
"source_name": "Example Source",
119+
"target_name": "Example Target",
120+
"tags": [],
121+
"notes": null,
122+
"state_code": null,
123+
"timestamp": "2022-09-29T05:41:31.384630+00:00",
124+
"title": "Example Bucket Object example-user@example.com.json",
125+
"type": "bucket_object",
126+
"uid": "bucket_object/example_source/example-id-67890",
127+
"user_risk_score": null,
128+
"user_notes": null,
129+
"ignored_at": null,
130+
"remediated_at": null,
131+
"verb": "pushed",
132+
"external_url": "https://example.blob.core.windows.net/publiccontainer/Users/example-user@example.com.json",
133+
"external_netloc": "example.blob.core.windows.net",
134+
"can_have_duplicates": true,
135+
"priority_action_uuid_related": false,
136+
"victim_name": null,
137+
"contains_secrets": false,
138+
"secrets_metadata": []
139+
},
140+
"history_logs": null,
141+
"similar_items": []
142+
}
143+
```

‎docs/event-types/bucket.mdx‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
title: "Bucket"
3+
---
4+
5+
The `bucket` type represents publicly exposed cloud storage containers, such as Amazon S3, Azure Blob, or Google Cloud Storage buckets.
6+
These records document information about misconfigured or accessible cloud storage endpoints, including domain names, providers, and discovered files.
7+
8+
```json Example Content
9+
{
10+
"id": "example-id-34567",
11+
"title": "Example Bucket example-bucket.s3.amazonaws.com on Aws",
12+
"url": null,
13+
"browser_url": null,
14+
"metadata": {
15+
"estimated_created_at": "2022-07-20T08:01:19.174392+00:00",
16+
"event_id": null,
17+
"first_crawled_at": "2022-07-20T08:01:19.174392+00:00",
18+
"last_crawled_at": "2022-08-15T04:24:18.493735+00:00",
19+
"payload_digest": null,
20+
"scraped_at": "2022-08-15T04:24:18.495069+00:00",
21+
"source": "example_source",
22+
"crawled_by": null,
23+
"flare_url": "https://app.flare.io/#/bucket/grayhat_warfare/example-id-34567"
24+
},
25+
"resource_url": "https://example-bucket.s3.amazonaws.com",
26+
"domain": "example-bucket.s3.amazonaws.com",
27+
"provider": "aws",
28+
"content_type": null,
29+
"file_count": 1,
30+
"files": [],
31+
"features": {
32+
"domains": ["example-bucket.s3.amazonaws.com"],
33+
"emails": null,
34+
"ip_addresses": null,
35+
"ip_addresses_cidr": null,
36+
"reversed_domains": ["com.amazonaws.s3.example-bucket"],
37+
"urls": null,
38+
"usernames": null,
39+
"vulnerabilities": null
40+
},
41+
"duplicates": [],
42+
"header": {
43+
"actor": "",
44+
"actor_id": null,
45+
"category_name": "aws",
46+
"content_hash": "bucket/example_source/example-id-34567",
47+
"content_preview": "",
48+
"country": null,
49+
"duplicates": [],
50+
"es_score": 1.0,
51+
"expiration": null,
52+
"highlights": {},
53+
"host": null,
54+
"id": "example-id-34567",
55+
"infection_date": null,
56+
"parent_id": null,
57+
"parent_title": null,
58+
"parent_title_en": null,
59+
"parent_uid": null,
60+
"parent_uids": [],
61+
"risk": { "score": 2 },
62+
"similar_items_count": 0,
63+
"source": "example_source",
64+
"source_name": "Example Source",
65+
"target_name": "Example Target",
66+
"tags": [],
67+
"notes": null,
68+
"state_code": null,
69+
"timestamp": "2022-07-20T08:01:19.174392+00:00",
70+
"title": "Example Bucket example-bucket.s3.amazonaws.com on Aws",
71+
"type": "bucket",
72+
"uid": "bucket/example_source/example-id-34567",
73+
"user_risk_score": null,
74+
"user_notes": null,
75+
"ignored_at": null,
76+
"remediated_at": null,
77+
"verb": "",
78+
"external_url": null,
79+
"external_netloc": null,
80+
"can_have_duplicates": true,
81+
"priority_action_uuid_related": false,
82+
"victim_name": null,
83+
"contains_secrets": null,
84+
"secrets_metadata": null
85+
},
86+
"history_logs": null,
87+
"similar_items": []
88+
}
89+
```

0 commit comments

Comments
 (0)