Skip to main content
Pinecone Docs
current

Search documentation

Type to search this documentation.

List indexes

This operation returns a list of all indexes in a project.

Python
# pip install "pinecone[grpc]"
from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")
pc.list_indexes()
JavaScript
// npm install @pinecone-database/pinecone
import { Pinecone } from '@pinecone-database/pinecone'

const pc = new Pinecone({ apiKey: 'YOUR_API_KEY' })

await pc.listIndexes();
Java
import io.pinecone.clients.Pinecone;
import org.openapitools.control.client.model.*;

public class ListIndexesExample {
    public static void main(String[] args) {
        Pinecone pc = new Pinecone.Builder("YOUR_API_KEY").build();
        IndexList indexList = pc.listIndexes();
        System.out.println(indexList);
    }
}
Go
package main

import (
	"context"
	"encoding/json"
	"fmt"
	"log"

	"github.com/pinecone-io/go-pinecone/v2/pinecone"
)

func prettifyStruct(obj interface{}) string {
	bytes, _ := json.MarshalIndent(obj, "", "  ")
	return string(bytes)
}

func main() {
	ctx := context.Background()

	pc, err := pinecone.NewClient(pinecone.NewClientParams{
		ApiKey: "YOUR_API_KEY",
	})
	if err != nil {
		log.Fatalf("Failed to create Client: %v", err)
	}

	idxs, err := pc.ListIndexes(ctx)
	if err != nil {
		log.Fatalf("Failed to list indexes: %v", err)
	} else {
		for _, index := range idxs {
			fmt.Printf("index: %v\n", prettifyStruct(index))
		}
	}
}
C#
using Pinecone;

var pinecone = new PineconeClient("YOUR_API_KEY");

var indexList = await pinecone.ListIndexesAsync();

Console.WriteLine(indexList);
curl
PINECONE_API_KEY="YOUR_API_KEY"

curl -i -X GET "https://api.pinecone.io/indexes" \
  -H "Api-Key: $PINECONE_API_KEY" \
  -H "X-Pinecone-Api-Version: 2024-07"

GET /indexes

200
{
  "indexes": [
    {
      "dimension": 384,
      "host": "semantic-search-c01b5b5.svc.us-west1-gcp.pinecone.io",
      "metric": "cosine",
      "name": "semantic-search",
      "spec": {
        "pod": {
          "environment": "us-west1-gcp",
          "pod_type": "p1.x1",
          "pods": 4,
          "replicas": 2,
          "shards": 2
        }
      },
      "status": {
        "ready": true,
        "state": "Ready"
      }
    },
    {
      "dimension": 200,
      "host": "image-search-a31f9c1.svc.us-east1-gcp.pinecone.io",
      "metric": "dotproduct",
      "name": "image-search",
      "spec": {
        "serverless": {
          "cloud": "aws",
          "region": "us-east-1"
        }
      },
      "status": {
        "ready": false,
        "state": "Initializing"
      }
    }
  ]
}
401
{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "Invalid API key."
  },
  "status": 401
}
500
{
  "error": {
    "code": "UNKNOWN",
    "message": "Internal server error"
  },
  "status": 500
}
Api-Keystringrequired

An API Key is required to call Pinecone APIs. Get yours from the console.

200 — This operation returns a list of all the indexes that you have previously created, and which are associated with the given project

The list of indexes that exist in the project.

indexes?object[]
Show child attributes
namestringrequired

The name of the index. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.

Required string length: 1 - 45. Example: example-index

Typestring
dimensionintegerrequired

The dimensions of the vectors to be inserted in the index.

Required range: 1 <= x <= 20000. Example: 1536

Typeinteger
metricenum<string>required

The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'.

Available options: cosine, euclidean, dotproduct

Typeenum<string>
Defaultcosine
hoststringrequired

The URL address where the index is hosted.

Example: semantic-search-c01b5b5.svc.us-west1-gcp.pinecone.io

Typestring
deletion_protection?enum<string>

Available options: disabled, enabled

Typeenum<string>
Defaultdisabled

Whether deletion protection is enabled/disabled for the index.

specobjectrequired
Show child attributes
pod?object

Configuration needed to deploy a pod-based index.

Typeobject
Show child attributes
environmentstringrequired

The environment where the index is hosted.

Example: us-east1-gcp

Typestring
replicas?integer

The number of replicas. Replicas duplicate your index. They provide higher availability and throughput. Replicas can be scaled up or down as your needs change.

Required range: 1 <= x

Typeinteger
Default1
shards?integer

The number of shards. Shards split your data across multiple pods so you can fit more data into an index.

Required range: 1 <= x

Typeinteger
Default1
pod_typestringrequired

The type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.

Typestring
Defaultp1.x1
pods?integer

The number of pods to be used in the index. This should be equal to shards x replicas.'

Required range: 1 <= x. Example: 1

Typeinteger
Default1
metadata_config?object

Configuration for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when metadata_config is present, only specified metadata fields are indexed. These configurations are only valid for use with pod-based indexes.

Typeobject
source_collection?string

The name of the collection to be used as the source for the index.

Example: movie-embeddings

Typestring
serverless?object

Configuration needed to deploy a serverless index.

Typeobject
Show child attributes
cloudenum<string>required

The public cloud where you would like your index hosted.

Available options: gcp, aws, azure. Example: aws

Typeenum<string>
regionstringrequired

The region where you would like your index to be created.

Example: us-east-1

Typestring
statusobjectrequired
Show child attributes
readybooleanrequired
stateenum<string>required

Available options: Initializing, InitializationFailed, ScalingUp, ScalingDown, ScalingUpPodSize, ScalingDownPodSize, Terminating, Ready

Typeenum<string>
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu