add_entity_insight
Related Concepts: Insights
This function adds entity insight to the selected entity identifier of the alert.
siemplify.add_entity_insight(domain_entity_info, message, case_id, alert_id)
Parameters
Param Name | Param Type | Possible Values | Comments | Mandatory Parameter |
---|---|---|---|---|
domain_entity_info | string | “8.8.8.8” | entity identifier | Yes |
message | string | “This is Google DNS” | Message to add in the entity insight. | Yes |
case_id | string | 234 | Unique Case Identifier | Yes |
alert_identifier | string | ad6879f1-b72d-419f-990c-011a2526b16d | N/A | Yes |
Return Type
Boolean
Example
Sample code
from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
entity = "8.8.8.8"
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
case_id = "234"
siemplify.add_entity_insight(domain_entity_info=entity, message=message, case_id=case_id, alert_id=alert_identifier)
Result Behavior
The given message gets added as insight to the entity 8.8.8.8 of the given alert identifier in the case 234.
Result Value
True [False if the insight is not added]