Skip to content

Documentation for new endpoint Update tenant metadata #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gabriellerouillard-flare wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Documentation for new endpoint Update tenant metadata #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5689e8
documentation generated and path added to Docs.json
gabriellerouillard-flare Dec 17, 2025
328f936
update name for Update Event Metadata
gabriellerouillard-flare Dec 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 52 additions & 50 deletions docs/api-reference/spec/firework-v2-openapi.json
View file
Open in desktop

Large diffs are not rendered by default.

135 changes: 89 additions & 46 deletions docs/api-reference/spec/firework-v2-swagger.json
View file
Open in desktop

Large diffs are not rendered by default.

23 changes: 17 additions & 6 deletions docs/api-reference/spec/firework-v3-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,7 @@
"links_to_azure_tenant",
"owns",
"uses",
"consists_of",
"related_to"
],
"type": "string"
Expand Down Expand Up @@ -278,9 +279,11 @@
"favicon",
"screenshot",
"azure_tenant",
"thread",
"actor",
"cve",
"identity"
"identity",
"forum_thread"
],
"type": "string"
}
Expand Down Expand Up @@ -308,9 +311,11 @@
"favicon",
"screenshot",
"azure_tenant",
"thread",
"actor",
"cve",
"identity"
"identity",
"forum_thread"
],
"type": "string"
}
Expand Down Expand Up @@ -478,7 +483,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, 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, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, blog_post, financial_data, forum_profile, ransomleak, listing, stealer_log, chat_message, forum_topic, seller, forum_post\n- open_web: docker, source_code_files, stack_exchange, paste, source_code_secrets, bucket, google, bucket_object, service, social_media_account\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, 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, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, forum_post, forum_topic, bot, chat_message, seller, financial_data, blog_post, forum_profile, stealer_log\n- open_web: stack_exchange, bucket_object, source_code_secrets, bucket, google, docker, service, source_code_files, paste, social_media_account\n- leaks: leak\n- domains: domain\n",
"explode": true,
"in": "query",
"name": "types",
Expand Down Expand Up @@ -798,7 +803,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, 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, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, blog_post, financial_data, forum_profile, ransomleak, listing, stealer_log, chat_message, forum_topic, seller, forum_post\n- open_web: docker, source_code_files, stack_exchange, paste, source_code_secrets, bucket, google, bucket_object, service, social_media_account\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, 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, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, forum_post, forum_topic, bot, chat_message, seller, financial_data, blog_post, forum_profile, stealer_log\n- open_web: stack_exchange, bucket_object, source_code_secrets, bucket, google, docker, service, source_code_files, paste, social_media_account\n- leaks: leak\n- domains: domain\n",
"explode": true,
"in": "query",
"name": "types",
Expand Down Expand Up @@ -1071,6 +1076,7 @@
"links_to_azure_tenant",
"owns",
"uses",
"consists_of",
"related_to"
],
"type": "string"
Expand Down Expand Up @@ -1099,9 +1105,11 @@
"favicon",
"screenshot",
"azure_tenant",
"thread",
"actor",
"cve",
"identity"
"identity",
"forum_thread"
],
"type": "string"
}
Expand Down Expand Up @@ -1775,9 +1783,11 @@
"favicon",
"screenshot",
"azure_tenant",
"thread",
"actor",
"cve",
"identity"
"identity",
"forum_thread"
],
"example": "github_repository",
"type": "string"
Expand Down Expand Up @@ -1898,6 +1908,7 @@
"links_to_azure_tenant",
"owns",
"uses",
"consists_of",
"related_to"
],
"example": "subdomain_of",
Expand Down
23 changes: 17 additions & 6 deletions docs/api-reference/spec/firework-v3-swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@
"favicon",
"screenshot",
"azure_tenant",
"thread",
"actor",
"cve",
"identity"
"identity",
"forum_thread"
],
"example": "github_repository",
"type": "string"
Expand Down Expand Up @@ -147,6 +149,7 @@
"links_to_azure_tenant",
"owns",
"uses",
"consists_of",
"related_to"
],
"example": "subdomain_of",
Expand Down Expand Up @@ -1130,6 +1133,7 @@
"links_to_azure_tenant",
"owns",
"uses",
"consists_of",
"related_to"
],
"in": "query",
Expand All @@ -1156,9 +1160,11 @@
"favicon",
"screenshot",
"azure_tenant",
"thread",
"actor",
"cve",
"identity"
"identity",
"forum_thread"
],
"in": "query",
"name": "target_type",
Expand All @@ -1184,9 +1190,11 @@
"favicon",
"screenshot",
"azure_tenant",
"thread",
"actor",
"cve",
"identity"
"identity",
"forum_thread"
],
"in": "query",
"name": "source_type",
Expand Down Expand Up @@ -1318,7 +1326,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, 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, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, blog_post, financial_data, forum_profile, ransomleak, listing, stealer_log, chat_message, forum_topic, seller, forum_post\n- open_web: docker, source_code_files, stack_exchange, paste, source_code_secrets, bucket, google, bucket_object, service, social_media_account\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, 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, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, forum_post, forum_topic, bot, chat_message, seller, financial_data, blog_post, forum_profile, stealer_log\n- open_web: stack_exchange, bucket_object, source_code_secrets, bucket, google, docker, service, source_code_files, paste, social_media_account\n- leaks: leak\n- domains: domain\n",
"enum": [
"attachment",
"listing",
Expand Down Expand Up @@ -1582,7 +1590,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, 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, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: bot, blog_post, financial_data, forum_profile, ransomleak, listing, stealer_log, chat_message, forum_topic, seller, forum_post\n- open_web: docker, source_code_files, stack_exchange, paste, source_code_secrets, bucket, google, bucket_object, service, social_media_account\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, 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, leaked_credential, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets_np, source_code_secrets, source_code_files, docker, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, cookie, pii, experimental\n\n*Some search types contain others*\n- illicit_networks: listing, ransomleak, forum_post, forum_topic, bot, chat_message, seller, financial_data, blog_post, forum_profile, stealer_log\n- open_web: stack_exchange, bucket_object, source_code_secrets, bucket, google, docker, service, source_code_files, paste, social_media_account\n- leaks: leak\n- domains: domain\n",
"enum": [
"attachment",
"listing",
Expand Down Expand Up @@ -1803,6 +1811,7 @@
"links_to_azure_tenant",
"owns",
"uses",
"consists_of",
"related_to"
],
"in": "query",
Expand All @@ -1829,9 +1838,11 @@
"favicon",
"screenshot",
"azure_tenant",
"thread",
"actor",
"cve",
"identity"
"identity",
"forum_thread"
],
"in": "query",
"name": "related_type",
Expand Down
Loading