List indexes - AIMP Documentation

cURL

curl --request GET \
  --url https://{baseUrl}/{version}/projects/{projectId}/indexes \
  --header 'content-type: <content-type>' \
  --header 'x-api-key: <x-api-key>'

import requests

url = "https://{baseUrl}/{version}/projects/{projectId}/indexes"

headers = {
    "content-type": "<content-type>",
    "x-api-key": "<x-api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'content-type': '<content-type>', 'x-api-key': '<x-api-key>'}
};

fetch('https://{baseUrl}/{version}/projects/{projectId}/indexes', 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://{baseUrl}/{version}/projects/{projectId}/indexes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "content-type: <content-type>",
    "x-api-key: <x-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://{baseUrl}/{version}/projects/{projectId}/indexes"

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

	req.Header.Add("content-type", "<content-type>")
	req.Header.Add("x-api-key", "<x-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://{baseUrl}/{version}/projects/{projectId}/indexes")
  .header("content-type", "<content-type>")
  .header("x-api-key", "<x-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{baseUrl}/{version}/projects/{projectId}/indexes")

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

request = Net::HTTP::Get.new(url)
request["content-type"] = '<content-type>'
request["x-api-key"] = '<x-api-key>'

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

{
  "indexes": [
    {
      "projectId": "<string>",
      "indexName": "<string>",
      "mappings": {},
      "numDocs": 123,
      "cloneSourceInfo": {
        "sourceProjectId": "<string>",
        "sourceIndexName": "<string>",
        "sourceIndexVersionId": "<string>"
      },
      "indexStatus": "CREATING",
      "indexClass": "STANDARD"
    }
  ]
}

GET

projects

{projectId}

indexes

cURL

curl --request GET \
  --url https://{baseUrl}/{version}/projects/{projectId}/indexes \
  --header 'content-type: <content-type>' \
  --header 'x-api-key: <x-api-key>'

import requests

url = "https://{baseUrl}/{version}/projects/{projectId}/indexes"

headers = {
    "content-type": "<content-type>",
    "x-api-key": "<x-api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'content-type': '<content-type>', 'x-api-key': '<x-api-key>'}
};

fetch('https://{baseUrl}/{version}/projects/{projectId}/indexes', 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://{baseUrl}/{version}/projects/{projectId}/indexes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "content-type: <content-type>",
    "x-api-key: <x-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://{baseUrl}/{version}/projects/{projectId}/indexes"

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

	req.Header.Add("content-type", "<content-type>")
	req.Header.Add("x-api-key", "<x-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://{baseUrl}/{version}/projects/{projectId}/indexes")
  .header("content-type", "<content-type>")
  .header("x-api-key", "<x-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{baseUrl}/{version}/projects/{projectId}/indexes")

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

request = Net::HTTP::Get.new(url)
request["content-type"] = '<content-type>'
request["x-api-key"] = '<x-api-key>'

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

{
  "indexes": [
    {
      "projectId": "<string>",
      "indexName": "<string>",
      "mappings": {},
      "numDocs": 123,
      "cloneSourceInfo": {
        "sourceProjectId": "<string>",
        "sourceIndexName": "<string>",
        "sourceIndexVersionId": "<string>"
      },
      "indexStatus": "CREATING",
      "indexClass": "STANDARD"
    }
  ]
}

Headers

content-type

string

default:application/json

required

x-api-key

string

required

Project API Key.

Path Parameters

projectId

string

required

Project ID.

Response

200 - application/json

A list of indexes matched with a projectId.

indexes

object[]

Show child attributes