diff --git a/docs/api-reference/spec/firework-v2-openapi.json b/docs/api-reference/spec/firework-v2-openapi.json index 25b2ce9..4eca568 100644 --- a/docs/api-reference/spec/firework-v2-openapi.json +++ b/docs/api-reference/spec/firework-v2-openapi.json @@ -50,6 +50,47 @@ } ], "paths": { + "/activities/": { + "get": { + "operationId": "get_activity_endpoint_/activities/", + "parameters": [ + { + "in": "query", + "name": "uid", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "feed_id", + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": {}, + "description": "Returns the activity" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HttpError" + } + } + }, + "description": "Activity not found" + } + }, + "tags": [ + "activities" + ] + } + }, "/activities/actor/profile/{actor_name}": { "get": { "operationId": "get_actor_/activities/actor/profile/", @@ -798,7 +839,7 @@ }, "/activities/{index}/{source}/{id}": { "get": { - "operationId": "get_activity_endpoint_/activities///", + "operationId": "get_activity_endpoint_deprecated_/activities///", "parameters": [ { "in": "path", @@ -1747,7 +1788,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, chat_message, seller, listing, forum_profile, forum_topic, ransomleak, forum_post, stealer_log, bot, blog_post\n- open_web: bucket, social_media, paste, service, bucket_object, stack_exchange, source_code_secrets, google, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, ransomleak, forum_post, listing, bot, financial_data, stealer_log, forum_topic, chat_message, blog_post\n- open_web: social_media, bucket_object, stack_exchange, source_code_files, bucket, service, source_code_secrets, paste, google\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -2064,7 +2105,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, chat_message, seller, listing, forum_profile, forum_topic, ransomleak, forum_post, stealer_log, bot, blog_post\n- open_web: bucket, social_media, paste, service, bucket_object, stack_exchange, source_code_secrets, google, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, ransomleak, forum_post, listing, bot, financial_data, stealer_log, forum_topic, chat_message, blog_post\n- open_web: social_media, bucket_object, stack_exchange, source_code_files, bucket, service, source_code_secrets, paste, google\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -2632,7 +2673,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, chat_message, seller, listing, forum_profile, forum_topic, ransomleak, forum_post, stealer_log, bot, blog_post\n- open_web: bucket, social_media, paste, service, bucket_object, stack_exchange, source_code_secrets, google, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, ransomleak, forum_post, listing, bot, financial_data, stealer_log, forum_topic, chat_message, blog_post\n- open_web: social_media, bucket_object, stack_exchange, source_code_files, bucket, service, source_code_secrets, paste, google\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -2949,7 +2990,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, chat_message, seller, listing, forum_profile, forum_topic, ransomleak, forum_post, stealer_log, bot, blog_post\n- open_web: bucket, social_media, paste, service, bucket_object, stack_exchange, source_code_secrets, google, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, ransomleak, forum_post, listing, bot, financial_data, stealer_log, forum_topic, chat_message, blog_post\n- open_web: social_media, bucket_object, stack_exchange, source_code_files, bucket, service, source_code_secrets, paste, google\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -3344,7 +3385,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, chat_message, seller, listing, forum_profile, forum_topic, ransomleak, forum_post, stealer_log, bot, blog_post\n- open_web: bucket, social_media, paste, service, bucket_object, stack_exchange, source_code_secrets, google, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, ransomleak, forum_post, listing, bot, financial_data, stealer_log, forum_topic, chat_message, blog_post\n- open_web: social_media, bucket_object, stack_exchange, source_code_files, bucket, service, source_code_secrets, paste, google\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -3683,7 +3724,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, chat_message, seller, listing, forum_profile, forum_topic, ransomleak, forum_post, stealer_log, bot, blog_post\n- open_web: bucket, social_media, paste, service, bucket_object, stack_exchange, source_code_secrets, google, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, ransomleak, forum_post, listing, bot, financial_data, stealer_log, forum_topic, chat_message, blog_post\n- open_web: social_media, bucket_object, stack_exchange, source_code_files, bucket, service, source_code_secrets, paste, google\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -3959,7 +4000,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, chat_message, seller, listing, forum_profile, forum_topic, ransomleak, forum_post, stealer_log, bot, blog_post\n- open_web: bucket, social_media, paste, service, bucket_object, stack_exchange, source_code_secrets, google, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, ransomleak, forum_post, listing, bot, financial_data, stealer_log, forum_topic, chat_message, blog_post\n- open_web: social_media, bucket_object, stack_exchange, source_code_files, bucket, service, source_code_secrets, paste, google\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -4968,7 +5009,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, chat_message, seller, listing, forum_profile, forum_topic, ransomleak, forum_post, stealer_log, bot, blog_post\n- open_web: bucket, social_media, paste, service, bucket_object, stack_exchange, source_code_secrets, google, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, ransomleak, forum_post, listing, bot, financial_data, stealer_log, forum_topic, chat_message, blog_post\n- open_web: social_media, bucket_object, stack_exchange, source_code_files, bucket, service, source_code_secrets, paste, google\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -5265,7 +5306,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, chat_message, seller, listing, forum_profile, forum_topic, ransomleak, forum_post, stealer_log, bot, blog_post\n- open_web: bucket, social_media, paste, service, bucket_object, stack_exchange, source_code_secrets, google, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, ransomleak, forum_post, listing, bot, financial_data, stealer_log, forum_topic, chat_message, blog_post\n- open_web: social_media, bucket_object, stack_exchange, source_code_files, bucket, service, source_code_secrets, paste, google\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -6398,26 +6439,26 @@ "blog_content", "profile", "infected_devices", - "financial_data", - "chat_message", - "seller", - "listing", "forum_profile", - "forum_topic", + "seller", "ransomleak", "forum_post", - "stealer_log", + "listing", "bot", + "financial_data", + "stealer_log", + "forum_topic", + "chat_message", "blog_post", - "bucket", "social_media", - "paste", - "service", "bucket_object", "stack_exchange", + "source_code_files", + "bucket", + "service", "source_code_secrets", + "paste", "google", - "source_code_files", "bucket", "bucket_object", "source_code_files", @@ -6425,13 +6466,13 @@ "source_code_secrets", "leak", "domain", - "forum_post", "forum_topic", + "forum_post", "blog_post", - "forum_profile", "seller", - "stealer_log", - "bot" + "forum_profile", + "bot", + "stealer_log" ], "example": "illicit_networks", "type": "string" diff --git a/docs/api-reference/spec/firework-v2-swagger.json b/docs/api-reference/spec/firework-v2-swagger.json index e7db92d..dd3d59f 100644 --- a/docs/api-reference/spec/firework-v2-swagger.json +++ b/docs/api-reference/spec/firework-v2-swagger.json @@ -700,26 +700,26 @@ "blog_content", "profile", "infected_devices", - "financial_data", - "chat_message", - "seller", - "listing", "forum_profile", - "forum_topic", + "seller", "ransomleak", "forum_post", - "stealer_log", + "listing", "bot", + "financial_data", + "stealer_log", + "forum_topic", + "chat_message", "blog_post", - "bucket", "social_media", - "paste", - "service", "bucket_object", "stack_exchange", + "source_code_files", + "bucket", + "service", "source_code_secrets", + "paste", "google", - "source_code_files", "bucket", "bucket_object", "source_code_files", @@ -727,13 +727,13 @@ "source_code_secrets", "leak", "domain", - "forum_post", "forum_topic", + "forum_post", "blog_post", - "forum_profile", "seller", - "stealer_log", - "bot" + "forum_profile", + "bot", + "stealer_log" ], "example": "illicit_networks", "type": "string" @@ -2456,6 +2456,38 @@ "version": "v2" }, "paths": { + "/activities/": { + "get": { + "operationId": "get_activity_endpoint_/activities/", + "parameters": [ + { + "in": "query", + "name": "uid", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "feed_id", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Returns the activity" + }, + "404": { + "description": "Activity not found", + "schema": { + "$ref": "#/definitions/HttpError" + } + } + }, + "tags": [ + "activities" + ] + } + }, "/activities/actor/profile/{actor_name}": { "get": { "operationId": "get_actor_/activities/actor/profile/", @@ -2969,7 +3001,7 @@ }, "/activities/{index}/{source}/{id}": { "get": { - "operationId": "get_activity_endpoint_/activities///", + "operationId": "get_activity_endpoint_deprecated_/activities///", "responses": { "200": { "description": "Returns the activity" @@ -3712,7 +3744,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, chat_message, seller, listing, forum_profile, forum_topic, ransomleak, forum_post, stealer_log, bot, blog_post\n- open_web: bucket, social_media, paste, service, bucket_object, stack_exchange, source_code_secrets, google, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, ransomleak, forum_post, listing, bot, financial_data, stealer_log, forum_topic, chat_message, blog_post\n- open_web: social_media, bucket_object, stack_exchange, source_code_files, bucket, service, source_code_secrets, paste, google\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -3973,7 +4005,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, chat_message, seller, listing, forum_profile, forum_topic, ransomleak, forum_post, stealer_log, bot, blog_post\n- open_web: bucket, social_media, paste, service, bucket_object, stack_exchange, source_code_secrets, google, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, ransomleak, forum_post, listing, bot, financial_data, stealer_log, forum_topic, chat_message, blog_post\n- open_web: social_media, bucket_object, stack_exchange, source_code_files, bucket, service, source_code_secrets, paste, google\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -4404,7 +4436,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, chat_message, seller, listing, forum_profile, forum_topic, ransomleak, forum_post, stealer_log, bot, blog_post\n- open_web: bucket, social_media, paste, service, bucket_object, stack_exchange, source_code_secrets, google, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, ransomleak, forum_post, listing, bot, financial_data, stealer_log, forum_topic, chat_message, blog_post\n- open_web: social_media, bucket_object, stack_exchange, source_code_files, bucket, service, source_code_secrets, paste, google\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -4665,7 +4697,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, chat_message, seller, listing, forum_profile, forum_topic, ransomleak, forum_post, stealer_log, bot, blog_post\n- open_web: bucket, social_media, paste, service, bucket_object, stack_exchange, source_code_secrets, google, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, ransomleak, forum_post, listing, bot, financial_data, stealer_log, forum_topic, chat_message, blog_post\n- open_web: social_media, bucket_object, stack_exchange, source_code_files, bucket, service, source_code_secrets, paste, google\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -4971,7 +5003,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, chat_message, seller, listing, forum_profile, forum_topic, ransomleak, forum_post, stealer_log, bot, blog_post\n- open_web: bucket, social_media, paste, service, bucket_object, stack_exchange, source_code_secrets, google, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, ransomleak, forum_post, listing, bot, financial_data, stealer_log, forum_topic, chat_message, blog_post\n- open_web: social_media, bucket_object, stack_exchange, source_code_files, bucket, service, source_code_secrets, paste, google\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -5268,7 +5300,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, chat_message, seller, listing, forum_profile, forum_topic, ransomleak, forum_post, stealer_log, bot, blog_post\n- open_web: bucket, social_media, paste, service, bucket_object, stack_exchange, source_code_secrets, google, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, ransomleak, forum_post, listing, bot, financial_data, stealer_log, forum_topic, chat_message, blog_post\n- open_web: social_media, bucket_object, stack_exchange, source_code_files, bucket, service, source_code_secrets, paste, google\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -5499,7 +5531,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, chat_message, seller, listing, forum_profile, forum_topic, ransomleak, forum_post, stealer_log, bot, blog_post\n- open_web: bucket, social_media, paste, service, bucket_object, stack_exchange, source_code_secrets, google, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, ransomleak, forum_post, listing, bot, financial_data, stealer_log, forum_topic, chat_message, blog_post\n- open_web: social_media, bucket_object, stack_exchange, source_code_files, bucket, service, source_code_secrets, paste, google\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -5699,11 +5731,6 @@ "in": "query", "name": "from", "type": "string" - }, - { - "in": "query", - "name": "search_after", - "type": "string" } ], "responses": { @@ -6310,7 +6337,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, chat_message, seller, listing, forum_profile, forum_topic, ransomleak, forum_post, stealer_log, bot, blog_post\n- open_web: bucket, social_media, paste, service, bucket_object, stack_exchange, source_code_secrets, google, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, ransomleak, forum_post, listing, bot, financial_data, stealer_log, forum_topic, chat_message, blog_post\n- open_web: social_media, bucket_object, stack_exchange, source_code_files, bucket, service, source_code_secrets, paste, google\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -6555,7 +6582,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: financial_data, chat_message, seller, listing, forum_profile, forum_topic, ransomleak, forum_post, stealer_log, bot, blog_post\n- open_web: bucket, social_media, paste, service, bucket_object, stack_exchange, source_code_secrets, google, source_code_files\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_profile, seller, ransomleak, forum_post, listing, bot, financial_data, stealer_log, forum_topic, chat_message, blog_post\n- open_web: social_media, bucket_object, stack_exchange, source_code_files, bucket, service, source_code_secrets, paste, google\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", diff --git a/docs/api-reference/spec/firework-v3-openapi.json b/docs/api-reference/spec/firework-v3-openapi.json index ef00ead..e89f63c 100644 --- a/docs/api-reference/spec/firework-v3-openapi.json +++ b/docs/api-reference/spec/firework-v3-openapi.json @@ -469,7 +469,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, chat_message, listing, financial_data, stealer_log, bot, forum_topic, ransomleak, forum_post, forum_profile, seller\n- open_web: bucket_object, bucket, google, service, stack_exchange, source_code_files, social_media, source_code_secrets, paste\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, seller, forum_topic, chat_message, ransomleak, forum_profile, listing, bot, financial_data, stealer_log, blog_post\n- open_web: bucket_object, service, source_code_secrets, source_code_files, stack_exchange, paste, google, bucket, social_media\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -786,7 +786,7 @@ } }, { - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, chat_message, listing, financial_data, stealer_log, bot, forum_topic, ransomleak, forum_post, forum_profile, seller\n- open_web: bucket_object, bucket, google, service, stack_exchange, source_code_files, social_media, source_code_secrets, paste\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, seller, forum_topic, chat_message, ransomleak, forum_profile, listing, bot, financial_data, stealer_log, blog_post\n- open_web: bucket_object, service, source_code_secrets, source_code_files, stack_exchange, paste, google, bucket, social_media\n- leaks: leak\n- domains: domain\n", "explode": true, "in": "query", "name": "types", @@ -1284,13 +1284,6 @@ "schema": { "type": "string" } - }, - { - "in": "query", - "name": "search_after", - "schema": { - "type": "string" - } } ], "responses": { @@ -1424,13 +1417,6 @@ "schema": { "type": "string" } - }, - { - "in": "query", - "name": "search_after", - "schema": { - "type": "string" - } } ], "responses": { @@ -1536,13 +1522,6 @@ "schema": { "type": "string" } - }, - { - "in": "query", - "name": "search_after", - "schema": { - "type": "string" - } } ], "responses": { @@ -2247,6 +2226,9 @@ }, "type": "array" }, + "recommendation_group_id": { + "type": "integer" + }, "state": { "enum": [ "recommended", @@ -2266,6 +2248,29 @@ }, "type": "object" }, + "IdentifierRecommendationGroupWithCounts": { + "properties": { + "asset_id": { + "type": "integer" + }, + "filtered_recommendations_count": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "tenant_id": { + "type": "integer" + }, + "total_recommendations_count": { + "type": "integer" + } + }, + "type": "object" + }, "LeakActivityCredential": { "properties": { "domain": { diff --git a/docs/api-reference/spec/firework-v3-swagger.json b/docs/api-reference/spec/firework-v3-swagger.json index 22bb0f6..d437db5 100644 --- a/docs/api-reference/spec/firework-v3-swagger.json +++ b/docs/api-reference/spec/firework-v3-swagger.json @@ -555,6 +555,9 @@ }, "type": "array" }, + "recommendation_group_id": { + "type": "integer" + }, "state": { "enum": [ "recommended", @@ -574,6 +577,29 @@ }, "type": "object" }, + "IdentifierRecommendationGroupWithCounts": { + "properties": { + "asset_id": { + "type": "integer" + }, + "filtered_recommendations_count": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "tenant_id": { + "type": "integer" + }, + "total_recommendations_count": { + "type": "integer" + } + }, + "type": "object" + }, "LeakActivityCredential": { "properties": { "domain": { @@ -1188,7 +1214,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, chat_message, listing, financial_data, stealer_log, bot, forum_topic, ransomleak, forum_post, forum_profile, seller\n- open_web: bucket_object, bucket, google, service, stack_exchange, source_code_files, social_media, source_code_secrets, paste\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, seller, forum_topic, chat_message, ransomleak, forum_profile, listing, bot, financial_data, stealer_log, blog_post\n- open_web: bucket_object, service, source_code_secrets, source_code_files, stack_exchange, paste, google, bucket, social_media\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -1449,7 +1475,7 @@ }, { "collectionFormat": "multi", - "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: blog_post, chat_message, listing, financial_data, stealer_log, bot, forum_topic, ransomleak, forum_post, forum_profile, seller\n- open_web: bucket_object, bucket, google, service, stack_exchange, source_code_files, social_media, source_code_secrets, paste\n- leaks: leak\n- domains: domain\n", + "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, seller, forum_topic, chat_message, ransomleak, forum_profile, listing, bot, financial_data, stealer_log, blog_post\n- open_web: bucket_object, service, source_code_secrets, source_code_files, stack_exchange, paste, google, bucket, social_media\n- leaks: leak\n- domains: domain\n", "enum": [ "attachment", "listing", @@ -1865,11 +1891,6 @@ "in": "query", "name": "from", "type": "string" - }, - { - "in": "query", - "name": "search_after", - "type": "string" } ], "responses": { @@ -1979,11 +2000,6 @@ "in": "query", "name": "from", "type": "string" - }, - { - "in": "query", - "name": "search_after", - "type": "string" } ], "responses": { @@ -2065,11 +2081,6 @@ "in": "query", "name": "from", "type": "string" - }, - { - "in": "query", - "name": "search_after", - "type": "string" } ], "responses": { diff --git a/docs/api-reference/spec/firework-v4-openapi.json b/docs/api-reference/spec/firework-v4-openapi.json index a78a871..a16e86b 100644 --- a/docs/api-reference/spec/firework-v4-openapi.json +++ b/docs/api-reference/spec/firework-v4-openapi.json @@ -827,8 +827,8 @@ }, "/alerts/channels": { "get": { - "summary": "Current Alert Channels", - "operationId": "current_alert_channels_alerts_channels_get", + "summary": "Tenant Alert Channels", + "operationId": "tenant_alert_channels_alerts_channels_get", "parameters": [ { "name": "from_", @@ -962,7 +962,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaginatedResults_AlertChannel_" + "$ref": "#/components/schemas/PaginatedResults_PartialAlertChannel_" } } } @@ -1221,6 +1221,256 @@ } } } + }, + "put": { + "summary": "Update Alert Channel", + "operationId": "update_alert_channel_alerts_channels__alert_channel_id__put", + "parameters": [ + { + "name": "alert_channel_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Alert Channel Id" + } + }, + { + "name": "X-Auth-Request-User", + "in": "header", + "required": true, + "schema": { + "type": "string", + "title": "X-Auth-Request-User" + } + }, + { + "name": "X-Auth-Request-User-Id", + "in": "header", + "required": true, + "schema": { + "type": "integer", + "title": "X-Auth-Request-User-Id" + } + }, + { + "name": "X-Auth-Request-User-Scopes", + "in": "header", + "required": true, + "schema": { + "type": "string", + "title": "X-Auth-Request-User-Scopes" + } + }, + { + "name": "X-Auth-Request-Tenant-Id", + "in": "header", + "required": true, + "schema": { + "type": "integer", + "title": "X-Auth-Request-Tenant-Id" + } + }, + { + "name": "x-real-ip", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Real-Ip" + } + }, + { + "name": "x-flare-referer", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Flare-Referer" + } + }, + { + "name": "user-agent", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "User-Agent" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateAlertChannel" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "get": { + "summary": "Get Alert Channel", + "operationId": "get_alert_channel_alerts_channels__alert_channel_id__get", + "parameters": [ + { + "name": "alert_channel_id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "title": "Alert Channel Id" + } + }, + { + "name": "X-Auth-Request-User", + "in": "header", + "required": true, + "schema": { + "type": "string", + "title": "X-Auth-Request-User" + } + }, + { + "name": "X-Auth-Request-User-Id", + "in": "header", + "required": true, + "schema": { + "type": "integer", + "title": "X-Auth-Request-User-Id" + } + }, + { + "name": "X-Auth-Request-User-Scopes", + "in": "header", + "required": true, + "schema": { + "type": "string", + "title": "X-Auth-Request-User-Scopes" + } + }, + { + "name": "X-Auth-Request-Tenant-Id", + "in": "header", + "required": true, + "schema": { + "type": "integer", + "title": "X-Auth-Request-Tenant-Id" + } + }, + { + "name": "x-real-ip", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Real-Ip" + } + }, + { + "name": "x-flare-referer", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Flare-Referer" + } + }, + { + "name": "user-agent", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "User-Agent" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AlertChannel" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } } }, "/healthz/": { @@ -3271,8 +3521,8 @@ "type": { "$ref": "#/components/schemas/AlertType" }, - "status": { - "$ref": "#/components/schemas/AlertChannelStatus" + "state": { + "$ref": "#/components/schemas/AlertChannelState" }, "params": { "oneOf": [ @@ -3334,7 +3584,7 @@ "id", "name", "type", - "status", + "state", "params" ], "title": "AlertChannel" @@ -3441,11 +3691,13 @@ }, "json_attachment": { "type": "boolean", - "title": "Json Attachment" + "title": "Json Attachment", + "default": false }, "csv_attachment": { "type": "boolean", - "title": "Csv Attachment" + "title": "Csv Attachment", + "default": false }, "subject_tag": { "anyOf": [ @@ -3459,17 +3711,14 @@ "title": "Subject Tag" }, "language": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "default": "en" } }, "type": "object", "required": [ "type", - "email", - "json_attachment", - "csv_attachment", - "subject_tag", - "language" + "email" ], "title": "AlertChannelEmailParams" }, @@ -3501,7 +3750,8 @@ "type": "string" }, "type": "array", - "title": "Labels" + "title": "Labels", + "default": [] }, "issue_type": { "type": "string", @@ -3515,7 +3765,6 @@ "email", "api_token", "project_key", - "labels", "issue_type" ], "title": "AlertChannelJiraParams" @@ -3621,7 +3870,8 @@ "type": "string" }, "type": "array", - "title": "Labels" + "title": "Labels", + "default": [] } }, "type": "object", @@ -3629,11 +3879,34 @@ "type", "api_token", "netloc", - "index", - "labels" + "index" ], "title": "AlertChannelSplunkParams" }, + "AlertChannelState": { + "properties": { + "status": { + "$ref": "#/components/schemas/AlertChannelStatus" + }, + "message": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Message" + } + }, + "type": "object", + "required": [ + "status", + "message" + ], + "title": "AlertChannelState" + }, "AlertChannelStatus": { "type": "string", "enum": [ @@ -3904,6 +4177,16 @@ "webhook": "#/components/schemas/AlertChannelWebhookParams" } } + }, + "state": { + "anyOf": [ + { + "$ref": "#/components/schemas/AlertChannelState" + }, + { + "type": "null" + } + ] } }, "type": "object", @@ -4738,11 +5021,11 @@ ], "title": "PagedCookieConfigurations" }, - "PaginatedResults_AlertChannel_": { + "PaginatedResults_Alert_": { "properties": { "items": { "items": { - "$ref": "#/components/schemas/AlertChannel" + "$ref": "#/components/schemas/Alert" }, "type": "array", "title": "Items" @@ -4764,13 +5047,13 @@ "items", "next" ], - "title": "PaginatedResults[AlertChannel]" + "title": "PaginatedResults[Alert]" }, - "PaginatedResults_Alert_": { + "PaginatedResults_FeedItem_": { "properties": { "items": { "items": { - "$ref": "#/components/schemas/Alert" + "$ref": "#/components/schemas/FeedItem" }, "type": "array", "title": "Items" @@ -4792,13 +5075,13 @@ "items", "next" ], - "title": "PaginatedResults[Alert]" + "title": "PaginatedResults[FeedItem]" }, - "PaginatedResults_FeedItem_": { + "PaginatedResults_PartialAlertChannel_": { "properties": { "items": { "items": { - "$ref": "#/components/schemas/FeedItem" + "$ref": "#/components/schemas/PartialAlertChannel" }, "type": "array", "title": "Items" @@ -4820,7 +5103,7 @@ "items", "next" ], - "title": "PaginatedResults[FeedItem]" + "title": "PaginatedResults[PartialAlertChannel]" }, "PaginatedResults_Report_": { "properties": { @@ -4953,6 +5236,32 @@ "type": "object", "title": "PartialAlert" }, + "PartialAlertChannel": { + "properties": { + "id": { + "type": "integer", + "title": "Id" + }, + "name": { + "type": "string", + "title": "Name" + }, + "type": { + "$ref": "#/components/schemas/AlertType" + }, + "state": { + "$ref": "#/components/schemas/AlertChannelState" + } + }, + "type": "object", + "required": [ + "id", + "name", + "type", + "state" + ], + "title": "PartialAlertChannel" + }, "QueryStringQuery": { "properties": { "type": { @@ -4978,6 +5287,10 @@ "type": "integer", "title": "Id" }, + "format_type": { + "$ref": "#/components/schemas/ThreatFlowReportFormatType", + "default": "simple_summary" + }, "title": { "type": "string", "title": "Title" @@ -5278,6 +5591,14 @@ ], "title": "ThreatFlowReportDownloadFormat" }, + "ThreatFlowReportFormatType": { + "type": "string", + "enum": [ + "simple_summary", + "expanded_summary" + ], + "title": "ThreatFlowReportFormatType" + }, "ThreatFlowTenantConfigPayload": { "properties": { "ignored_tags": { @@ -5307,6 +5628,78 @@ ], "title": "ThreatFlowTenantConfigPayload" }, + "UpdateAlertChannel": { + "properties": { + "name": { + "type": "string", + "title": "Name" + }, + "params": { + "oneOf": [ + { + "$ref": "#/components/schemas/AlertChannelEmailParams" + }, + { + "$ref": "#/components/schemas/AlertChannelSlackParams" + }, + { + "$ref": "#/components/schemas/AlertChannelDiscordParams" + }, + { + "$ref": "#/components/schemas/AlertChannelSplunkParams" + }, + { + "$ref": "#/components/schemas/AlertChannelChannelParams" + }, + { + "$ref": "#/components/schemas/AlertChannelSentinelParams" + }, + { + "$ref": "#/components/schemas/AlertChannelCgcdParams" + }, + { + "$ref": "#/components/schemas/AlertChannelTeamsParams" + }, + { + "$ref": "#/components/schemas/AlertChannelJiraParams" + }, + { + "$ref": "#/components/schemas/AlertChannelServicenowParams" + }, + { + "$ref": "#/components/schemas/AlertChannelWebhookParams" + } + ], + "title": "Params", + "discriminator": { + "propertyName": "type", + "mapping": { + "azure_sentinel": "#/components/schemas/AlertChannelSentinelParams", + "cgcd": "#/components/schemas/AlertChannelCgcdParams", + "channel": "#/components/schemas/AlertChannelChannelParams", + "discord": "#/components/schemas/AlertChannelDiscordParams", + "email": "#/components/schemas/AlertChannelEmailParams", + "jira": "#/components/schemas/AlertChannelJiraParams", + "servicenow": "#/components/schemas/AlertChannelServicenowParams", + "slack": "#/components/schemas/AlertChannelSlackParams", + "splunk": "#/components/schemas/AlertChannelSplunkParams", + "teams": "#/components/schemas/AlertChannelTeamsParams", + "webhook": "#/components/schemas/AlertChannelWebhookParams" + } + } + }, + "state": { + "$ref": "#/components/schemas/AlertChannelState" + } + }, + "type": "object", + "required": [ + "name", + "params", + "state" + ], + "title": "UpdateAlertChannel" + }, "UsernameQuery": { "properties": { "type": { diff --git a/docs/api-reference/v2/endpoints/activities/get-activities-.mdx b/docs/api-reference/v2/endpoints/activities/get-activities-.mdx new file mode 100644 index 0000000..2325772 --- /dev/null +++ b/docs/api-reference/v2/endpoints/activities/get-activities-.mdx @@ -0,0 +1,8 @@ +--- +openapi: firework-v2-openapi get /activities/ +title: Retrieve Event +--- + + +For backwards compatibility, this endpoint is also available as [/firework/v2/activities/\{index}/\{source\}/\{id\} ](/api-reference/v2/endpoints/activities/get-activities). + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/activities/get-activities.mdx b/docs/api-reference/v2/endpoints/activities/get-activities.mdx index a4ac9c4..671230f 100644 --- a/docs/api-reference/v2/endpoints/activities/get-activities.mdx +++ b/docs/api-reference/v2/endpoints/activities/get-activities.mdx @@ -8,3 +8,7 @@ The `index`, `source` and `id` path parameters refer to the event's `uid`, which For a full example usage of this endpoint, see [List Events Within a Tenant ](/guides/tenant-events) + + +An updated version of this endpoint is available as [/firework/v2/activities/ ](/api-reference/v2/endpoints/activities/get-activities-). + \ No newline at end of file diff --git a/docs/api-reference/v3/endpoints/identifiers/get-identifiers-feedcredentials.mdx b/docs/api-reference/v3/endpoints/identifiers/get-identifiers-feedcredentials.mdx new file mode 100644 index 0000000..0f91e18 --- /dev/null +++ b/docs/api-reference/v3/endpoints/identifiers/get-identifiers-feedcredentials.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v3-openapi get /identifiers/{identifier_id}/feed/credentials +--- \ No newline at end of file diff --git a/docs/api-reference/v3/endpoints/identifiers/post-identifiers-feedcredentials.mdx b/docs/api-reference/v3/endpoints/identifiers/post-identifiers-feedcredentials.mdx new file mode 100644 index 0000000..bc9d56b --- /dev/null +++ b/docs/api-reference/v3/endpoints/identifiers/post-identifiers-feedcredentials.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v3-openapi post /identifiers/{identifier_id}/feed/credentials +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/create-alert-channel.mdx b/docs/api-reference/v4/endpoints/create-alert-channel.mdx new file mode 100644 index 0000000..56f212a --- /dev/null +++ b/docs/api-reference/v4/endpoints/create-alert-channel.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi post /alerts/channels +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/create-alert.mdx b/docs/api-reference/v4/endpoints/create-alert.mdx new file mode 100644 index 0000000..81774f7 --- /dev/null +++ b/docs/api-reference/v4/endpoints/create-alert.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi post /alerts/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/create-cookie-monitoring-configuration.mdx b/docs/api-reference/v4/endpoints/create-cookie-monitoring-configuration.mdx new file mode 100644 index 0000000..e6e24d7 --- /dev/null +++ b/docs/api-reference/v4/endpoints/create-cookie-monitoring-configuration.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi post /admin/cookies/monitor +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/create-or-update-tenant-config.mdx b/docs/api-reference/v4/endpoints/create-or-update-tenant-config.mdx new file mode 100644 index 0000000..a84b9d2 --- /dev/null +++ b/docs/api-reference/v4/endpoints/create-or-update-tenant-config.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi put /threat_flow/tenant_config/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/delete-alert-channel.mdx b/docs/api-reference/v4/endpoints/delete-alert-channel.mdx new file mode 100644 index 0000000..4055ca7 --- /dev/null +++ b/docs/api-reference/v4/endpoints/delete-alert-channel.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi delete /alerts/channels/{alert_channel_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/delete-alert.mdx b/docs/api-reference/v4/endpoints/delete-alert.mdx new file mode 100644 index 0000000..c9dc2c3 --- /dev/null +++ b/docs/api-reference/v4/endpoints/delete-alert.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi delete /alerts/{alert_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/delete-report.mdx b/docs/api-reference/v4/endpoints/delete-report.mdx new file mode 100644 index 0000000..73b3bda --- /dev/null +++ b/docs/api-reference/v4/endpoints/delete-report.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi delete /threat_flow/reports/{report_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/download-report.mdx b/docs/api-reference/v4/endpoints/download-report.mdx new file mode 100644 index 0000000..be4aaf7 --- /dev/null +++ b/docs/api-reference/v4/endpoints/download-report.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi get /threat_flow/reports/{report_id}/download +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/fetch-filters-risk-score.mdx b/docs/api-reference/v4/endpoints/fetch-filters-risk-score.mdx new file mode 100644 index 0000000..18b9b84 --- /dev/null +++ b/docs/api-reference/v4/endpoints/fetch-filters-risk-score.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi get /events/filters/severities +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/fetch-filters-source-types.mdx b/docs/api-reference/v4/endpoints/fetch-filters-source-types.mdx new file mode 100644 index 0000000..04ef06a --- /dev/null +++ b/docs/api-reference/v4/endpoints/fetch-filters-source-types.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi get /events/filters/types +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/get-alert-channel.mdx b/docs/api-reference/v4/endpoints/get-alert-channel.mdx new file mode 100644 index 0000000..bca0c6a --- /dev/null +++ b/docs/api-reference/v4/endpoints/get-alert-channel.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi get /alerts/channels/{alert_channel_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/get-and-create-tenant-config.mdx b/docs/api-reference/v4/endpoints/get-and-create-tenant-config.mdx new file mode 100644 index 0000000..4ea5aa1 --- /dev/null +++ b/docs/api-reference/v4/endpoints/get-and-create-tenant-config.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi get /threat_flow/tenant_config/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/get-report.mdx b/docs/api-reference/v4/endpoints/get-report.mdx new file mode 100644 index 0000000..3b4a7ae --- /dev/null +++ b/docs/api-reference/v4/endpoints/get-report.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi get /threat_flow/reports/{report_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/is-api-up-and-running.mdx b/docs/api-reference/v4/endpoints/is-api-up-and-running.mdx new file mode 100644 index 0000000..3ee2e7e --- /dev/null +++ b/docs/api-reference/v4/endpoints/is-api-up-and-running.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi get /healthz/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/list-cookie-monitoring-configurations.mdx b/docs/api-reference/v4/endpoints/list-cookie-monitoring-configurations.mdx new file mode 100644 index 0000000..b4673e1 --- /dev/null +++ b/docs/api-reference/v4/endpoints/list-cookie-monitoring-configurations.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi get /admin/cookies/configurations +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/list-reports.mdx b/docs/api-reference/v4/endpoints/list-reports.mdx new file mode 100644 index 0000000..9393c85 --- /dev/null +++ b/docs/api-reference/v4/endpoints/list-reports.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi get /threat_flow/reports/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/list-tags.mdx b/docs/api-reference/v4/endpoints/list-tags.mdx new file mode 100644 index 0000000..2cf05fb --- /dev/null +++ b/docs/api-reference/v4/endpoints/list-tags.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi get /threat_flow/tags/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/submit-presigned-url.mdx b/docs/api-reference/v4/endpoints/submit-presigned-url.mdx new file mode 100644 index 0000000..13ccc27 --- /dev/null +++ b/docs/api-reference/v4/endpoints/submit-presigned-url.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi post /file_analysis/submit +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/tenant-alert-channels.mdx b/docs/api-reference/v4/endpoints/tenant-alert-channels.mdx new file mode 100644 index 0000000..4ae3d97 --- /dev/null +++ b/docs/api-reference/v4/endpoints/tenant-alert-channels.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi get /alerts/channels +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/tenant-alerts.mdx b/docs/api-reference/v4/endpoints/tenant-alerts.mdx new file mode 100644 index 0000000..1ae34cd --- /dev/null +++ b/docs/api-reference/v4/endpoints/tenant-alerts.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi get /alerts/ +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/update-alert-channel.mdx b/docs/api-reference/v4/endpoints/update-alert-channel.mdx new file mode 100644 index 0000000..0864dfa --- /dev/null +++ b/docs/api-reference/v4/endpoints/update-alert-channel.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi put /alerts/channels/{alert_channel_id} +--- \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/update-alert.mdx b/docs/api-reference/v4/endpoints/update-alert.mdx new file mode 100644 index 0000000..5a15251 --- /dev/null +++ b/docs/api-reference/v4/endpoints/update-alert.mdx @@ -0,0 +1,3 @@ +--- +openapi: firework-v4-openapi patch /alerts/{alert_id} +--- \ No newline at end of file diff --git a/docs/changelog/overview.mdx b/docs/changelog/overview.mdx index 1625967..5b56ac6 100644 --- a/docs/changelog/overview.mdx +++ b/docs/changelog/overview.mdx @@ -12,6 +12,11 @@ This page lists changes to Flare's API. Release notes for the Flare Platform can be found on the [product documentation website](https://docs.flare.io/releases). + + Released new [/firework/v2/activities/ ](/api-reference/v2/endpoints/activities/get-activities-). + You can now fetch an activity by passing the activity uid as a query parameter. This is an alternative to [/firework/v2/activities/\{index}/\{source\}/\{id\} ](/api-reference/v2/endpoints/activities/get-activities). + + The [cookies search endpoint ](/api-reference/leaksdb/endpoints/post-cookies-search) diff --git a/docs/guides/global-search.mdx b/docs/guides/global-search.mdx index 7ce46af..658b004 100644 --- a/docs/guides/global-search.mdx +++ b/docs/guides/global-search.mdx @@ -45,10 +45,11 @@ These are end-to-end examples in various programming languages. ```python +#!/usr/bin/env python3 + import datetime import os import time -import urllib.parse from flareio import FlareApiClient @@ -100,14 +101,11 @@ for resp in api_client.scroll( # Rate limiting. time.sleep(1) - # This will contain 3 parts: 'index', 'source', and 'id' - parsed_uid: list[str] = item["metadata"]["uid"].split("/", maxsplit=2) - event_response = api_client.get( - "/firework/v2/activities/" - + "/".join( - urllib.parse.quote_plus(uid_component) for uid_component in parsed_uid - ) + url="/firework/v2/activities/", + params={ + "uid": item["metadata"]["uid"], + }, ) full_data = event_response.json() diff --git a/docs/guides/tenant-events.mdx b/docs/guides/tenant-events.mdx index dc62888..6db5910 100644 --- a/docs/guides/tenant-events.mdx +++ b/docs/guides/tenant-events.mdx @@ -23,7 +23,7 @@ However, it is important that future requests use **exactly** the same parameter For performance reasons, feed results only contain the bare minimum. To get the full data, an API call must be made per result to the -[Retrieve Event ](/api-reference/v2/endpoints/activities/get-activities) +[Retrieve Event ](/api-reference/v2/endpoints/activities/get-activities-) endpoint. ## Available Endpoints @@ -99,7 +99,6 @@ These are end-to-end examples in various programming languages. ```python import os import time -import urllib.parse from flareio import FlareApiClient @@ -137,14 +136,11 @@ for resp in api_client.scroll( # Rate limiting. time.sleep(1) - # This will contain 3 parts: 'index', 'source', and 'id' - parsed_uid: list[str] = item["metadata"]["uid"].split("/", maxsplit=2) - event_response = api_client.get( - "/firework/v2/activities/" - + "/".join( - urllib.parse.quote_plus(uid_component) for uid_component in parsed_uid - ) + url="/firework/v2/activities/", + params={ + "uid": item["metadata"]["uid"], + }, ) full_data = event_response.json() diff --git a/docs/mint.json b/docs/mint.json index 25fce95..a96f63c 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -168,6 +168,7 @@ { "group": "Events", "pages": [ + "api-reference/v2/endpoints/activities/get-activities-", "api-reference/v2/endpoints/activities/get-activities", "api-reference/v2/endpoints/activities/get-activities--ai_assistance", "api-reference/v4/endpoints/event-actions"