searchindex/list FormID 20407

When to Use

• Pre-deployment index verification: A CI/CD deployment workflow checks whether required Atlas Search indexes exist on target collections before deploying a new application version that relies on $search queries. If any index is missing or in PENDING state, the workflow fails fast and notifies the engineering team rather than deploying broken search functionality.
• Index status polling after creation: After searchindex/create creates a new index, use searchindex/list in a Loop node with a Delay node to poll the index status until it transitions from PENDING or BUILDING to READY. Gate downstream operations on the index being available.
• Infrastructure audit reporting: A weekly scheduled workflow lists all Atlas Search indexes across multiple collections and databases, compiles the results into a JSON report, and sends it to the platform team. Detects orphaned indexes (no longer used by any query) and indexes stuck in FAILED state.
• Definition drift detection: Compare the listed index definitions against a reference schema stored in a version-controlled document. If any index definition differs from the expected schema, trigger an alert or auto-update workflow using searchindex/update.
• Search feature gating: At the start of a search workflow, check whether the required search index exists and is in READY state. If not, fall back to a standard document/find query while triggering an index creation workflow in parallel.

Configuration

Connection

This operation has no additional configuration parameters. All fields are connection-level.

Sample Configuration

{
  "resource": "search-index",
  "operation": "list",
  "ConnectionUri": "{{ $credentials.mongodbAtlas }}",
  "Database": "ecommerce",
  "Collection": "products"
}

Validation Errors

Output — Success Port

Sample Output

{
  "count": 2,
  "indexes": [
    {
      "id": "64f2a0e1c3b4d5e6f7a8b901",
      "name": "product_search",
      "status": "READY",
      "queryable": true,
      "definition": {
        "mappings": {
          "dynamic": false,
          "fields": {
            "name":        { "type": "string", "analyzer": "lucene.standard" },
            "description": { "type": "string", "analyzer": "lucene.standard" },
            "category":    { "type": "string", "analyzer": "lucene.keyword" },
            "price":       { "type": "number" }
          }
        }
      }
    },
    {
      "id": "64f2a0e1c3b4d5e6f7a8b902",
      "name": "product_vector_search",
      "status": "BUILDING",
      "queryable": false,
      "definition": {
        "mappings": {
          "dynamic": false,
          "fields": {
            "embedding": {
              "type": "knnVector",
              "dimensions": 1536,
              "similarity": "cosine"
            }
          }
        }
      }
    }
  ],
  "status": "success",
  "resource": "search-index",
  "operation": "list"
}

Expression Reference

Node Policies & GuardRails

Workflow Examples

Example 1 — Pre-Deployment Index Check

{
  "resource": "search-index",
  "operation": "list",
  "ConnectionUri": "{{ $credentials.mongodbAtlas }}",
  "Database": "ecommerce",
  "Collection": "products"
}
// Follow with IfCondition:
// indexes.find(i => i.name === "product_search" && i.status === "READY")
// Branch "not found" → Slack alert + halt deployment

Example 2 — Poll Index Until READY

// Loop node wraps: [Delay 15s] → [searchindex/list] → [IfCondition]
// IfCondition: $output.PollIndex.indexes[0].status == "READY"
//   true  → exit loop, continue workflow
//   false → continue loop (retry)
{
  "resource": "search-index",
  "operation": "list",
  "ConnectionUri": "{{ $credentials.mongodbAtlas }}",
  "Database": "catalog",
  "Collection": "{{ $json.targetCollection }}"
}

Example 3 — Weekly Index Audit Report

{
  "resource": "search-index",
  "operation": "list",
  "ConnectionUri": "{{ $credentials.mongodbAtlas }}",
  "Database": "{{ $json.database }}",
  "Collection": "{{ $json.collection }}"
}
// Runs inside a Loop over a list of {database, collection} pairs
// Collects all outputs, then formats and emails the audit summary