getIncident
You can use this method to retrieve information regarding a specific incident, by referencing it's ID.
Important
API url:
CONTROL_CENTER_APIs_ACCESS_URL/v1.2/jsonrpc/incidents.To use this method, you must have a license or subscription with access to incidents.
Parameters
Parameter | Description | Included in request | Type | Values |
|---|---|---|---|---|
| The ID of the incident you want to retrieve information for. This ID is included in the URL of the incident details page from GravityZone Control Center. | Mandatory | String | The value must be the ID of an incident accessible to you. It should contain exactly 24 hexadecimal characters. |
These are common parameters, available across all public API methods:
Parameter | Description | Included in request | Type | Value requirements |
|---|---|---|---|---|
| This parameter adds an identifier to the request, linking it to its corresponding response. The target replies with the same value in the response, allowing easy call tracking. | Mandatory | String | No additional requirements. |
| The name of the method you are using to send the request. | Mandatory | String | Must be a valid method name. |
| The version of JSON-RPC used by the request and the response. | Mandatory | String | The only possible value is |
| An object containing the configuration of the request. | Mandatory | Object | No additional requirements. |
Return value
Attribute | Type | Description |
|---|---|---|
| Object | Details about the incident referenced in the request. For more information, refer to |
Objects
result
Attribute | Type | Description |
|---|---|---|
| String | The internal incident ID, which is included in the URL of the incident details page from GravityZone Control Center. |
| Integer | The incident ID displayed in GravityZone Control Center, in the Incidents page, without the |
| String | The type of the incident. Possible values:
The value of this field determines what information is included in the |
| Object | Details about the company where the incident was generated. The object contains the following settings:
|
| String | The status of the incident. Possible values:
|
| String | The incident type, determined by the main action that was taken automatically by the protection technologies when it was detected. Possible values:
|
| String | The date and time when the incident was detected in the network, in ISO-8601 format. |
| String | The timestamp of the latest incident update received from BEST, in ISO-8601 format. This value changes when the incident evolves, for example when new activity, events, or related entities are added to the incident. |
| String | The timestamp of the latest incident update received and processed by GravityZone Control Center, in ISO-8601 format. This value changes when the incident evolves, for example when new activity, events, or related entities are added to the incident. |
| String | The date and time of the most recent change to an incident, regardless of the source, including BEST updates and GravityZone user actions such as status, priority, assignee, or note updates. |
| Integer | The severity score assigned to the incident, as reported by the detection technologies. Possible values: |
| String | A URL linking to a web page where the incident details can be viewed in a browser. |
| Object | The GravityZone user that is assigned to this incident. The object contains the following settings:
|
| String | The priority assigned to the incident. Possible values:
|
| Array of Strings | A list of attack types detected in the incident. Each String can be, for example:
|
| Object | Additional information regarding the incident. The information depends on the value assigned to the When
When
|
| Array of Objects | A list of notes that were attached to the incident. Each note contains the following settings:
|
partOf (Endpoint and Organization incidents) and contains (Organization incidents)
Attribute | Type | Description |
|---|---|---|
| String | The ID of the incident. |
| String | A URL that can be used to open the incident in GravityZone Control Center after logging in. |
counters (Endpoint incidents)
Attribute | Type | Description |
|---|---|---|
| Integer | The number of endpoints involved in the incident. |
| Integer | The number of files involved in the incident. |
| Integer | The number of processes involved in the incident. |
| Integer | The number of domains involved in the incident. |
| Integer | The number of registry keys involved in the incident. This applies only to endpoints that use Windows. |
| Integer | The number of system events involved in the incident. |
| Integer | The number of storage devices involved in the incident. |
counters (Organization incidents)
Attribute | Type | Description |
|---|---|---|
| Integer | The number of endpoints involved in the incident. |
| Integer | The number of servers involved in the incident. |
| Integer | The number of mobile devices involved in the incident. |
| Integer | The number of printers involved in the incident. |
| Integer | The number of routers involved in the incident. |
| Integer | The number of Internet-of-Things involved in the incident. |
| Integer | The number of identities involved in the incident. |
| Integer | The number of emails involved in the incident. |
| Integer | The number of IPs involved in the incident. |
| Integer | The number of domains involved in the incident. |
| Integer | The number of domain name servers involved in the incident. |
| Integer | The number of domain generation algorithms (DGAs) involved in the incident. |
| Integer | The number of cloud storages involved in the incident. |
| Integer | The number of Tor nodes involved in the incident. |
| Integer | The number of external drives involved in the incident. |
| Integer | The number of external sources involved in the incident. |
| Integer | The number of exfiltrated files involved in the incident. |
| Integer | The number of internal IPs involved in the incident. |
| Integer | The number of internal emails involved in the incident. |
| Integer | The number of users involved in the incident. |
| Integer | The number of virtual desktops involved in the incident. |
| Integer | The number of containers (docker, k8s, etc.) involved in the incident. |
| Integer | The number of databases involved in the incident. |
| Integer | The number of storages involved in the incident. |
| Integer | The number of Microsoft 365 (Office 365) instances involved in the incident. |
| Integer | The number of Active Directory instances involved in the incident. |
| Integer | The number of Azure Active Directory instances involved in the incident. |
| Integer | The number of Google Cloud Platform instances involved in the incident. |
| Integer | The number of Google Workspace instances involved in the incident. |
| Integer | The number of Atlassian instances involved in the incident. |
| Integer | The number of Atlassian Bitbucket products involved in the incident. |
| Integer | The number of Atlassian Jira products involved in the incident. |
| Integer | The number of Atlassian Confluence products involved in the incident. |
| Integer | The number of Bitbucket projects involved in the incident. |
| Integer | The number of Confluence spaces involved in the incident. |
| Integer | The number of AWS instances involved in the incident. |
nodes (Endpoint incidents)
Attribute | Type | Description |
|---|---|---|
| String | The ID of the node. |
| String | The name of the node. |
| String | The type of the node. Possible values:
|
| Array of Strings | A list of alert IDs. These correlate with the objects from |
| Object | The details available for the node. The data contained by this object varies based on the value of the When
When
When
When
When
For any other types, the |
fileProcess (file node) and process (registry or domain node)
Attribute | Type |
|---|---|
| Integer |
| String |
| String |
sandbox (file or process_execution node)
Attribute | Type |
|---|---|
| String |
quarantine (file or process_execution node)
Attribute | Type |
|---|---|
| String |
file (process_execution node)
Attribute | Type |
|---|---|
| String |
| String |
| String |
| String |
| Integer |
| Boolean |
process (process_execution node)
Attribute | Type | Description |
|---|---|---|
| Integer | |
| String | |
| String | |
| String | |
| String | |
| String | |
| Object | The Object contains:
|
killProcess (process_execution node)
Attribute | Type |
|---|---|
| String |
| Integer |
registry (registry node)
Attribute | Type |
|---|---|
| String |
| String |
| String |
domain (domain node)
Attribute | Type |
|---|---|
| String |
| Integer |
| String |
| String |
| String |
| String |
file (domain node)
Attribute | Type |
|---|---|
| Integer |
| String |
| String |
nodes (Organization incidents)
Attribute | Type | Description |
|---|---|---|
| String | The ID of the node. |
| String | The name of the node. |
| Boolean | Indicates if the node is a resource from the client’s network or not. |
| String | The type of the node. Possible values:
|
| Object | The details available for this node. The data contained by this object varies based on the value of the |
details (Organization incident node)
Value of | Attribute | Type |
|---|---|---|
|
| String |
| Array of Strings | |
| Array of Strings | |
| String | |
|
| String |
| Array of Strings | |
| Array of Strings | |
| String | |
| Array of Strings | |
|
| String |
| String | |
| String | |
| String | |
| String | |
|
| String |
| String | |
|
| String |
|
| String |
| Array of Strings | |
| String | |
| Array of Strings | |
|
| String |
| Array of Strings | |
| String | |
|
| String |
| Array of Strings | |
|
| String |
|
| String |
| String | |
|
| String |
| String | |
|
| String |
| String | |
|
| Array of Strings |
| Array of Strings | |
| String | |
|
| Array of Strings |
| Array of Strings | |
| String | |
|
| Array of Strings |
| Array of Strings | |
| String | |
|
| Array of Strings |
| Array of Strings | |
| String | |
| String | |
| String | |
|
| Array of Strings |
| Array of Strings | |
| String | |
| String | |
| String | |
| String | |
|
| Array of Strings |
| Array of Strings | |
| String | |
| String | |
|
| String |
|
| String |
| Array of Strings | |
| Array of Strings | |
|
| String |
|
| String |
| String | |
|
| String |
| String | |
| String |
alerts (Endpoint incidents)
Attribute | Type | Description |
|---|---|---|
| String | The ID of the alert. |
| String | The name of the alert. |
| String | The date and time when the alert was detected in the network. |
| Object | The object contains information about who detected the alert:
|
| Array of Objects | The objects contain information regarding the resources involved in the alert:
|
| Array of Objects | Extra information for the alert. Each object contains:
|
details (alerts > resources)
Value of | Attribute | Type |
|---|---|---|
|
| String |
| Integer | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
|
| String |
| String | |
| Integer | |
| String | |
| Integer | |
| String | |
| String | |
| String | |
| String | |
| String | |
| Integer | |
| Integer | |
| Integer | |
| Integer | |
| String | |
| String | |
| Integer | |
| Integer | |
| String | |
| Integer | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| Integer | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| Integer | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
| String | |
|
| Integer |
| String | |
| Integer | |
| String | |
| Integer | |
| String | |
| String | |
| String | |
| String | |
| String | |
| Integer | |
| String | |
| Integer | |
| String | |
| Integer | |
| Integer | |
| String | |
| String | |
| String | |
| String | |
| String | |
|
| String |
| String | |
| String | |
| String | |
| String |
alerts (Organization incidents)
Attribute | Type | Description |
|---|---|---|
| String | The ID of the alert. |
| String | The name of the alert. |
| String | The date and time when the alert was detected in the network, in ISO-8601 format. |
| Array of Strings | Sensors that detected the alert. Possible values:
|
| String | The MITRE tactic detected for this alert. Possible values:
|
| Array of Objects | This array contains data used to build the incident graph. It indicates how nodes connect. Each Object contains:
|
resources (Organization incident transition)
Attribute | Type | Description |
|---|---|---|
| String | The name of the resource. |
| String | The type of the resource. Possible values:
|
| Object | Details for the resource. Schema depends on the For more information on the fields included in this object, refer to |
details (Organization incident resource)Value of | Attribute | Type (and description) |
|---|---|---|
|
| String |
|
| String |
| String | |
|
| String |
|
| String |
| String | |
| Integer | |
| String | |
| String | |
| String | |
|
| String |
| String | |
| String | |
| String | |
| String | |
| String (ISO-8601) | |
| String | |
| Object Contains the following attributes:
| |
| Array of Objects Each Object contains the following attributes:
| |
| Array of Objects Each Object contains the following attributes:
| |
| Array of Objects Each Object contains the following attributes:
| |
| Array of Strings | |
| Array of Objects Each Object contains the following attributes:
| |
|
| String |
|
| String |
| String | |
| String | |
|
| String |
| String | |
|
| String |
|
| String |
| String | |
|
| String |
| String |
transitions (Endpoint incidents)
Attribute | Type | Description |
|---|---|---|
| String | The ID of the origin node. |
| String | The ID of the destination node. |
| String | The date and time of the transition, in ISO-8601 format. |
mitreTags (Endpoint and Organization incidents)
Attribute | Type | Description |
|---|---|---|
| String | The category the MITRE technique belongs to. |
| Array of Objects | The MITRE techniques detected for this category. Each object contains:
|
subtechniques (mitreTags > techniques)
Attribute | Type | Description |
|---|---|---|
| String | The ID of the MITRE sub-technique (for example, |
| String | The name of the MITRE sub-technique (for example, |
cves (Organization incidents)
Attribute | Type | Description |
|---|---|---|
| String | The ID of a CVE (for example, |
suspectedActors (Organization incidents)
Attribute | Type | Description |
|---|---|---|
| String | The name of the suspected actor. |
| Integer | Confidence score for correlating the attack with this actor. |
| Array of Objects | Reasons why this attack was correlated with this actor. Each Object contains:
|
incidentEvolution (Endpoint and Organization incidents)
Attribute | Type | Description |
|---|---|---|
| String | The internal incident ID, which is included in the URL of the incident details page from GravityZone Control Center. |
| Integer | The incident ID displayed in GravityZone Control Center, in the Incidents page, without the |
| String | The status of the incident. Possible values:
|
| String | A URL linking to a web page where the incident details can be viewed in a browser. |
Examples
Request:
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"jsonrpc": "2.0",
"method": "getIncident",
"params": {
"id": "6a1b2c3d4e5f67890abcdef0"
}
}Response: