Navigation

Atlas Search

The fts resource allows you to retrieve and edit Atlas Search index configurations for the specified cluster.

Info With Circle IconCreated with Sketch.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.

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

MethodEndpointDescription
GET/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/fts/indexes/{DATABASE-NAME}/{COLLECTION-NAME}Get all Atlas Search indexes for a specified collection.
GET/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/fts/indexes/{INDEX-ID}Get one Atlas Search index by its indexId.
GET/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/fts/analyzersGet all Atlas Search user-defined analyzers for a specified cluster.
POST/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/fts/indexes/Create an Atlas Search index.
PATCH/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/fts/indexes/{INDEX-ID}Update an Atlas Search index by its indexId.
PUT/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/fts/analyzersUpdate the Atlas Search user-defined analyzers for a specified cluster.
DELETE/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/fts/indexes/{INDEX-ID}Delete one Atlas Search index by its indexId.
Give Feedback