Submit detected IOCs to the Collective Insights

This operation sends a list of indicators of compromise (IOC) detections to Collective Insights.
Submissions are associated with the API key's enterprise and are used to provide enhanced intelligence
and analytics specific to your enterprise.

For each submitted detection the ioc data and a detection.type must be set. All other values are optional.

Note that all submissions of test data (for example during development) must use the options.debug property set to true.

What this endpoint does

This endpoint ingests indicator of compromise (IoC) detections from your security tools into Collective Insights. You can submit detections for five IoC types—IP addresses, domains, file hashes, vulnerabilities (CVEs), and URLs—each paired with the detection context that triggered the finding, such as a detection rule, correlation, playbook, or sandbox analysis. Optional enrichment fields allow you to include MITRE ATT&CK technique codes, associated malware names, incident references, and source metadata (e.g., firewall, IDS) for each detection. Set the debug option to true to validate submissions without persisting them, which is required for all test data during development. For an overview of the Collective Insights pipeline, consult the Collective Insights: Overview page. To query previously submitted events after they have been enriched, use the Collective Insights: Search endpoint.

Response data

A successful response confirms the processing status and, when the summary option is enabled, returns a breakdown of how many IoCs were processed for each type (IP, domain, hash, vulnerability, URL) along with details about any dropped detections. In non-debug mode, the response also includes object identifiers for the persisted detection records. Detections with unrecognized IoC types are silently dropped rather than causing errors, so review the processed counts to verify all submissions were accepted.

Body Params
data
array of objects
required

A list of detections that has been made and that should be added to Collective Insights.

data*
options
object
organization_ids
array of strings

A list of organizations to associate the submission with. The user making the request must be a member of every organization provided

organization_ids
Responses

429

This may happen on too many concurrent requests, too many requests within a timespan or requests resulting in high resource consumption. Other undisclosed limits may result in this status code as well.

500

Server error

502

Server error

503

Server error

504

Server error

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json