Incidents
Incidents - Close
Closes the incident with the given id.
POST
https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/Incidents/{id}/closeParameters
id
-
String
The incident id to close. Mandatory Field
incident_user_id
-
String
ID of the user on whose behalf you want to close the incident. Use Users - FetchUsers to obtain value for this parameter. Mandatory Field
Request Example
{
"data": {
"incident_user_id": "5a46xxxx"
}
}Success Response
{
"status": "Success",
"message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}API Response
Incidents - Comment
Adds comment on the incident with the given id.
POST
Parameters
comment
Comment
String
Comment for the incident. Mandatory Field
id
-
String
The incident id to comment on. Mandatory Field
incident_user_id
-
String
ID of the user on whose behalf you want to comment on the incident. Use Users - FetchUsers to obtain value for this parameter. Mandatory Field
Request Example
Success Response
API Response
Incidents - FetchIncidentData
Fetches all the logs of the incident of the given id.
POST
Parameters
id
-
String
ID of the incident whose logs you want to fetch. Mandatory Field
Request Example
Success Response
API Response
Incidents - FetchIncidents
Fetches the incidents based on filter conditions.
POST
Parameters
assigned_to_users
USERS
[String]
List of IDs of the users who are assigned the incident. Optional Field
attack_category
ATTACK CATEGORY
[String]
List of attack categories. The API filters the incidents that match all the attack categories in the provided list. You can use the MitreAttack - FetchMitreAttacks API to fetch the details of the attack categories available in the Fabric-enabled LogPoint. Optional Field
attack_tag
ATTACK TAG
[String]
List of attack tags. The API filters the incidents that match all the attack tags in the provided list. You can use the MitreAttack - FetchMitreAttacks API to fetch the details of the attack tags available in the Fabric-enabled LogPoint. Optional Field
end_date
-
int
End Date in epoch. Mandatory only when start_date is present in the request. Optional Field
log_source
LOG SOURCES
[String]
List of log sources. The API filters the incidents that match all the log sources in the provided list. Optional Field
name
NAME (OR ID)
String
It can be name of the incident or ID of alertrule or ID of incident to fetch. It can be a regex. Optional Field
risk
RISK
[String]
List of the risk level of the Incident. Accepts values such as "low", "medium", "high" and "critical". Optional Field
start_date
-
int
Start Date in epoch. Mandatory only when end_date is present in the request. Optional Field
status
STATUS
[String]
List of the status of the incident. Accepts values such as "resolved", "unresolved" and "closed". Optional Field
type
TYPE
[String]
List of types from which incident is generated. Accepts values such as "alert", "search" and "UEBA". Optional Field
Request Example
Success Response
API Response
Incidents - GetIncidentData
List the contents of the incident data from given Incident.
You should perform FetchIncidentData API request before GetIncidentData to get the updated incident data.
GET
Parameters
id
String
Existing Incident id.
Success Response
Incidents - Reassign
Reassigns the incident with the given id to a new user.
POST
Parameters
id
-
String
The incident id to reassign. Mandatory Field
incident_user_id
-
String
ID of the user on whose behalf you want to reassign the incident. Use Users - FetchUsers to obtain value for this parameter. Mandatory Field
Request Example
Success Response
API Response
Incidents - Reopen
Reopens the incident with the given id.
POST
Parameters
id
-
String
The incident id to reopen. Mandatory Field
incident_user_id
-
String
ID of the user on whose behalf you want to reopen the incident. Use Users - FetchUsers to obtain value for this parameter. Mandatory Field
Request Example
Success Response
API Response
Incidents - Resolve
Resolves the incident with the given id.
POST
Parameters
id
-
String
The incident id to resolve. Mandatory Field
incident_user_id
-
String
ID of the user on whose behalf you want to resolve the incident. Use Users - FetchUsers to obtain value for this parameter. Mandatory Field
Request Example
Success Response
API Response
Incidents - SendForInvestigation
Manually trigger notifications for the incident with the given ID.
POST
Parameters
id
-
String
ID of the incident. Use the Incidents - FetchIncidents API to obtain the value of this parameter. Mandatory Field
incident_user_id
-
String
ID of the user on whose behalf you want to trigger the incident notification. Use the Users - FetchUsers API to obtain value for this parameter. Mandatory Field
Request Example
Success Response
API Response
Last updated
Was this helpful?