Navigation

Get All Atlas Search Indexes for a Collection

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

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.

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

Resource

GET /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/fts/indexes/{DATABASE-NAME}/{COLLECTION-NAME}

Request Parameters

Request Path Parameters

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 containing the collection with one or more Atlas Search indexes.
DATABASE-NAME string Required Name of the database containing the collection with one or more Atlas Search indexes.
COLLECTION-NAME string Required Name of the collection with one or more Atlas Search indexes.

Request Query Parameters

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 (1-based). 1
itemsPerPage integer Optional Maximum number of items to return, up to a maximum of 100. 100
pretty boolean Optional Indicates whether the response body should be in a prettyprint format. false
envelope boolean Optional

Indicates whether or not to wrap 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.

For endpoints that return a list of results, the results object is an envelope. Atlas adds the status field to the response body.

false

Request Body Parameters

This endpoint doesn’t use HTTP request body parameters.

Response Elements

The HTTP response returns a JSON document that includes an array of index definitions. Each index definition contains the following elements:

Name Type Description
analyzer Optional analyzer to use when creating the 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.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Content-Type: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/fts/indexes/{DATABASE-NAME}/{COLLECTION-NAME}?pretty=true"

Example Response

Response Header

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}

Response Body

The following example response contains an array of two index definitions.

The first has the following characteristics:

  • It is the default definition, which indexes all text fields dynamically and works with any collection.
  • It is named default.

The second definition has the following characteristics:

  • It is a custom definition with static mappings for two fields named genres and plot.
  • It is named SearchIndex1.
[
  {
    "collectionName" : "movies",
    "database" : "sample_mflix",
    "indexID" : "5d114a3587d9d65de99e7371",
    "mappings" : {
      "dynamic" : true
    },
    "name" : "default"
  },
  {
    "collectionName" : "movies",
    "database" : "sample_mflix",
    "indexID" : "5d1268a980eef518dac0cf41",
    "mappings" : {
      "dynamic" : false,
      "fields" : {
        "genres" : {
          "analyzer" : "lucene.standard",
          "type" : "string"
        },
        "plot" : {
          "analyzer" : "lucene.standard",
          "type" : "string"
        }
      }
    },
   "name" : "SearchIndex1"
  }
]