Skip to main content

changeIncidentPriority

You can use this method to change the priority of an incident.

Important

You must have a license that includes access to incidents to use this method.

Parameters

Parameter

Description

Included in request

Type

Value requirements

type

The type of the target incident.

Mandatory

String

Possible values:

  • incidents: Endpoint incident from GravityZone Control Center.

  • extendedIncidents: Organization incident from GravityZone Control Center.

incidentId

The internal ID of the incident whose priority you want to modify.

Corresponds to the incident_id parameter from the New Incident and New extended incident event types.

Mandatory

String

Must be a 24-character hexadecimal string.

Tip

The value of this parameter can be obtained from GravityZone Control Center as follows:

  1. Log in to GravityZone Control Center.

  2. Go to the Incidents page and locate the incident you want to change the priority for.

  3. Click the incident ID.

    The incident details page opens automatically, and its URL contains the value of the incidentId parameter.

    Example

    In the URL https://cloudgz.gravityzone.bitdefender.com/#!/incidents/view/6a92240ddbb8645d80cea23e, the incidentId is 6a92240ddbb8645d80cea23e.

priority

The priority to be assigned to the incident.

Mandatory

Integer

Possible values:

  • 0: Unassigned

  • 1: Low

  • 2: Medium

  • 3: High

  • 4: Critical

General parameters

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

Parameter

Description

Included in request

Type

Value requirements

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.

method

The name of the method you are using to send the request.

Mandatory

String

Must be a valid method name.

jsonrpc

The version of JSON-RPC used by the request and the response.

Mandatory

String

The only possible value is 2.0.

params

An object containing the configuration of the request.

Mandatory

Object

No additional requirements.

Return value

This method returns a Boolean, which is true if the priority of the targeted incident is changed successfully.

Note

  • This method will still return a true value if the target incident already had the specified priority assigned prior to your request.

  • The priority of the #DEMO incident cannot be modified. If you send an API request using its ID, the response will return false.

  • All incident priority changes are tracked in both the Incident history panel and the User activity page from GravityZone Control Center. Actions performed by MDR analysts are attributed to an MDR Service account.

Example

Request:

{
    "params": {
        "type": "incidents",
        "incidentId": "6a56324d89d2462496622cda",
        "priority": 3
    },
    "jsonrpc": "2.0",
    "method": "changeIncidentPriority",
    "id": "0df7568c-59c1-48e0-a31b-18d83e6d9810"
}

Response:

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