Navigation

Create an Atlas Search Index

On this page

  • Required Roles
  • Resource
  • Request Parameters
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response Elements
  • Examples
  • Example Request
  • Example Response
  • Example Request
  • Example Response

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

The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. To learn how to configure API access for an Atlas project, see Configure Atlas API 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.

For more information about Atlas Search indexes, see Atlas Search and Define Atlas Search Indexes.

You must have the:

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

POST /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/fts/indexes
Note

You cannot create an Atlas Search index on any collection in the admin, local, or config databases in any cluster.

Path Element
Type
Necessity
Description
GROUP-ID
string
Required
Unique identifier for the project that contains the specified cluster.
CLUSTER-NAME
string
Required
Name of the cluster that contains the collection on which you want to create an Atlas Search index.

This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.

Name
Type
Necessity
Description
Default
pageNum
integer
Optional
Page number, starting with one, that Atlas returns of the total number of objects.
1
itemsPerPage
integer
Optional
Number of items that Atlas returns per page, up to a maximum of 500.
100
includeCount
boolean
Optional
Flag that indicates whether Atlas returns the totalCount parameter in the response body.
true
pretty
boolean
Optional
Flag that indicates whether Atlas returns the JSON response in the prettyprint format.
false
envelope
boolean
Optional

Flag that indicates whether Atlas wraps the response in an envelope.

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. Atlas adds the status parameter to the response body.

false
Name
Type
Necessity
Description
analyzer
string
Optional
Analyzer to use when creating the index. Defaults to lucene.standard.
analyzers
array of BSON objects
Optional
Custom analyzers to use in this index.
collectionName
string
Required
Name of the collection the index is on.
database
string
Required
Name of the database the collection is in.
mappings
object
Required
Object containing index specifications for the collection fields.
mappings
.dynamic
boolean
Conditional

Required if mappings.fields is omitted.

Indicates whether the index uses dynamic or static mappings. For dynamic mapping, set the value to true. For static mapping, specify the fields to index using mappings.fields.

mappings
.fields
object
Conditional

Required if mappings.dynamic is false or is omitted.

Object containing one or more field specifications.

name
string
Required
Name of the index.
searchAnalyzer
string
Optional
Analyzer to use when searching the index. Defaults to lucene.standard.
synonyms
array of documents
Optional
Synonyms mapping definition to use in this index.
synonyms[i]
.analyzer
string
Required

Name of the analyzer to use with this synonym mapping. If you set mappings.dynamic to true, you must use the default analyzer, lucene.standard, here also. Atlas Search doesn't support these custom analyzer tokenizers and token filters in the index definition for synonyms:

synonyms[i]
.name
string
Required
Name of the synonym mapping definition. Name must be unique in this index definition and it can't be an empty string.
synonyms[i]
.source
document
Required
Collection details for this synonym mapping definition.
synonyms[i]
.source
.collection
string
Required
Name of the source MongoDB collection for the synonyms. Documents in this collection must be in the format described in the Synonyms Source Collection Documents.

The HTTP response returns a JSON document with an index definition for the newly created index. An index definition contains the following elements:

Name
Type
Description
analyzer
Optional
Analyzer used when creating the index.
analyzers
Optional
Custom analyzers used in this index.
collectionName
string
Name of the collection the index is on.
database
string
Name of the database the collection is in.
indexID
string
Unique identifier for the index.
mappings
object
Object containing index specifications for the collection fields.
mappings
.dynamic
boolean
Flag indicating whether the index uses dynamic or static mappings.
mappings
.fields
object
Object containing one or more field specifications.
name
string
Name of the index.
searchAnalyzer
string
Analyzer to use when searching the index.
status
string

Status of the index. Value can be one of the following statuses:

  • IN_PROGRESS - Atlas is building or re-building the index after an edit.
  • STEADY - Index is ready to use.
  • FAILED - Atlas could not build the index.
  • MIGRATING - Atlas cluster tier is being upgraded and indexes are migrating.
synonyms
array of documents
Synonyms mapping definition used in this index.
synonyms[i]
.analyzer
string
Name of the analyzer used in this synonym mapping. If mappings.dynamic is true, Atlas Search uses the default analyzer, lucene.standard, for synonym mapping.
synonyms[i]
.name
string
Name of the synonym mapping.
synonyms[i]
.source
document
Collection details for this synonym mapping definition.
synonyms[i]
.source
.collection
string
Name of the source MongoDB collection for the synonyms.
Give Feedback

On this page

  • Required Roles
  • Resource
  • Request Parameters
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response Elements
  • Examples
  • Example Request
  • Example Response
  • Example Request
  • Example Response