Delete a search

Permanently delete the saved search and all its associated data. This action cannot be undone.

The saved search must be shared with the API, and when deleted will be removed from the users saved searches.

DELETE /searches/{searchId}

Delete a search

cURL

curl --request DELETE \
  --url https://app.tryspecter.com/api/v1/searches/{searchId} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://app.tryspecter.com/api/v1/searches/{searchId}"

headers = {"X-API-Key": "<api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {'X-API-Key': '<api-key>'}};

fetch('https://app.tryspecter.com/api/v1/searches/{searchId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.tryspecter.com/api/v1/searches/{searchId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.tryspecter.com/api/v1/searches/{searchId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://app.tryspecter.com/api/v1/searches/{searchId}")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.tryspecter.com/api/v1/searches/{searchId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

400

{
  "errorCode": "BAD_SEARCH_ID_TYPE",
  "message": "The search id needs to be a number."
}

{
  "errorCode": "API_KEY_MISSING",
  "message": "No API Key was presented on the header X-API-KEY"
}

{
  "errorCode": "NOT_PERMITTED",
  "message": "You do not have permission to access this resource."
}

Authorizations

X-API-Key · string · header · required

Path Parameters

searchId · string · required

The ID of the saved search being requested.

Response

200

Ok