Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

DELETE /ariel/searches/{search_id}

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