Skip to content

Add Entities API docs (list-entities, get-entity, get-entity-relations) to v4 #242

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

Merged
xvaier merged 10 commits into from
Aug 14, 2026
Merged

Add Entities API docs (list-entities, get-entity, get-entity-relations) to v4 #242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0603058
Add Entities API docs (list-entities, get-entity) to v4
flare-davidm Jul 31, 2026
50c11fd
Use firework-v4-openapi spec prefix so method tag renders
flare-davidm Jul 31, 2026
1b2a112
Fix Entities API nav paths to point at public/ pages
flare-davidm Jul 31, 2026
13b0807
new doc - following api revamp
flare-davidm Aug 13, 2026
278ad9e
Merge branch 'main' into add-entities-api-docs
flare-davidm Aug 13, 2026
a14e0ab
regen swagger
flare-davidm Aug 13, 2026
5967cef
fix merge
flare-davidm Aug 13, 2026
cb83caa
Merge branch 'add-entities-api-docs' of github.com:flare-davidm/docs-…
flare-davidm Aug 13, 2026
4b9821e
regen post merge
flare-davidm Aug 13, 2026
e68e838
made endpoints beta
flare-davidm Aug 14, 2026
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
142 changes: 71 additions & 71 deletions docs/api-reference/spec/firework-v2-openapi.json
View file
Open in desktop

Large diffs are not rendered by default.

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

Large diffs are not rendered by default.

4 changes: 2 additions & 2 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 @@ -569,7 +569,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, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, 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: financial_data, bot, blog_post, forum_post, stealer_log, listing, seller, ransomleak, chat_message, forum_profile, forum_topic\n- open_web: bucket_object, source_code_files, service, google, social_media_account, docker, source_code_secrets, bucket, paste, stack_exchange\n- leaks: invalid_credential, leak, mitigated_credential, valid_credential\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, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, 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: financial_data, forum_topic, forum_profile, blog_post, listing, ransomleak, seller, bot, stealer_log, chat_message, forum_post\n- open_web: source_code_files, social_media_account, bucket_object, stack_exchange, service, google, docker, bucket, paste, source_code_secrets\n- leaks: leak, invalid_credential, valid_credential, mitigated_credential\n- domains: domain\n",
"explode": true,
"in": "query",
"name": "types",
Expand Down Expand Up @@ -893,7 +893,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, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, 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: financial_data, bot, blog_post, forum_post, stealer_log, listing, seller, ransomleak, chat_message, forum_profile, forum_topic\n- open_web: bucket_object, source_code_files, service, google, social_media_account, docker, source_code_secrets, bucket, paste, stack_exchange\n- leaks: invalid_credential, leak, mitigated_credential, valid_credential\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, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, 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: financial_data, forum_topic, forum_profile, blog_post, listing, ransomleak, seller, bot, stealer_log, chat_message, forum_post\n- open_web: source_code_files, social_media_account, bucket_object, stack_exchange, service, google, docker, bucket, paste, source_code_secrets\n- leaks: leak, invalid_credential, valid_credential, mitigated_credential\n- domains: domain\n",
"explode": true,
"in": "query",
"name": "types",
Expand Down
40 changes: 20 additions & 20 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 @@ -409,7 +409,7 @@
"type": "string"
}
],
"get": {
"post": {
"responses": {
"403": {
"description": "Forbidden.",
Expand All @@ -430,7 +430,7 @@
}
}
},
"operationId": "get_asset_feeds_api_/assets/<uuid:asset_uuid>/feed",
"operationId": "post_asset_feeds_api_/assets/<uuid:asset_uuid>/feed",
"parameters": [
{
"name": "fields",
Expand Down Expand Up @@ -487,7 +487,7 @@
"name": "types",
"in": "query",
"type": "array",
"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, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, 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: financial_data, bot, blog_post, forum_post, stealer_log, listing, seller, ransomleak, chat_message, forum_profile, forum_topic\n- open_web: bucket_object, source_code_files, service, google, social_media_account, docker, source_code_secrets, bucket, paste, stack_exchange\n- leaks: invalid_credential, leak, mitigated_credential, valid_credential\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, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, 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: financial_data, forum_topic, forum_profile, blog_post, listing, ransomleak, seller, bot, stealer_log, chat_message, forum_post\n- open_web: source_code_files, social_media_account, bucket_object, stack_exchange, service, google, docker, bucket, paste, source_code_secrets\n- leaks: leak, invalid_credential, valid_credential, mitigated_credential\n- domains: domain\n",
"items": {
"type": "string"
},
Expand Down Expand Up @@ -669,7 +669,7 @@
"assets"
]
},
"post": {
"get": {
"responses": {
"403": {
"description": "Forbidden.",
Expand All @@ -690,7 +690,7 @@
}
}
},
"operationId": "post_asset_feeds_api_/assets/<uuid:asset_uuid>/feed",
"operationId": "get_asset_feeds_api_/assets/<uuid:asset_uuid>/feed",
"parameters": [
{
"name": "fields",
Expand Down Expand Up @@ -747,7 +747,7 @@
"name": "types",
"in": "query",
"type": "array",
"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, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, 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: financial_data, bot, blog_post, forum_post, stealer_log, listing, seller, ransomleak, chat_message, forum_profile, forum_topic\n- open_web: bucket_object, source_code_files, service, google, social_media_account, docker, source_code_secrets, bucket, paste, stack_exchange\n- leaks: invalid_credential, leak, mitigated_credential, valid_credential\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, valid_credential, invalid_credential, mitigated_credential, illicit_networks, open_web, domains, intelligence_object, 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: financial_data, forum_topic, forum_profile, blog_post, listing, ransomleak, seller, bot, stealer_log, chat_message, forum_post\n- open_web: source_code_files, social_media_account, bucket_object, stack_exchange, service, google, docker, bucket, paste, source_code_secrets\n- leaks: leak, invalid_credential, valid_credential, mitigated_credential\n- domains: domain\n",
"items": {
"type": "string"
},
Expand Down Expand Up @@ -1432,6 +1432,20 @@
"type": "integer"
}
],
"post": {
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/PaginatedCredentials"
}
}
},
"operationId": "post_leaked_credentials_feed_endpoint_/identifiers/<int:identifier_id>/feed/credentials",
"tags": [
"identifiers"
]
},
"get": {
"responses": {
"200": {
Expand All @@ -1458,20 +1472,6 @@
"tags": [
"identifiers"
]
},
"post": {
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/PaginatedCredentials"
}
}
},
"operationId": "post_leaked_credentials_feed_endpoint_/identifiers/<int:identifier_id>/feed/credentials",
"tags": [
"identifiers"
]
}
},
"/firework/v3/identifiers/{identifier_id}/relations": {
Expand Down
Loading
Loading