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/assign-policy.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Assign Policy (Beta)"
openapi: post /firework/v4/matching-policies/{policy_uuid}/assignments
openapi: firework-v4-openapi post /firework/v4/matching-policies/{policy_uuid}/assignments
title: Assign Policy (Beta)
---

import BetaEndpoint from '/snippets/beta-endpoint.mdx'
Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/v4/endpoints/create-identifier.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: "Create Identifier"
openapi: post /firework/v4/identifiers/
openapi: firework-v4-openapi post /firework/v4/identifiers/
title: Create Identifier
---
4 changes: 2 additions & 2 deletions docs/api-reference/v4/endpoints/create-matching-policy.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Create Matching Policy (Beta)"
openapi: post /firework/v4/matching-policies
openapi: firework-v4-openapi post /firework/v4/matching-policies
title: Create Matching Policy (Beta)
---

import BetaEndpoint from '/snippets/beta-endpoint.mdx'
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/v4/endpoints/delete-identifier.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
openapi: delete /firework/v4/identifiers/{identifier_id}
openapi: firework-v4-openapi delete /firework/v4/identifiers/{identifier_id}
---

<Note>
Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/v4/endpoints/delete-matching-policy.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Delete Matching Policy (Beta)"
openapi: delete /firework/v4/matching-policies/{policy_uuid}
openapi: firework-v4-openapi delete /firework/v4/matching-policies/{policy_uuid}
title: Delete Matching Policy (Beta)
---

import BetaEndpoint from '/snippets/beta-endpoint.mdx'
Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/v4/endpoints/get-matching-policy.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Retrieve Matching Policy (Beta)"
openapi: get /firework/v4/matching-policies/{policy_uuid}
openapi: firework-v4-openapi get /firework/v4/matching-policies/{policy_uuid}
title: Retrieve Matching Policy (Beta)
---

import BetaEndpoint from '/snippets/beta-endpoint.mdx'
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/v4/endpoints/list-identifiers.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: get /firework/v4/identifiers/
openapi: firework-v4-openapi get /firework/v4/identifiers/
---
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "List Matching Policies By Identifier Id (Beta)"
openapi: get /firework/v4/matching-policies/by_identifier_id/{identifier_id}
openapi: firework-v4-openapi get /firework/v4/matching-policies/by_identifier_id/{identifier_id}
title: List Matching Policies By Identifier Id (Beta)
---

import BetaEndpoint from '/snippets/beta-endpoint.mdx'
Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/v4/endpoints/list-matching-policies.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "List Matching Policies (Beta)"
openapi: get /firework/v4/matching-policies
openapi: firework-v4-openapi get /firework/v4/matching-policies
title: List Matching Policies (Beta)
---

import BetaEndpoint from '/snippets/beta-endpoint.mdx'
Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/v4/endpoints/list-policy-assignments.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "List Policy Assignments (Beta)"
openapi: get /firework/v4/matching-policies/{policy_uuid}/assignments
openapi: firework-v4-openapi get /firework/v4/matching-policies/{policy_uuid}/assignments
title: List Policy Assignments (Beta)
---

import BetaEndpoint from '/snippets/beta-endpoint.mdx'
Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/v4/endpoints/retrieve-identifier.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: "Retrieve Identifier"
openapi: get /firework/v4/identifiers/{identifier_id}
openapi: firework-v4-openapi get /firework/v4/identifiers/{identifier_id}
title: Retrieve Identifier
---
4 changes: 2 additions & 2 deletions docs/api-reference/v4/endpoints/unassign-policy.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Unassign Policy (Beta)"
openapi: delete /firework/v4/matching-policies/{policy_uuid}/assignments
openapi: firework-v4-openapi delete /firework/v4/matching-policies/{policy_uuid}/assignments
title: Unassign Policy (Beta)
---

import BetaEndpoint from '/snippets/beta-endpoint.mdx'
Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/v4/endpoints/update-identifier.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: "Update Identifier"
openapi: put /firework/v4/identifiers/{identifier_id}
openapi: firework-v4-openapi put /firework/v4/identifiers/{identifier_id}
title: Update Identifier
---
4 changes: 2 additions & 2 deletions docs/api-reference/v4/endpoints/update-matching-policy.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Update Matching Policy (Beta)"
openapi: put /firework/v4/matching-policies/{policy_uuid}
openapi: firework-v4-openapi put /firework/v4/matching-policies/{policy_uuid}
title: Update Matching Policy (Beta)
---

import BetaEndpoint from '/snippets/beta-endpoint.mdx'
Expand Down
29 changes: 14 additions & 15 deletions docs/event-types-v2/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,21 @@
title: "Event Types V2 (Beta)"
description: "Overview of all Flare API event types"
---
<Note>
Event Types V2 are still in beta and are subject to change.
</Note>

<Note>Event Types V2 are still in beta and are subject to change.</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) |
| `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-account) |
| 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) |
| `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-account) |
67 changes: 35 additions & 32 deletions docs/sdk/api-mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
title: "API MCP (beta)"
---

<Note>
The Flare API MCP server is still in beta and is subject to change.
</Note>
<Note>The Flare API MCP server is still in beta and is subject to change.</Note>

Flare provides a
[Model Context Protocol](https://modelcontextprotocol.io/) (MCP) server that
Expand All @@ -19,18 +17,17 @@ themselves), see the

## Available Tools

| Tool | Description |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `search_global` | Global Search — execute a Lucene query against the entire Flare threat-intel dataset. |
| `search_tenant` | Tenant Search — execute a Lucene query scoped to events matching the caller's monitored identifiers. |
| `search_validate_search_query` | Validate that a Lucene query complies with Flare's search rules before running it. Useful when composing or debugging a query. |
| `events_get_event_type` | Return the documentation and searchable field list for a given event type (e.g. `chat_message`, `forum_post`, `stealer_log`). |
| `profile_get` | Return the current user's profile, including tenants, permissions, feature flags, and default tenant id. |

| Tool | Description |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `search_global` | Global Search — executes a Lucene query against the entire Flare threat-intel dataset. |
| `search_tenant` | Tenant Search — executes a Lucene query scoped to events matching the caller's monitored identifiers. |
| `search_validate_search_query` | Validates that a Lucene query complies with Flare's search rules before running it. Useful when composing or debugging a query. |
| `events_get_event` | Returns the complete event payload (metadata + data) for a single uid. |
| `events_get_event_type` | Returns the documentation and searchable field list for a given event type (e.g. `chat_message`, `forum_post`, `stealer_log`). |
| `profile_get` | Returns the current user's profile, including tenants, permissions, feature flags, and default tenant id. |

<Note>
`search_global` requires the Global Search permission on the target
tenant.
`search_global` requires the Global Search permission on the target tenant.
</Note>

### Search Parameters
Expand Down Expand Up @@ -89,12 +86,13 @@ Requests default to your account's default tenant. To scope MCP tool calls
to a specific tenant, set the `X-Flare-Tenant-Id` header on the MCP
connection to the target tenant id. You can find your tenant ids via the `profile_get` MCP tool, or on the [Profile page](https://app.flare.io/#/profile) under the "Tenants" section
(also documented in the
[Authentication Guide <Icon icon="book" size={16} />](/concepts/authentication#finding-tenant-ids)).
[Authentication Guide <Icon icon="book" size={16} />](/concepts/authentication#finding-tenant-ids)).

## Client Setup

<Note>
The `X-Flare-Tenant-Id` header is optional: omitting it uses your default tenant.
The `X-Flare-Tenant-Id` header is optional: omitting it uses your default
tenant.
</Note>

### Claude Code
Expand All @@ -108,6 +106,7 @@ claude mcp add flare --transport http https://api.flare.io/mcp \
--header "Authorization: <api-key>" \
--header "X-Flare-Tenant-Id: <tenant-id>"
```

The Flare API key is obtained from the
[Authentication Guide <Icon icon="book" size={16} />](/concepts/authentication).

Expand All @@ -134,9 +133,9 @@ under the `flare` server in the `/mcp` command output, and Claude will call
them automatically when your prompts match their descriptions.

<Note>
Store the API key outside version control. Claude Code also supports
reading headers from environment variables — see the
[Claude Code MCP docs](https://code.claude.com/docs/en/mcp#environment-variable-expansion-in-mcp-json)
Store the API key outside version control. Claude Code also supports reading
headers from environment variables — see the [Claude Code MCP
docs](https://code.claude.com/docs/en/mcp#environment-variable-expansion-in-mcp-json)
for details.
</Note>

Expand Down Expand Up @@ -168,26 +167,30 @@ The file is also reachable through **Settings → Developer → Edit Config**.
}
}
```

Once the change is in place, you should fully quit and relaunch Claude Desktop.

### Cursor
The server can be added to the `.cursor/mcp.json` in your project (or
`~/.cursor/mcp.json` to make it available in all projects).
```json .cursor/mcp.json
{
"mcpServers": {
"flare": {
"url": "https://api.flare.io/mcp",
"headers": {
"Authorization": "<api-key>",
"X-Flare-Tenant-Id": "<tenant-id>"
}

The server can be added to the `.cursor/mcp.json` in your project (or
`~/.cursor/mcp.json` to make it available in all projects).

```json .cursor/mcp.json
{
"mcpServers": {
"flare": {
"url": "https://api.flare.io/mcp",
"headers": {
"Authorization": "<api-key>",
"X-Flare-Tenant-Id": "<tenant-id>"
}
}
}
```
Cursor picks up the change automatically: check **Settings → MCP** to confirm the MCP server is connected.
See [Cursor's MCP docs](https://cursor.com/docs/mcp) for details.
}
```

Cursor picks up the change automatically: check **Settings → MCP** to confirm the MCP server is connected.
See [Cursor's MCP docs](https://cursor.com/docs/mcp) for details.

## Quotas & Rate Limits

Expand Down
1 change: 1 addition & 0 deletions scripts/openapi-post-process.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

from typing import Any


HTTP_METHODS = {"get", "put", "post", "delete", "options", "head", "patch", "trace"}


Expand Down
Loading