describe_index

Get a description of an index.

Request
Security:
ApiKeyAuth
path Parameters
indexName
required
string

The name of the index

Responses
200

Configuration information and deployment status of the index

404

Index not found

500

Internal error. Can be caused by invalid parameters.

get/databases/{indexName}
Request samples
curl -i -X GET https://controller.us-west1-gcp.pinecone.io/databases/example-index \
  -H 'Api-Key: YOUR_API_KEY'
Response samples
application/json
{
  • "database": {
    }
}