diff --git a/docs/api-reference/v4/endpoints/current-tenant-feed.mdx b/docs/api-reference/v4/endpoints/current-tenant-feed.mdx index eed533a..6c60b19 100644 --- a/docs/api-reference/v4/endpoints/current-tenant-feed.mdx +++ b/docs/api-reference/v4/endpoints/current-tenant-feed.mdx @@ -3,257 +3,13 @@ title: "List Tenant Events" api: "POST https://api.flare.io/firework/v4/events/tenant/_search" --- -Returns a list of events matching the identifiers of the current tenant. - - - -```json Response Example -{ - "items": [ - { - "metadata": { - "estimated_created_at": "2019-09-20T16:30:37.589388Z", - "type": "listing", - "uid": "listing/apollon_market/9861", - "severity": "critical" - }, - "tenant_metadata": { - "severity": { - "original": "low", - "override": "critical" - }, - "tags": [ - "important", - ], - "notes": "This reason why this is tagged as 'important' is: ..." - }, - "identifiers": [ - { - "id": 1, - "name": "An identifier" - } - ], - "highlights": { - "description": [ - "Bank Statement PSD Template\r\n\r\nWe promise:\r\n- Your order will be delivered instantly." - ], - "title": [ - "Bank Statement PSD Template" - ] - } - } - ], - "next": "WzE1Njg5OTcwMzc1ODksICJsaXN0aW5nL2Fwb2xsb25fbWFya2V0Lzk4NjEiXQ%3D%3D" -} -``` +import EventSearchCommon from '/snippets/endpoint-event-search-common.mdx'; - - -## Paging - -This endpoint supports the -[Flare standard paging pattern ](/concepts/paging). +Returns a list of events matching the identifiers of the current tenant. ## Guides See the guide for using this endpoint: [Exporting a Tenant's Events ](/guides/tenant-events). -## Body Parameters - - - One of the supported queries. - - ```json Domain - { - "type": "domain", - "fqdn": "" - } - ``` - ```json Email - { - "type": "email", - "email": "" - } - ``` - ```json Keyword - { - "type": "keyword", - "keyword": "" - } - ``` - ```json Query String - { - "type": "query_string", - "query_string": "" - } - ``` - ```json Username - { - "type": "username", - "username": "" - } - ``` - ```json GitHub Repository - { - "type": "github_repository", - "repo_owner": "" - "repo_name": "" - } - ``` - ```json Brand - { - "type": "brand", - "name": "" - } - ``` - ```json Name - { - "type": "name", - "first_name": "" - "last_name": "" - "is_strict": "" - } - ``` - ```json CC Bin - { - "type": "bin", - "bin": "" - } - ``` - ```json IP - { - "type": "ip", - "ip": "" - } - ``` - ```json Credentials - { - "type": "credentials", - "username": "" - "password": "" - } - ``` - ```json Secret - { - "type": "secret", - "secret": "" - } - ``` - ```json Azure Tenant - { - "type": "azure_tenant", - "tenant_id": "" - } - ``` - - - - - Limit number of events that will be returned. - - - - The `next` value from the last response. - - - - The order in which the results will be returned. - - - `asc` - `desc` - - - - - - - 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. - - - `info` - `low` - `medium` - `high` - `critical` - - - - - - `illicit_networks` - `open_web` - `leak` - `domain` - `listing` - `forum_content` - `blog_content` - `blog_post` - `profile` - `chat_message` - `ransomleak` - `infected_devices` - `financial_data` - `bot` - `stealer_log` - `paste` - `social_media` - `source_code` - `source_code_files` - `stack_exchange` - `google` - `service` - `buckets` - `bucket` - `bucket_object` - - - Learn more about [Event Source Filters ](/advanced/event-source-filters). - - - - - - Matches values greater than the specified timestamp. - - Format: ISO-8601 - - - - Matches values greater than or equal to the specified timestamp. - - Format: ISO-8601 - - - - Matches values lesser than the specified timestamp. - - Format: ISO-8601 - - - - Matches values lesser than or equal to the specified timestamp. - - Format: ISO-8601 - - - - - + diff --git a/docs/api-reference/v4/endpoints/global-search.mdx b/docs/api-reference/v4/endpoints/global-search.mdx index 789e35d..c6b4499 100644 --- a/docs/api-reference/v4/endpoints/global-search.mdx +++ b/docs/api-reference/v4/endpoints/global-search.mdx @@ -3,255 +3,6 @@ title: "Search (new)" api: "POST https://api.flare.io/firework/v4/events/global/_search" --- - +import EventSearchCommon from '/snippets/endpoint-event-search-common.mdx'; -```json Response Example -{ - "items": [ - { - "metadata": { - "estimated_created_at": "2019-09-20T16:30:37.589388Z", - "type": "listing", - "uid": "listing/apollon_market/9861", - "severity": "critical" - }, - "tenant_metadata": { - "severity": { - "original": "low", - "override": "critical" - }, - "tags": [ - "important", - ], - "notes": "This reason why this is tagged as 'important' is: ..." - }, - "identifiers": [ - { - "id": 1, - "name": "An identifier" - } - ], - "highlights": { - "description": [ - "Bank Statement PSD Template\r\n\r\nWe promise:\r\n- Your order will be delivered instantly." - ], - "title": [ - "Bank Statement PSD Template" - ] - } - } - ], - "next": "WzE1Njg5OTcwMzc1ODksICJsaXN0aW5nL2Fwb2xsb25fbWFya2V0Lzk4NjEiXQ%3D%3D" -} -``` - - - -## Paging - -This endpoint supports the -[Flare standard paging pattern ](/concepts/paging). - -## Guides - -See the guide for using this endpoint: -[Search in All of Flare's Events ](/guides/global-search). - -## Body Parameters - - - One of the supported queries. - - ```json Domain - { - "type": "domain", - "fqdn": "" - } - ``` - ```json Email - { - "type": "email", - "email": "" - } - ``` - ```json Keyword - { - "type": "keyword", - "keyword": "" - } - ``` - ```json Query String - { - "type": "query_string", - "query_string": "" - } - ``` - ```json Username - { - "type": "username", - "username": "" - } - ``` - ```json GitHub Repository - { - "type": "github_repository", - "repo_owner": "" - "repo_name": "" - } - ``` - ```json Brand - { - "type": "brand", - "name": "" - } - ``` - ```json Name - { - "type": "name", - "first_name": "" - "last_name": "" - "is_strict": "" - } - ``` - ```json CC Bin - { - "type": "bin", - "bin": "" - } - ``` - ```json IP - { - "type": "ip", - "ip": "" - } - ``` - ```json Credentials - { - "type": "credentials", - "username": "" - "password": "" - } - ``` - ```json Secret - { - "type": "secret", - "secret": "" - } - ``` - ```json Azure Tenant - { - "type": "azure_tenant", - "tenant_id": "" - } - ``` - - - - - Limit number of events that will be returned. - - - - The `next` value from the last response. - - - - The order in which the results will be returned. - - - `asc` - `desc` - - - - - - - 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. - - - `info` - `low` - `medium` - `high` - `critical` - - - - - - `illicit_networks` - `open_web` - `leak` - `domain` - `listing` - `forum_content` - `blog_content` - `blog_post` - `profile` - `chat_message` - `ransomleak` - `infected_devices` - `financial_data` - `bot` - `stealer_log` - `paste` - `social_media` - `source_code` - `source_code_files` - `stack_exchange` - `google` - `service` - `buckets` - `bucket` - `bucket_object` - - - Learn more about [Event Source Filters ](/advanced/event-source-filters). - - - - - - Matches values greater than the specified timestamp. - - Format: ISO-8601 - - - - Matches values greater than or equal to the specified timestamp. - - Format: ISO-8601 - - - - Matches values lesser than the specified timestamp. - - Format: ISO-8601 - - - - Matches values lesser than or equal to the specified timestamp. - - Format: ISO-8601 - - - - - + diff --git a/docs/api-reference/v4/endpoints/identifier-feed.mdx b/docs/api-reference/v4/endpoints/identifier-feed.mdx index e0b96d8..af101d9 100644 --- a/docs/api-reference/v4/endpoints/identifier-feed.mdx +++ b/docs/api-reference/v4/endpoints/identifier-feed.mdx @@ -3,263 +3,13 @@ title: "List Identifier Events" api: "POST https://api.flare.io/firework/v4/events/identifiers/{identifier_id}/_search" --- -Returns a list of events matching an identifier. - - - -```json Response Example -{ - "items": [ - { - "metadata": { - "estimated_created_at": "2019-09-20T16:30:37.589388Z", - "type": "listing", - "uid": "listing/apollon_market/9861", - "severity": "critical" - }, - "tenant_metadata": { - "severity": { - "original": "low", - "override": "critical" - }, - "tags": [ - "important", - ], - "notes": "This reason why this is tagged as 'important' is: ..." - }, - "identifiers": [ - { - "id": 1, - "name": "An identifier" - } - ], - "highlights": { - "description": [ - "Bank Statement PSD Template\r\n\r\nWe promise:\r\n- Your order will be delivered instantly." - ], - "title": [ - "Bank Statement PSD Template" - ] - } - } - ], - "next": "WzE1Njg5OTcwMzc1ODksICJsaXN0aW5nL2Fwb2xsb25fbWFya2V0Lzk4NjEiXQ%3D%3D" -} -``` - - +import EventSearchCommon from '/snippets/endpoint-event-search-common.mdx'; -## Paging - -This endpoint supports the -[Flare standard paging pattern ](/concepts/paging). +Returns a list of events matching an identifier. ## Guides See the guide for using this endpoint: [Exporting a Tenant's Events ](/guides/tenant-events). -## Path Parameters - - -The ID of the identifier that the events have matched on. - - -## Body Parameters - - - One of the supported queries. - - ```json Domain - { - "type": "domain", - "fqdn": "" - } - ``` - ```json Email - { - "type": "email", - "email": "" - } - ``` - ```json Keyword - { - "type": "keyword", - "keyword": "" - } - ``` - ```json Query String - { - "type": "query_string", - "query_string": "" - } - ``` - ```json Username - { - "type": "username", - "username": "" - } - ``` - ```json GitHub Repository - { - "type": "github_repository", - "repo_owner": "" - "repo_name": "" - } - ``` - ```json Brand - { - "type": "brand", - "name": "" - } - ``` - ```json Name - { - "type": "name", - "first_name": "" - "last_name": "" - "is_strict": "" - } - ``` - ```json CC Bin - { - "type": "bin", - "bin": "" - } - ``` - ```json IP - { - "type": "ip", - "ip": "" - } - ``` - ```json Credentials - { - "type": "credentials", - "username": "" - "password": "" - } - ``` - ```json Secret - { - "type": "secret", - "secret": "" - } - ``` - ```json Azure Tenant - { - "type": "azure_tenant", - "tenant_id": "" - } - ``` - - - - - Limit number of events that will be returned. - - - - The `next` value from the last response. - - - - The order in which the results will be returned. - - - `asc` - `desc` - - - - - - - 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. - - - `info` - `low` - `medium` - `high` - `critical` - - - - - - `illicit_networks` - `open_web` - `leak` - `domain` - `listing` - `forum_content` - `blog_content` - `blog_post` - `profile` - `chat_message` - `ransomleak` - `infected_devices` - `financial_data` - `bot` - `stealer_log` - `paste` - `social_media` - `source_code` - `source_code_files` - `stack_exchange` - `google` - `service` - `buckets` - `bucket` - `bucket_object` - - - Learn more about [Event Source Filters ](/advanced/event-source-filters). - - - - - - Matches values greater than the specified timestamp. - - Format: ISO-8601 - - - - Matches values greater than or equal to the specified timestamp. - - Format: ISO-8601 - - - - Matches values lesser than the specified timestamp. - - Format: ISO-8601 - - - - Matches values lesser than or equal to the specified timestamp. - - Format: ISO-8601 - - - - - + diff --git a/docs/api-reference/v4/endpoints/identifier-group-feed.mdx b/docs/api-reference/v4/endpoints/identifier-group-feed.mdx index 52da928..9392d34 100644 --- a/docs/api-reference/v4/endpoints/identifier-group-feed.mdx +++ b/docs/api-reference/v4/endpoints/identifier-group-feed.mdx @@ -3,263 +3,13 @@ title: "List Identifier Group's Events" api: "POST https://api.flare.io/firework/v4/events/identifier_groups/{identifier_group_id}/_search" --- -Returns a list of events matching the identifiers of an identifier group. - - - -```json Response Example -{ - "items": [ - { - "metadata": { - "estimated_created_at": "2019-09-20T16:30:37.589388Z", - "type": "listing", - "uid": "listing/apollon_market/9861", - "severity": "critical" - }, - "tenant_metadata": { - "severity": { - "original": "low", - "override": "critical" - }, - "tags": [ - "important", - ], - "notes": "This reason why this is tagged as 'important' is: ..." - }, - "identifiers": [ - { - "id": 1, - "name": "An identifier" - } - ], - "highlights": { - "description": [ - "Bank Statement PSD Template\r\n\r\nWe promise:\r\n- Your order will be delivered instantly." - ], - "title": [ - "Bank Statement PSD Template" - ] - } - } - ], - "next": "WzE1Njg5OTcwMzc1ODksICJsaXN0aW5nL2Fwb2xsb25fbWFya2V0Lzk4NjEiXQ%3D%3D" -} -``` - - +import EventSearchCommon from '/snippets/endpoint-event-search-common.mdx'; -## Paging - -This endpoint supports the -[Flare standard paging pattern ](/concepts/paging). +Returns a list of events matching the identifiers of an identifier group. ## Guides See the guide for using this endpoint: [Exporting a Tenant's Events ](/guides/tenant-events). -## Path Parameters - - -The ID of the identifier group that the events have matched on. - - -## Body Parameters - - - One of the supported queries. - - ```json Domain - { - "type": "domain", - "fqdn": "" - } - ``` - ```json Email - { - "type": "email", - "email": "" - } - ``` - ```json Keyword - { - "type": "keyword", - "keyword": "" - } - ``` - ```json Query String - { - "type": "query_string", - "query_string": "" - } - ``` - ```json Username - { - "type": "username", - "username": "" - } - ``` - ```json GitHub Repository - { - "type": "github_repository", - "repo_owner": "" - "repo_name": "" - } - ``` - ```json Brand - { - "type": "brand", - "name": "" - } - ``` - ```json Name - { - "type": "name", - "first_name": "" - "last_name": "" - "is_strict": "" - } - ``` - ```json CC Bin - { - "type": "bin", - "bin": "" - } - ``` - ```json IP - { - "type": "ip", - "ip": "" - } - ``` - ```json Credentials - { - "type": "credentials", - "username": "" - "password": "" - } - ``` - ```json Secret - { - "type": "secret", - "secret": "" - } - ``` - ```json Azure Tenant - { - "type": "azure_tenant", - "tenant_id": "" - } - ``` - - - - - Limit number of events that will be returned. - - - - The `next` value from the last response. - - - - The order in which the results will be returned. - - - `asc` - `desc` - - - - - - - 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. - - - `info` - `low` - `medium` - `high` - `critical` - - - - - - `illicit_networks` - `open_web` - `leak` - `domain` - `listing` - `forum_content` - `blog_content` - `blog_post` - `profile` - `chat_message` - `ransomleak` - `infected_devices` - `financial_data` - `bot` - `stealer_log` - `paste` - `social_media` - `source_code` - `source_code_files` - `stack_exchange` - `google` - `service` - `buckets` - `bucket` - `bucket_object` - - - Learn more about [Event Source Filters ](/advanced/event-source-filters). - - - - - - Matches values greater than the specified timestamp. - - Format: ISO-8601 - - - - Matches values greater than or equal to the specified timestamp. - - Format: ISO-8601 - - - - Matches values lesser than the specified timestamp. - - Format: ISO-8601 - - - - Matches values lesser than or equal to the specified timestamp. - - Format: ISO-8601 - - - - - + diff --git a/docs/snippets/endpoint-event-search-common.mdx b/docs/snippets/endpoint-event-search-common.mdx new file mode 100644 index 0000000..a5e7002 --- /dev/null +++ b/docs/snippets/endpoint-event-search-common.mdx @@ -0,0 +1,247 @@ + + +```json Response Example +{ + "items": [ + { + "metadata": { + "estimated_created_at": "2019-09-20T16:30:37.589388Z", + "type": "listing", + "uid": "listing/apollon_market/9861", + "severity": "critical" + }, + "tenant_metadata": { + "severity": { + "original": "low", + "override": "critical" + }, + "tags": [ + "important", + ], + "notes": "This reason why this is tagged as 'important' is: ..." + }, + "identifiers": [ + { + "id": 1, + "name": "An identifier" + } + ], + "highlights": { + "description": [ + "Bank Statement PSD Template\r\n\r\nWe promise:\r\n- Your order will be delivered instantly." + ], + "title": [ + "Bank Statement PSD Template" + ] + } + } + ], + "next": "WzE1Njg5OTcwMzc1ODksICJsaXN0aW5nL2Fwb2xsb25fbWFya2V0Lzk4NjEiXQ%3D%3D" +} +``` + + + +## Paging + +This endpoint supports the +[Flare standard paging pattern ](/concepts/paging). + +## Body Parameters + + + One of the supported queries. + + ```json Domain + { + "type": "domain", + "fqdn": "" + } + ``` + ```json Email + { + "type": "email", + "email": "" + } + ``` + ```json Keyword + { + "type": "keyword", + "keyword": "" + } + ``` + ```json Query String + { + "type": "query_string", + "query_string": "" + } + ``` + ```json Username + { + "type": "username", + "username": "" + } + ``` + ```json GitHub Repository + { + "type": "github_repository", + "repo_owner": "" + "repo_name": "" + } + ``` + ```json Brand + { + "type": "brand", + "name": "" + } + ``` + ```json Name + { + "type": "name", + "first_name": "" + "last_name": "" + "is_strict": "" + } + ``` + ```json CC Bin + { + "type": "bin", + "bin": "" + } + ``` + ```json IP + { + "type": "ip", + "ip": "" + } + ``` + ```json Credentials + { + "type": "credentials", + "username": "" + "password": "" + } + ``` + ```json Secret + { + "type": "secret", + "secret": "" + } + ``` + ```json Azure Tenant + { + "type": "azure_tenant", + "tenant_id": "" + } + ``` + + + + + Limit number of events that will be returned. + + + + The `next` value from the last response. + + + + The order in which the results will be returned. + + + `asc` + `desc` + + + + + + + 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. + + + `info` + `low` + `medium` + `high` + `critical` + + + + + + `illicit_networks` + `open_web` + `leak` + `domain` + `listing` + `forum_content` + `blog_content` + `blog_post` + `profile` + `chat_message` + `ransomleak` + `infected_devices` + `financial_data` + `bot` + `stealer_log` + `paste` + `social_media` + `source_code` + `source_code_files` + `stack_exchange` + `google` + `service` + `buckets` + `bucket` + `bucket_object` + + + Learn more about [Event Source Filters ](/advanced/event-source-filters). + + + + + + Matches values greater than the specified timestamp. + + Format: ISO-8601 + + + + Matches values greater than or equal to the specified timestamp. + + Format: ISO-8601 + + + + Matches values lesser than the specified timestamp. + + Format: ISO-8601 + + + + Matches values lesser than or equal to the specified timestamp. + + Format: ISO-8601 + + + + +