updateIncidentNote

This method assigns a note to an incident.

Important

This method has been updated to version 1.1. For information applicable to version 1.0, refer to this section.

Parameters

Parameter	Type	Optional	Description and value requirements
`type`	String	No	The type of the target incident. Possible values: `incidents`: Endpoint incident from GravityZone Control Center `extendedIncidents`: Organization incident from GravityZone Control Center
`incidentId`	String	No	The ID of the incident, obtained from the Event Push details. The value corresponds to the `incident_id` parameter from New incident and New extended incident event types. Tip You can get the ID of a specific incident from GravityZone Control Center by following these steps: Log in to GravityZone Control Center. Go to the Incidents page and find the incident you want to update the note for. Select the three-dot menu icon on the right side of the table in the row of the target incident. Select View events and alerts. A new browser window opens with the incident details. The incident ID is included in the URL of the page. Example https://cloudgz.gravityzone.bitdefender.com/#!/xdr/events/65dc39197a4a51fb2b7f15ee The incident ID is `65dc39197a4a51fb2b7f15ee`.
`note`	String	No	The text to be included in the note. A maximum of 50,000 characters is allowed for the note. All whitespace or empty note values are not supported. Note If the incident already has a note assigned to it, it will be overwritten.

Parameter

Type

Optional

Description and value requirements

type

String

The type of the target incident.

Possible values:

incidents: Endpoint incident from GravityZone Control Center
extendedIncidents: Organization incident from GravityZone Control Center

incidentId

String

The ID of the incident, obtained from the Event Push details. The value corresponds to the incident_id parameter from New incident and New extended incident event types.

Tip

You can get the ID of a specific incident from GravityZone Control Center by following these steps:

Log in to GravityZone Control Center.
Go to the Incidents page and find the incident you want to update the note for.
Select the three-dot menu icon on the right side of the table in the row of the target incident.
Select View events and alerts.
A new browser window opens with the incident details. The incident ID is included in the URL of the page.
Example
```
https://cloudgz.gravityzone.bitdefender.com/#!/xdr/events/65dc39197a4a51fb2b7f15ee
```
The incident ID is 65dc39197a4a51fb2b7f15ee.

note

String

The text to be included in the note.

A maximum of 50,000 characters is allowed for the note. All whitespace or empty note values are not supported.

Note

If the incident already has a note assigned to it, it will be overwritten.

General parameters

These are common parameters, available across all public API methods.

Parameter	Description	Included in request	Type	Values
`id`	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. Example "id": "ad12cb61-52b3-4209-a87a-93a8530d91cb"
`method`	The name of the method you are using to send the request.	Mandatory	String	Must be a valid method name. Example "method": "methodName"
`jsonrpc`	The version of JSON-RPC used by the request and the response.	Mandatory	String	Possible values: `"2.0"` Example "jsonrpc": "2.0"
`params`	An object containing the configuration of the request.	Mandatory	Object	No additional requirements. Example "params": {...}

Return value

This method returns a Boolean value that is true if the note is assigned successfully.

Example

Request:

{
    "params": {
        "incidentId": "621342db44747b408b7edf65",
        "type": "extendedIncidents",
        "note": "A random note"
    },
    "jsonrpc": "2.0",
    "method": "updateIncidentNote",
    "id": "0df7568c-59c1-48e0-a31b-18d83e6d9810"
}

Response:

{
    "id": "0df7568c-59c1-48e0-a31b-18d83e6d9810",
    "jsonrpc": "2.0",
    "result": true
}

Version 1.0

Parameters

Parameter	Type	Optional	Description and value requirements
`type`	String	No	The type of the target incident. Possible values: `incidents`: Endpoint incident from GravityZone Control Center `extendedIncidents`: Organization incident from GravityZone Control Center
`incidentId`	String	No	The ID of the incident, obtained from the Event Push details. The value corresponds to the `incident_id` parameter from New incident and New extended incident event types. Tip You can get the ID of a specific incident from GravityZone Control Center by following these steps: Log in to GravityZone Control Center. Go to the Incidents page and find the incident you want to update the note for. Select the three-dot menu icon on the right side of the table in the row of the target incident. Select View events and alerts. A new browser window opens with the incident details. The incident ID is included in the URL of the page. Example https://cloudgz.gravityzone.bitdefender.com/#!/xdr/events/65dc39197a4a51fb2b7f15ee The incident ID is `65dc39197a4a51fb2b7f15ee`.
`note`	String	No	The text to be included in the note. A maximum of 50,000 characters is allowed for the note. All whitespace or empty note values are not supported. Note If the incident already has a note assigned to it, it will be overwritten.

Parameter

Type

Optional

Description and value requirements

type

String

The type of the target incident.

Possible values:

incidents: Endpoint incident from GravityZone Control Center
extendedIncidents: Organization incident from GravityZone Control Center

incidentId

String

The ID of the incident, obtained from the Event Push details. The value corresponds to the incident_id parameter from New incident and New extended incident event types.

Tip

You can get the ID of a specific incident from GravityZone Control Center by following these steps:

Log in to GravityZone Control Center.
Go to the Incidents page and find the incident you want to update the note for.
Select the three-dot menu icon on the right side of the table in the row of the target incident.
Select View events and alerts.
A new browser window opens with the incident details. The incident ID is included in the URL of the page.
Example
```
https://cloudgz.gravityzone.bitdefender.com/#!/xdr/events/65dc39197a4a51fb2b7f15ee
```
The incident ID is 65dc39197a4a51fb2b7f15ee.

note

String

The text to be included in the note.

A maximum of 50,000 characters is allowed for the note. All whitespace or empty note values are not supported.

Note

If the incident already has a note assigned to it, it will be overwritten.

General parameters

These are common parameters, available across all public API methods.

Parameter	Description	Included in request	Type	Values
`id`	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. Example "id": "ad12cb61-52b3-4209-a87a-93a8530d91cb"
`method`	The name of the method you are using to send the request.	Mandatory	String	Must be a valid method name. Example "method": "methodName"
`jsonrpc`	The version of JSON-RPC used by the request and the response.	Mandatory	String	Possible values: `"2.0"` Example "jsonrpc": "2.0"
`params`	An object containing the configuration of the request.	Mandatory	Object	No additional requirements. Example "params": {...}

Return value

This method returns a result Object containing a success Boolean, which is true if the note was successfully updated.

Example

Request:

{
    "params": {
        "incidentId": "621342db44747b408b7edf65",
        "type": "incidents",
        "note": "A random note"
    },
    "jsonrpc": "2.0",
    "method": "updateIncidentNote",
    "id": "0df7568c-59c1-48e0-a31b-18d83e6d9810"
}

Response:

{
    "id": "0df7568c-59c1-48e0-a31b-18d83e6d9810",
    "jsonrpc": "2.0",
    "result": {
        "success": true
    }
}

In this section:

updateIncidentNote

Important

Parameters

Tip

Note

General parameters

Return value

Example

Version 1.0

Parameters

Tip

Note

General parameters

Return value

Example

Search results