This page shows you how to manage your existing collections.

List collections

Use this operation to get a complete description of all collections in a project:

LAMBDADB_PROJECT_API_KEY="YOUR_API_KEY"

curl -i -X GET "https://{baseUrl}/projects/{projectName}/collections" \
  -H "content-type: application/json" \
  -H "x-api-key: $LAMBDADB_PROJECT_API_KEY"

The response will look like this:

{
  "collections": [
    {
      "projectName": "<string>",
      "collectionName": "<string>",
      "indexConfigs": {},
      "numDocs": 123,
      "cloneSourceInfo": {
        "sourceProjectId": "<string>",
        "sourceIndexName": "<string>",
        "sourceIndexVersionId": "<string>"
      },
      "collectionStatus": "ACTIVE"
    }
  ]
}

Describe a collection

Use the describe endpoint to get a complete description of a specific collection:

LAMBDADB_PROJECT_API_KEY="YOUR_API_KEY"

curl -i -X GET "https://{baseUrl}/projects/{projectName}/collections/{collectionName}" \
  -H "content-type: application/json" \
  -H "x-api-key: $LAMBDADB_PROJECT_API_KEY"

The response will look like this:

{
  "projectName": "<string>",
  "collectionName": "<string>",
  "indexConfigs": {},
  "numDocs": 123,
  "cloneSourceInfo": {
    "sourceProjectId": "<string>",
    "sourceIndexName": "<string>",
    "sourceIndexVersionId": "<string>"
  },
  "collectionStatus": "ACTIVE"
}

Delete a collection

Use this operation to delete a collection and all of its associated resources:

LAMBDADB_PROJECT_API_KEY="YOUR_API_KEY"

curl -i -X DELETE "https://{baseUrl}/projects/{projectName}/collections/{collectionName}" \
  -H "content-type: application/json" \
  -H "x-api-key: $LAMBDADB_PROJECT_API_KEY"