Pinecone List Index Backups Example is an example object payload from Pinecone, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "list_index_backups",
"method": "GET",
"path": "/indexes/{index_name}/backups",
"summary": "List backups for an index",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"name": "backups",
"example": {
"data": [
{
"backup_id": "bkp_123abc",
"cloud": "aws",
"created_at": "2024-03-15 10:30:00+00:00",
"description": "Monthly backup of production index",
"dimension": 1536,
"metric": "cosine",
"name": "backup_2024_03_15",
"namespace_count": 3,
"record_count": 120000,
"region": "us-east-1",
"schema": {
"fields": {
"genre": {
"filterable": true
},
"title": {
"filterable": true
}
}
},
"size_bytes": 10000000,
"source_index_id": "idx_456",
"source_index_name": "my-index",
"status": "Ready",
"tags": {
"environment": "production",
"type": "monthly"
}
},
{
"backup_id": "bkp_789xyz",
"cloud": "aws",
"created_at": "2024-03-20 15:45:00+00:00",
"description": "Pre-deployment safety backup",
"dimension": 1536,
"metric": "cosine",
"name": "backup_2024_03_20",
"namespace_count": 4,
"record_count": 125000,
"region": "us-east-1",
"schema": {
"fields": {
"genre": {
"filterable": true
},
"title": {
"filterable": true
}
}
},
"size_bytes": 10500000,
"source_index_id": "idx_456",
"source_index_name": "my-index",
"status": "Ready",
"tags": {
"environment": "production",
"type": "pre-deploy"
}
}
],
"pagination": {
"next": "dXNlcl9pZD11c2VyXzE="
}
}
},
{
"status": "401",
"contentType": "application/json",
"name": "unauthorized",
"example": {
"error": {
"code": "UNAUTHENTICATED",
"message": "Invalid API key."
},
"status": 401
}
},
{
"status": "404",
"contentType": "application/json",
"name": "index-not-found",
"example": {
"error": {
"code": "NOT_FOUND",
"message": "Index example-index not found."
},
"status": 404
}
},
{
"status": "500",
"contentType": "application/json",
"name": "internal-server-error",
"example": {
"error": {
"code": "UNKNOWN",
"message": "Internal server error"
},
"status": 500
}
}
]
}