MOmongodb
Atlas Search

Create One Atlas Search Index

Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search.

post/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

groupIdstring required
Example:32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

clusterNamestring required

Name of the cluster that contains the collection on which to create an Atlas Search index.

Query parameters

envelopeboolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

prettyboolean

Flag that indicates whether the response body should be in the prettyprint format.

Request body

collectionNamestring required

Label that identifies the collection to create an Atlas Search index in.

databasestring required

Label that identifies the database that contains the collection to create an Atlas Search index in.

namestring required

Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique.

type'search' | 'vectorSearch'

Type of the index. The default type is search.

Response

Created

Changes

No recorded changes to this operation across all 1 revision of this API.