List all index names

List the names of all indexes that currently exist.

GET /api/v1/indexes/list

List all index names

cURL

curl --request GET \
  --url https://api.example.com/api/v1/indexes/list \
  --header 'X-Eigen-API-Key: <api-key>'

import requests

url = "https://api.example.com/api/v1/indexes/list"

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

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

print(response.text)

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

fetch('https://api.example.com/api/v1/indexes/list', 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/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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/list"

	req, _ := http.NewRequest("GET", 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.get("https://api.example.com/api/v1/indexes/list")
  .header("X-Eigen-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/indexes/list")

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

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

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

200

{
  "status": 200,
  "message": "Indexes listed successfully",
  "data": {
    "indexes": [
      "hello-world",
      "fubar",
      "some-thing"
    ]
  }
}

{
  "status": 500,
  "message": "An error occured while listing indexes.",
  "error": {
    "code": "INDEXES_NOT_LISTED",
    "description": "detailed description of the error..."
  }
}

Authorizations

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

Response

200

application/json

Stats fetched successfully.

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