DELETE /ariel/searches/{search_id}

date_range 24-May-22

arrow_backward

arrow_forward

SUMMARY Deletes an Ariel search.

Deletes an Ariel search. This discards any results that were collected and stops the search if it is in progress. This search is deleted regardless of whether the results were saved.

Table 1: DELETE /ariel/searches/{search_id} resource details:
DELETE /ariel/searches/{search_id} resource details
MIME Type
application/json

Table 2: DELETE /ariel/searches/{search_id} request parameter details:
DELETE /ariel/searches/{search_id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
search_id	path	Required	String	text/plain	Required - The search ID of the search to delete.

Table 3: DELETE /ariel/searches/{search_id} response codes:
DELETE /ariel/searches/{search_id} response codes
HTTP Response Code	Unique Code	Description
202		The delete request has been accepted.
404	1002	The search does not exist.
422	1005	A request parameter is not valid.
500	1020	An error occurred during the attempt to delete the search.
503	1010	The ariel server might be temporarily unavailable or offline. Please try again later.

Response Description

Information about the deleted search.

Response Sample

content_copy zoom_out_map
{
  "cursor_id": "s16",
  "compressed_data_file_count": 0,
  "compressed_data_total_size": 0,
  "data_file_count": 5470,
  "data_total_size": 67183115,
  "index_file_count": 0,
  "index_total_size": 0,
  "processed_record_count": 1256462,
  "error_messages": [
    {
      "code": "String",
      "contexts": [
        "String"
      ],
      "message": "String",
      "severity": "String <one of: INFO, WARN, ERROR>"
    }
  ],
  "desired_retention_time_msec": 86400000,
  "progress": 46,
  "progress_details": [
    0,
    0,
    0,
    0,
    66957,
    652657,
    76594,
    89809,
    86032,
    107729
  ],
  "query_execution_time": 1480,
  "query_string": "SELECT sourceip, starttime, qid, sourceport  from events into s16 where sourceip in (select destinationip from events) parameters snapshotsize=2, PROGRESSDETAILSRESOLUTION=10",
  "record_count": 1240923,
  "save_results": false,
  "status": "String <one of: WAIT, EXECUTE, SORTING, COMPLETED, CANCELED, ERROR>",
  "snapshot": {
    "events": [
      {
        "sourceip": "10.100.65.20",
        "starttime": 1467049610018,
        "qid": 10034,
        "sourceport": 13675
      },
      {
        "sourceip": "10.100.100.121",
        "starttime": 1467049610019,
        "qid": 20034,
        "sourceport": 80
      }
    ]
  },
  "subsearch_ids": [
     "sub_id_1"
   ],
  "search_id": "s16"
}

arrow_backward PREVIOUS POST /ariel/searches

NEXT arrow_forward GET /ariel/searches/{search_id}

REST API Version 17.0 References

ON THIS PAGE

DELETE /ariel/searches/{search_id}

Response Description

Response Sample

Stay in touch

Helped me install or use the product
Accelerated my deployment

Discuss the product with a co-worker
Make a purchase inquiry