correlation.delete

Description

object correlation.delete(array correlationids)

This method allows to delete correlations.

This method is only available to Super admin user type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(array) IDs of the correlations to delete.

Return values

(object) Returns an object containing the IDs of the deleted correlations under the correlationids property.

Example

Delete multiple correlations

Delete two correlations.

Request:

{
           "jsonrpc": "2.0",
           "method": "correlation.delete",
           "params": [
               "1",
               "2"
           ],
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "correlationids": [
                   "1",
                   "2"
               ]
           },
           "id": 1
       }

Source

CCorrelation::delete() in ui/include/classes/api/services/CCorrelation.php.

Documentation