GET
/
indexes
/
{index_name}
PINECONE_API_KEY = "YOUR_API_KEY"

curl -i -X GET "https://api.pinecone.io/indexes/serverless-index" \
    -H "Api-Key: $PINECONE_API_KEY"

{
   "name": "serverless-index",
   "metric": "cosine",
   "dimension": 1536,
   "status": {
      "ready": true,
      "state": "Ready"
   },
   "host": "serverless-index-4zo0ijk.svc.us-west1-aws.pinecone.io",
   "spec": {
      "serverless": {
         "region": "us-west-2",
         "cloud": "aws"
      }
   }
}

PINECONE_API_KEY = "YOUR_API_KEY"

curl -i -X GET "https://api.pinecone.io/indexes/serverless-index" \
    -H "Api-Key: $PINECONE_API_KEY"

{
   "name": "serverless-index",
   "metric": "cosine",
   "dimension": 1536,
   "status": {
      "ready": true,
      "state": "Ready"
   },
   "host": "serverless-index-4zo0ijk.svc.us-west1-aws.pinecone.io",
   "spec": {
      "serverless": {
         "region": "us-west-2",
         "cloud": "aws"
      }
   }
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
index_name
string
required

The name of the index to be described.

Response

200
application/json

Configuration information and deployment status of the index.

The IndexModel describes the configuration and status of a Pinecone index.