Get Incidents
POST /Command/GetIncidents
Gets a list of filtered incidents with specified fields.
Request
Authentication: API keys or JSON web tokens (JWT)
Body Parameters
Parameter Name | Type | Required/Optional | Description |
---|---|---|---|
Username |
| Required | The username of the D3 SOAR user account making the request. |
Site |
| Required | The D3 SOAR site containing the desired incidents to retrieve with the request. |
Filter |
| Optional | The filter serve to filter data. The "field" key indicates the selected field in the incident, the "operator" key signifies the condition operator applied to the field, and the "value" key represents the desired value. The "section" key is optional; however, if a "section" key is added, it will be treated as a dynamic field for filtering. "AND" logic applies between JSON objects in the same array, "OR" logic applies between different arrays. Valid values for the "field" key as a non-dynamic field are every valid key in the "Static Fields" section except "Incident Raw Data". (Input must be in JSON format) Available operators: ["<",">","=","<=",">=","!=","LIKE","IS EMPTY","IS NOT EMPTY"] |
Static Fields |
| Optional | Select the static incident field keys to be displayed in the result. The keys available for selection are listed below. In the case of an empty input, only general keys will be selected for each resulting incident. General keys are every key in the list below except for "Date Closed", "Closed by", "Incident Raw Data", and "Custom Field". The "Playbook" field returns playbooks that have either been completed or stopped on error. Note: "Date Created", "Date Modified", and "Date Closed" is in UTC time. Input must be in JSON format. |
Dynamic Fields |
| Optional | Select the dynamic incident fields to be displayed in the result. The key in the JSON object is the dynamic field section name. The value array contains the names of the elements under the section. Input must be in JSON format. |
Start Time |
| Required | The start of the date range for incidents. Based on 'Date Created' (UTC) of the incident. |
End Time |
| Required | The end of the date range for incidents. Based on 'Date Created' (UTC) of the incident. |
Output Format |
| Optional | 1 - CSV, 2 - JSON, 3 - CSV link, 4 - JSON link. |
Page Index |
| Optional | The page number to receive results from. The default page index is 0. In the case of extensive datasets, the total pages within the key fields section will be shown as "N/A." Note: if no value or 0 is given for both Page Index and Page Size, all incidents will be fetched. If pagination index is provided, total pages will show in key fields outputs. |
Page Size |
| Optional | The maximum number of incidents to fetch, ranges from 1 to 1000. If no value or 0 is given, a default page size of 100 will be applied. In the case of extensive datasets, the total pages within the key fields section will be shown as "N/A." Note: if no value or 0 is given for both Page Index and Page Size, all incidents will be fetched. If pagination size is provided, total pages will show in key fields outputs. |
READER NOTE
Static Fields represents an input parameter as an array of strings. Each field in this array is optional. If you include these fields, the response will contain the specified fields. The fields are:
IR Number, IR Type, Title, Status, Severity, Stage, Priority, Disposition, Tags, Owner, Creator, Timezone, Date Created, Date Modified, Playbook, Description, Conclusion, Investigation Team, Linked Incidents, Incident Raw Data, Event Raw Data
READER NOTE
The fields Incident Raw Data and Event Raw Data can contain large amounts of data. Use these fields cautiously and consider using pagination input parameters (page index and page number) to manage the data volume efficiently.
READER NOTE
For Date/Time parameters Start Time
and End Time
, all times and timestamps must follow the format: yyyy-mm-dd hh:mm:ss
.
e.g. May 15, 2024, 2:32 PM should be written as 2024-05-15 14:32:00.