Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/api-reference/v4/endpoints/get-event.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Get Event V2 (Beta)"
title: "Retrieve Event V2 (Beta)"
openapi: firework-v4-openapi get /firework/v4/events/
---

Expand All @@ -10,5 +10,5 @@ import EventResponses from '/snippets/event_model_examples/events_overview.mdx'
</Panel>

<Note>
The Get Event V2 endpoint is still in beta and is subject to change.
The Retrieve Event V2 endpoint is still in beta and is subject to change.
</Note>
5 changes: 1 addition & 4 deletions docs/event-types-v2/bucket.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ title: "Bucket"
import BucketExample from '/snippets/event_model_examples/bucket.mdx'

The `bucket` type represents publicly exposed cloud storage containers, such as Amazon S3, Azure Blob, or Google Cloud Storage buckets.
These records document information about misconfigured or accessible cloud storage endpoints, including domain names, providers, and discovered files.

This type includes `bucket_object`, representing individual files (objects) discovered within publicly exposed cloud storage buckets.
Each record identifies a single accessible object, typically containing metadata like its bucket location, provider, file path, and exposure source.
These records document information about misconfigured or accessible cloud storage endpoints, including domain names and providers.

<BucketExample />
2 changes: 1 addition & 1 deletion docs/event-types-v2/forum-post.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ title: "Forum Post"
import ForumPostExample from '/snippets/event_model_examples/forum_post.mdx'

The `forum_post` type represents an individual message or reply made within a forum thread on an underground or hacker-oriented site.
Each record contains the message text, author alias, thread association, and metadata such as timestamps and extracted indicators (domains, emails, etc.).
Each record contains the message text, author alias, message context, and metadata such as timestamps.

<ForumPostExample />
2 changes: 1 addition & 1 deletion docs/event-types-v2/listing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ import ListingExample from '/snippets/event_model_examples/listing.mdx'

The `listing` type represents marketplace product advertisements sourced from dark web or illicit online markets.
Each record captures a single product post, including its title, description, seller information, price, and shipping regions.
Listings can refer to drugs, malware, guides, digital goods, counterfeit items, or stolen data, depending on the source market.
Listings can be classified as selling drugs, malware, guides, digital goods, counterfeit items, or stolen data, depending on the source market.

<ListingExample />
15 changes: 8 additions & 7 deletions docs/event-types-v2/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,21 @@ title: "Event Types V2 (Beta)"
description: "Overview of all Flare API event types"
---
<Note>
Event Types V2 is still in beta and is subject to change.
Event Types V2 are still in beta and are subject to change.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this say V2 Event Types? My english might not be the best

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think for sentence flow the version tends to come after the name, but like a lot of "rules" in english I have no idea if it's a real rule or it has just been more comfortable to say 👀

Example:
Product Plan V3
Wordpress V6.3.1
List All Credentials V2 <-- I found this one in the doc actually

</Note>

Currently these event type models are supported on the
[Retrieve Event V2 Endpoint <Icon icon="code" size={16}/>](/api-reference/v4/endpoints/get-event)

| Event Type | Documentation |
| --------------------------- | -------------------------------------------------------------------------------------------- |
| `blog_post` | [Blog Post <Icon icon="book" size={16} />](/event-types-v2/blog-post) |
| `bucket` | [Bucket <Icon icon="book" size={16} />](/event-types-v2/bucket) |
| `chat_message` | [Chat Message <Icon icon="book" size={16} />](/event-types-v2/chat-message) |
| `document` | [Ransomleak (document) <Icon icon="book" size={16} />](/event-types-v2/ransom-leak) |
| `domain` | [Lookalike Domain (domain) <Icon icon="book" size={16} />](/event-types-v2/domain) |
| `forum_post` | [Forum Post & Topic <Icon icon="book" size={16} />](/event-types-v2/forum-post) |
| `listing` | [Listing <Icon icon="book" size={16} />](/event-types-v2/listing) |
| `paste` | [Paste <Icon icon="book" size={16} />](/event-types-v2/paste) |
| `forum_post` | [Forum Post & Topic <Icon icon="book" size={16} />](/event-types-v2/forum-post) |
| `listing` | [Listing <Icon icon="book" size={16} />](/event-types-v2/listing) |
| `paste` | [Paste <Icon icon="book" size={16} />](/event-types-v2/paste) |
| `stealer_log` | [Stealer Log <Icon icon="book" size={16} />](/event-types-v2/stealer-log) |
| `social_media` | [Social media <Icon icon="book" size={16} />](/event-types-v2/social-media) |

Currently these event type models are supported on [get-event-v2](/api-reference/v4/endpoints/get-event)
| `social_media` | [Social media <Icon icon="book" size={16} />](/event-types-v2/social-media-account) |
1 change: 0 additions & 1 deletion docs/event-types-v2/ransom-leak.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ The `ransomleak` (or `document` subtype) represents a public leak post made by a
Each record corresponds to a specific victim organization whose exfiltrated data is published as part of extortion attempts.
These entries typically include:
- Victim details (company name, country, industry).
- Leak description and download links to stolen archives.
- Threat statements or ransom instructions.

<RansomLeakExample />
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "Social Media"
title: "Social Media Account"
---

import SocialMediaExample from '/snippets/event_model_examples/social_media_account.mdx'

The `social_media` type represents social media account that we find related to events
The `social_media` type represents social media accounts that we find related to events
that match identifiers.

<SocialMediaExample />