ClusterSearchIndex

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mongodb/main/json-schema/mongodb-cluster-search-index-schema.json",
  "title": "ClusterSearchIndex",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/mongodb-atlas-search-api-openapi.yml#/components/schemas/ClusterSearchIndex",
  "properties": {
    "collectionName": {
      "description": "Human-readable label that identifies the collection that contains one or more Atlas Search indexes.",
      "type": "string"
    },
    "database": {
      "description": "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.",
      "type": "string"
    },
    "indexID": {
      "description": "Unique 24-hexadecimal digit string that identifies this Atlas Search index.",
      "pattern": "^([a-f0-9]{24})$",
      "readOnly": true,
      "type": "string"
    },
    "name": {
      "description": "Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique.",
      "type": "string"
    },
    "numPartitions": {
      "default": 1,
      "description": "Number of index partitions. Allowed values are [1, 2, 4].",
      "format": "int32",
      "type": "integer"
    },
    "status": {
      "description": "Condition of the search index when you made this request.\n\n- `IN_PROGRESS`: Atlas is building or re-building the index after an edit.\n- `STEADY`: You can use this search index.\n- `FAILED`: Atlas could not build the index.\n- `MIGRATING`: Atlas is upgrading the underlying cluster tier and migrating indexes.\n- `PAUSED`: The cluster is paused.",
      "enum": [
        "IN_PROGRESS",
        "STEADY",
        "FAILED",
        "MIGRATING",
        "STALE",
        "PAUSED"
      ],
      "readOnly": true,
      "type": "string"
    },
    "storedSource": {
      "description": "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search.  Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. Note that storing all fields (true) is not allowed for vector search indexes. To learn more, see documentation.",
      "type": "object"
    },
    "type": {
      "description": "Type of the index. Default type is search.",
      "enum": [
        "search",
        "vectorSearch"
      ],
      "type": "string"
    }
  },
  "required": [
    "collectionName",
    "database",
    "name"
  ],
  "type": "object"
}