Navigation

Create a Full Text Search Index

The Atlas API uses HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.

For more information about Full Text Search indexes, see Full Text Search and Index Definitions.

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

Syntax

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

Request Parameters

Request Path Parameters

Path Element Required/Optional Description
GROUP-ID Required The unique identifier for the project that contains the specified cluster.
CLUSTER-NAME Required The name of the cluster that contains the collection on which you want to create a Full Text Search index.

Request Query Parameters

The following query parameters are optional:

Name Type Description Default
pageNum integer Page number (1-based). 1
itemsPerPage integer Number of items to return per page, up to a maximum of 500. 100
pretty boolean Displays response in a prettyprint format. false
envelope boolean Specifies whether or not to wrap the response in an envelope. false

Request Body Parameters

Name Type Required/Optional Description
collectionName string Required The name of the collection the index is on.
database string Required The name of the database the collection is in.
analyzer string Optional The analyzer to use when creating the index. Defaults to lucene.standard.
searchAnalyzer string Optional The analyzer to use when searching the index. Defaults to lucene.standard.
mappings object Required Object containing index specifications for the collection fields.
mappings.dynamic boolean Required Indicates whether the index uses dynamic or static mappings.
mappings.fields object Optional Object containing one or more field specifications. Required if mappings.dynamic is set to false.
name string Required The name of the index.

Response Elements

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
collectionName string The name of the collection the index is on.
database string The name of the database the collection is in.
indexID string The unique identifier for the index.
analyzer Optional The analyzer to use when creating the index.
searchAnalyzer string The analyzer to use when searching the index.
mappings object Object containing index specifications for the collection fields.
mappings.dynamic boolean Indicates whether the index uses dynamic or static mappings.
mappings.fields object Object containing one or more field specifications.
name string The name of the index.

Example

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Content-Type: application/json" \
  --include \
  --request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/fts/indexes?pretty=true" \
  --data '
    {
      "collectionName": "orders",
      "database": "fiscalYear2018",
      "mappings": {
        "dynamic": true
      },
      "name": "default"
    }'

Example Response

The following example response contains an index definition for an index named default. It is a default definition with dynamic mappings for all fields in the collection.

{
  "collectionName" : "orders",
  "database" : "fiscalYear2018",
  "indexID" : "5d12990380eef5303341accd",
  "mappings" : {
    "dynamic" : true
  },
  "name" : "default"
}