Skip to main content
Pinecone Docs
current

Search documentation

Type to search this documentation.

List indexes

List all indexes in a project.

Python
from pinecone import Pinecone

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

const pc = new Pinecone({ apiKey: 'YOUR_API_KEY' });
const indexList = await pc.listIndexes();
console.log(JSON.stringify(indexList, null, 2));
Java
import io.pinecone.clients.Pinecone;
import org.openapitools.db_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.toJson());
	}
}
Go
package main

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

	"github.com/pinecone-io/go-pinecone/v4/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: os.Getenv("PINECONE_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 {
		fmt.Printf("%s\n", prettifyStruct(idxs))
	}
}
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 -X GET "https://api.pinecone.io/indexes" \
     -H "Api-Key: $PINECONE_API_KEY" \
     -H "X-Pinecone-Api-Version: 2025-04"
CLI
# Target the project for which you want to list indexes.
pc target -o "example-org" -p "example-project"
# List all indexes in the project
pc index list
Python
[
  {
    "name": "example-index",
    "metric": "cosine",
    "host": "example-index-fa77d8e.svc.aped-4627-b74a.pinecone.io",
    "spec": {
      "serverless": {
        "cloud": "aws",
        "region": "us-east-1"
      }
    },
    "status": {
      "ready": true,
      "state": "Ready"
    },
    "vector_type": "dense",
    "dimension": 1024,
    "deletion_protection": "disabled",
    "tags": null,
    "embed": {
      "model": "llama-text-embed-v2",
      "field_map": {
        "text": "text"
      },
      "dimension": 1024,
      "metric": "cosine",
      "write_parameters": {
        "dimension": 1024.0,
        "input_type": "passage",
        "truncate": "END"
      },
      "read_parameters": {
        "dimension": 1024.0,
        "input_type": "query",
        "truncate": "END"
      },
      "vector_type": "dense"
    }
  },
  {
    "name": "example-index-2",
    "metric": "cosine",
    "host": "example-index-2-ea1c34b.svc.aped-4627-b74a.pinecone.io",
    "spec": {
      "serverless": {
        "cloud": "aws",
        "region": "us-east-1"
      }
    },
    "status": {
      "ready": true,
      "state": "Ready"
    },
    "vector_type": "dense",
    "dimension": 1024,
    "deletion_protection": "disabled",
    "tags": null,
    "embed": {
      "model": "llama-text-embed-v2",
      "field_map": {
        "text": "text"
      },
      "dimension": 1024,
      "metric": "cosine",
      "write_parameters": {
        "dimension": 1024.0,
        "input_type": "passage",
        "truncate": "END"
      },
      "read_parameters": {
        "dimension": 1024.0,
        "input_type": "query",
        "truncate": "END"
      },
      "vector_type": "dense"
    }
  }
]
JavaScript
{
  "indexes": [
    {
      "name": "example-index",
      "dimension": 1024,
      "metric": "cosine",
      "host": "example-index-fa77d8e.svc.aped-4627-b74a.pinecone.io",
      "deletionProtection": "disabled",
      "embed": {
        "model": "llama-text-embed-v2",
        "metric": "cosine",
        "dimension": 1024,
        "vectorType": "dense",
        "fieldMap": {
          "text": "text"
        },
        "readParameters": {
          "dimension": 1024,
          "input_type": "query",
          "truncate": "END"
        },
        "writeParameters": {
          "dimension": 1024,
          "input_type": "passage",
          "truncate": "END"
        }
      },
      "spec": {
        "serverless": {
          "cloud": "aws",
          "region": "us-east-1"
        }
      },
      "status": {
        "ready": true,
        "state": "Ready"
      },
      "vectorType": "dense"
    },
    {
      "name": "example-index-2",
      "dimension": 1024,
      "metric": "cosine",
      "host": "example-index-2-ea1c34b.svc.aped-4627-b74a.pinecone.io",
      "deletionProtection": "disabled",
      "embed": {
        "model": "llama-text-embed-v2",
        "metric": "cosine",
        "dimension": 1024,
        "vectorType": "dense",
        "fieldMap": {
          "text": "text"
        },
        "readParameters": {
          "dimension": 1024,
          "input_type": "query",
          "truncate": "END"
        },
        "writeParameters": {
          "dimension": 1024,
          "input_type": "passage",
          "truncate": "END"
        }
      },
      "spec": {
        "serverless": {
          "cloud": "aws",
          "region": "us-east-1"
        }
      },
      "status": {
        "ready": true,
        "state": "Ready"
      },
      "vectorType": "dense"
    }
  ]
}
Java
{
  "indexes": [
    {
      "name": "example-index",
      "dimension": 1024,
      "metric": "cosine",
      "host": "example-index-fa77d8e.svc.aped-4627-b74a.pinecone.io",
      "deletion_protection": "disabled",
      "embed": {
        "model": "llama-text-embed-v2",
        "metric": "cosine",
        "dimension": 1024,
        "vector_type": "dense",
        "field_map": {
          "text": "text"
        },
        "read_parameters": {
          "dimension": 1024.0,
          "input_type": "query",
          "truncate": "END"
        },
        "write_parameters": {
          "dimension": 1024.0,
          "input_type": "passage",
          "truncate": "END"
        }
      },
      "spec": {
        "serverless": {
          "cloud": "aws",
          "region": "us-east-1"
        }
      },
      "status": {
        "ready": true,
        "state": "Ready"
      },
      "vector_type": "dense"
    },
    {
      "name": "example-index-2",
      "dimension": 1024,
      "metric": "cosine",
      "host": "example-index-2-ea1c34b.svc.aped-4627-b74a.pinecone.io",
      "deletion_protection": "disabled",
      "embed": {
        "model": "llama-text-embed-v2",
        "metric": "cosine",
        "dimension": 1024,
        "vector_type": "dense",
        "field_map": {
          "text": "text"
        },
        "read_parameters": {
          "dimension": 1024.0,
          "input_type": "query",
          "truncate": "END"
        },
        "write_parameters": {
          "dimension": 1024.0,
          "input_type": "passage",
          "truncate": "END"
        }
      },
      "spec": {
        "serverless": {
          "cloud": "aws",
          "region": "us-east-1"
        }
      },
      "status": {
        "ready": true,
        "state": "Ready"
      },
      "vector_type": "dense"
    }
  ]
}
Go
[
  {
    "name": "example-index",
    "host": "example-index-fa77d8e.svc.aped-4627-b74a.pinecone.io",
    "metric": "cosine",
    "vector_type": "dense",
    "deletion_protection": "disabled",
    "dimension": 1024,
    "spec": {
      "serverless": {
        "cloud": "aws",
        "region": "us-east-1"
      }
    },
    "status": {
      "ready": true,
      "state": "Ready"
    },
    "embed": {
      "model": "llama-text-embed-v2",
      "dimension": 1024,
      "metric": "cosine",
      "vector_type": "dense",
      "field_map": {
        "text": "text"
      },
      "read_parameters": {
        "dimension": 1024,
        "input_type": "query",
        "truncate": "END"
      },
      "write_parameters": {
        "dimension": 1024,
        "input_type": "passage",
        "truncate": "END"
      }
    }
  },
  {
    "name": "example-index-2",
    "host": "example-index-2-ea1c34b.svc.aped-4627-b74a.pinecone.io",
    "metric": "cosine",
    "vector_type": "dense",
    "deletion_protection": "disabled",
    "dimension": 1024,
    "spec": {
      "serverless": {
        "cloud": "aws",
        "region": "us-east-1"
      }
    },
    "status": {
      "ready": true,
      "state": "Ready"
    },
    "embed": {
      "model": "llama-text-embed-v2",
      "dimension": 1024,
      "metric": "cosine",
      "vector_type": "dense",
      "field_map": {
        "text": "text"
      },
      "read_parameters": {
        "dimension": 1024,
        "input_type": "query",
        "truncate": "END"
      },
      "write_parameters": {
        "dimension": 1024,
        "input_type": "passage",
        "truncate": "END"
      }
    }
  }
]
C#
{
  "indexes": [
    {
      "name": "example-index",
      "dimension": 1024,
      "metric": "cosine",
      "host": "example-index-fa77d8e.svc.aped-4627-b74a.pinecone.io",
      "deletion_protection": "disabled",
      "embed": {
        "model": "llama-text-embed-v2",
        "metric": "cosine",
        "dimension": 1024,
        "vector_type": "dense",
        "field_map": {
          "text": "text"
        },
        "read_parameters": {
          "dimension": 1024,
          "input_type": "query",
          "truncate": "END"
        },
        "write_parameters": {
          "dimension": 1024,
          "input_type": "passage",
          "truncate": "END"
        }
      },
      "spec": {
        "serverless": {
          "cloud": "aws",
          "region": "us-east-1"
        }
      },
      "status": {
        "ready": true,
        "state": "Ready"
      },
      "vector_type": "dense"
    },
    {
      "name": "example-index-2",
      "dimension": 1024,
      "metric": "cosine",
      "host": "example-index-2-ea1c34b.svc.aped-4627-b74a.pinecone.io",
      "deletion_protection": "disabled",
      "embed": {
        "model": "llama-text-embed-v2",
        "metric": "cosine",
        "dimension": 1024,
        "vector_type": "dense",
        "field_map": {
          "text": "text"
        },
        "read_parameters": {
          "dimension": 1024,
          "input_type": "query",
          "truncate": "END"
        },
        "write_parameters": {
          "dimension": 1024,
          "input_type": "passage",
          "truncate": "END"
        }
      },
      "spec": {
        "serverless": {
          "cloud": "aws",
          "region": "us-east-1"
        }
      },
      "status": {
        "ready": true,
        "state": "Ready"
      },
      "vector_type": "dense"
    }
  ]
}
curl
{
  "indexes": [
    {
      "name": "example-index",
      "vector_type": "dense",
      "metric": "cosine",
      "dimension": 1024,
      "status": {
        "ready": true,
        "state": "Ready"
      },
      "host": "example-index-fa77d8e.svc.aped-4627-b74a.pinecone.io",
      "spec": {
        "serverless": {
          "region": "us-east-1",
          "cloud": "aws"
        }
      },
      "deletion_protection": "disabled",
      "tags": null,
      "embed": {
        "model": "llama-text-embed-v2",
        "field_map": {
          "text": "text"
        },
        "dimension": 1024,
        "metric": "cosine",
        "write_parameters": {
          "dimension": 1024,
          "input_type": "passage",
          "truncate": "END"
        },
        "read_parameters": {
          "dimension": 1024,
          "input_type": "query",
          "truncate": "END"
        },
        "vector_type": "dense"
      }
    },
    {
      "name": "example-index-2",
      "vector_type": "dense",
      "metric": "cosine",
      "dimension": 1024,
      "status": {
        "ready": true,
        "state": "Ready"
      },
      "host": "example-index-2-ea1c34b.svc.aped-4627-b74a.pinecone.io",
      "spec": {
        "serverless": {
          "region": "us-east-1",
          "cloud": "aws"
        }
      },
      "deletion_protection": "disabled",
      "tags": null,
      "embed": {
        "model": "llama-text-embed-v2",
        "field_map": {
          "text": "text"
        },
        "dimension": 1024,
        "metric": "cosine",
        "write_parameters": {
          "dimension": 1024,
          "input_type": "passage",
          "truncate": "END"
        },
        "read_parameters": {
          "dimension": 1024,
          "input_type": "query",
          "truncate": "END"
        },
        "vector_type": "dense"
      }
    }
  ]
}
CLI
NAME                   STATUS    HOST                                                          DIMENSION   METRIC    SPEC
example-index          Ready     example-index-fa77d8e.svc.aped-4627-b74a.pinecone.io          1536        cosine    serverless
example-index-2        Ready     example-index-2-ea1c34b.svc.aped-4627-b74a.pinecone.io        1024        cosine    serverless

GET /indexes

Authorizations

Section titled “Authorizations”
Api-Keystringrequired

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

Response

Section titled “Response”

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
dimension?integer

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'. If the 'vector_type' is 'sparse', the metric must be 'dotproduct'. If the vector_type is dense, the metric defaults to 'cosine'.

Available options: cosine, euclidean, dotproduct

Typeenum<string>
hoststringrequired

The URL address where the index is hosted.

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

Typestring
private_host?string

The private endpoint URL of an index.

Example: semantic-search-c01b5b5.svc.private.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.

tags?object

Custom user tags added to an index. Keys must be 80 characters or less. Values must be 120 characters or less. Keys must be alphanumeric, '', or '-'. Values must be alphanumeric, ';', '@', '', '-', '.', '+', or ' '. To unset a key, set the value to be an empty string.

Typeobject
embed?object

The embedding model and document fields mapped to embedding inputs.

Typeobject
Show child attributes
modelstringrequired

The name of the embedding model used to create the index.

Example: multilingual-e5-large

Typestring
metric?enum<string>

The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'. If not specified, the metric will be defaulted according to the model. Cannot be updated once set.

Available options: cosine, euclidean, dotproduct

Typeenum<string>
dimension?integer

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

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

Typeinteger
vector_type?string

The index vector type. You can use 'dense' or 'sparse'. If 'dense', the vector dimension must be specified. If 'sparse', the vector dimension should not be specified.

Typestring
Defaultdense
field_map?object

Identifies the name of the text field from your document model that is embedded.

Typeobject
read_parameters?object

The read parameters for the embedding model.

Typeobject
write_parameters?object

The write parameters for the embedding model.

Typeobject
specobjectrequired
Show child attributes
byoc?object

Configuration needed to deploy an index in a BYOC environment.

Typeobject
Show child attributes
environmentstringrequired

The environment where the index is hosted.

Example: aws-us-east-1-b921

Typestring
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
source_collection?string

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

Typestring
statusobjectrequired
Show child attributes
readybooleanrequired
stateenum<string>required

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

Typeenum<string>
vector_typestringrequired

The index vector type. You can use 'dense' or 'sparse'. If 'dense', the vector dimension must be specified. If 'sparse', the vector dimension should not be specified.

Typestring
Defaultdense
Suggest an edit

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

Export
Documentation menu