Delete an index

Delete an index given its name.

DELETE /api/v1/indexes/{indexName}/delete

Delete an index

cURL

curl --request DELETE \
  --url https://api.example.com/api/v1/indexes/{indexName}/delete \
  --header 'X-Eigen-API-Key: <api-key>'

import requests

url = "https://api.example.com/api/v1/indexes/{indexName}/delete"

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

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

print(response.text)

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

fetch('https://api.example.com/api/v1/indexes/{indexName}/delete', 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://api.example.com/api/v1/indexes/{indexName}/delete",
  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-Eigen-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://api.example.com/api/v1/indexes/{indexName}/delete"

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

	req.Header.Add("X-Eigen-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://api.example.com/api/v1/indexes/{indexName}/delete")
  .header("X-Eigen-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/indexes/{indexName}/delete")

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

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

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

200

{
  "status": 200,
  "message": "Index '<indexName>' successfully deleted."
}

{
  "status": 500,
  "message": "An error occured while deleting the index.",
  "error": {
    "code": "INDEX_NOT_DELETED",
    "description": "detailed description of the error..."
  }
}

Authorizations

X-Eigen-API-Key · string · header · required

Path Parameters

indexName · string · required

Name of the index

Response

200

application/json

Index successfully deleted.

status · integer · required

Status code of the response

message · string · required

Message giving basic information on the response

data · object

Important data to be given to the caller

error · object

An error that has occured

Show child attributes