Updates the triage state of a single alert in the token-linked SIEM: its lifecycle status, the analyst verdict, a comment and who it is assigned to.
Operation ID: siem_update_alert
Add metadata to the response by invoking meta functions. Documentation for meta functions is available. Not all meta functions are available at every endpoint.
The triage state to move the alert to, as an OCSF Detection Finding status_id:
0: Unknown. Rejected with a400.1: New.2: InProgress.3: Suppressed. Requires averdict_idother than2(TruePositive); either violation is rejected with a400.4: Resolved.99: Other. Rejected with a400.
Providers with no distinct suppressed state read a closed alert with a false-positive (or equivalent) verdict back as 3.
The analyst verdict to record, as an OCSF Incident Finding verdict_id:
0: Unknown. Clears the verdict where the provider supports it.1: FalsePositive.2: TruePositive.3: Disregard.4: Suspicious.5: Benign.6: Test.7: InsufficientData.8: SecurityRisk.9: ManagedExternally.10: Duplicate.99: Other. Rejected with a400.
Providers store different subsets, some only on a closed alert, and a verdict the provider cannot store is rejected with a 400.
A comment to append to the alert. Comments are appended, never replaced, so re-sending the same comment adds it twice.
- Synqlyhttps://api.synqly.com/v1/siem/alerts/{id}
curl -i -X POST \
'https://api.synqly.com/v1/siem/alerts/{id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{}'Additional messages from the service response that may be helpful to the client.
Various metadata about the results organized by group, then type, then field.
The updated alert, re-fetched from the provider after the write. Omitted when the write was applied but the alert could not be read back, for example because the re-fetch failed, was rate limited or did not find the alert. The response is still a 2xx in that case, and messages carries a problem explaining why result is missing. Every provider can omit it, so callers must not assume it is present.
{ "result": { "action": "string", "action_id": 0, "activity_id": 0, "activity_name": "string", "actor": { … }, "api": { … }, "attacks": [ … ], "authorizations": [ … ], "category_name": "string", "category_uid": 0, "class_uid": 0, "cloud": { … }, "comment": "string", "confidence": "string", "confidence_id": 0, "confidence_score": 0, "count": 0, "custom_fields": {}, "device": { … }, "disposition": "string", "disposition_id": 0, "duration": 0, "end_time": 0, "end_time_dt": "2019-08-24T14:15:22Z", "enrichments": [ … ], "evidences": [ … ], "finding_info": { … }, "firewall_rule": { … }, "impact": "string", "impact_id": 0, "impact_score": 0, "malware": [ … ], "message": "string", "metadata": { … }, "observables": [ … ], "osint": [ … ], "raw_data": "string", "remediation": { … }, "resources": [ … ], "risk_details": "string", "risk_level": "string", "risk_level_id": 0, "risk_score": 0, "severity": "string", "severity_id": 0, "start_time": 0, "start_time_dt": "2019-08-24T14:15:22Z", "status": "string", "status_code": "string", "status_detail": "string", "status_id": 0, "time": 0, "time_dt": "2019-08-24T14:15:22Z", "timezone_offset": 0, "type_name": "string", "type_uid": 0, "unmapped": {}, "vulnerabilities": [ … ] }, "messages": { "problems": [ … ] }, "meta": { "stats": { … }, "api": { … }, "mapping": { … } } }