DELETE /siem/offense_saved_searches/{id}

SUMMARY Deletes an offense saved search. To ensure safe deletion, a dependency check is carried out. This check might take some time. An asynchronous task to do is started for this check.

Deletes an offense saved search. To ensure safe deletion, a dependency check is carried out. This check might take some time. An asynchronous task to do is started for this check.

Table 1: DELETE /siem/offense_saved_searches/{id} resource details:
DELETE /siem/offense_saved_searches/{id} resource details
MIME Type
application/json

Table 2: DELETE /siem/offense_saved_searches/{id} request parameter details:
DELETE /siem/offense_saved_searches/{id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
id	path	Required	Number (Integer)	text/plain	null
Range	header	Optional	String	text/plain	Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.
filter	query	Optional	String	text/plain	Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

Table 3: DELETE /siem/offense_saved_searches/{id} response codes:
DELETE /siem/offense_saved_searches/{id} response codes
HTTP Response Code	Unique Code	Description
202		The offense saved search delete command was accepted and is in progress.
403	1009	You do not have the required capabilities to delete the offense saved search.
404	1002	The offense saved search does not exist.
500	1020	An error occurred during the attempt to delete the offense saved search.

Response Description

A Delete Task Status object and the location header set to the task status url "/api/siem/offense_saved_search_delete_tasks/{task_id}". A Delete Task Status object contains the following fields:

id - Long - The ID of the task.
message - String - The localized task message.
status - String - The current state of the task.
name - String - The name of the task.
created_by - String - The name of the user who started the task.
created - Long - The time in milliseconds since epoch since the task was created.
started - Long - The time in milliseconds since epoch since the task was started.
modified - Long - The time in milliseconds since epoch since the task was modified.
completed - Long - The time in milliseconds since epoch since the task was completed.

ON THIS PAGE

DELETE /siem/offense_saved_searches/{id}

Response Description

Response Sample