GET
/
databases
/
{indexName}
curl --request GET \
     --url https://controller.us-east1-gcp.pinecone.io/databases/indexName \
     --header 'accept: application/json'

{
  "database": {
    "name": "<string>",
    "dimension": "<string>",
    "index_type": "<string>",
    "metric": "<string>",
    "pods": 123,
    "replicas": 123,
    "shards": 123,
    "pod_type": "<string>",
    "index_config": {
      "k_bits": 512,
      "hybrid": false
    },
    "metadata_config": {}
  },
  "status": {
    "ready": true,
    "state": "Initializing",
    "host": "<string>",
    "port": 123
  }
}
curl --request GET \
     --url https://controller.us-east1-gcp.pinecone.io/databases/indexName \
     --header 'accept: application/json'

Authorizations

​
Api-Key
string
header
required

An API Key is required to call Pinecone APIs. Get yours at https://app.pinecone.io/.

Path Parameters

​
indexName
string
required

The name of the index

Response

200
application/json

Configuration information and deployment status of the index

The response is of type object.