Get One Atlas Search Index¶

On this page

Syntax
Request Parameters
Response Elements
Example
- Example Request
- Example Response

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

Syntax¶

copy

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

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 containing the collection with one or more Atlas Search indexes.
`INDEX-ID`	Required	The unique identifier of the Atlas Search index. Use the Get All Atlas Search Indexes for a Collection API endpoint to find the IDs of all Atlas Search indexes.

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¶

This endpoint does not use HTTP request body parameters.

Response Elements¶

The HTTP response returns a JSON document with an index definition for the specified 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¶

copy

curl -i -u "{PUBLIC-KEY}:{PRIVATE-KEY}" \
  --digest "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/fts/indexes/{INDEX-ID}?pretty=true"

Example Response¶

The following example response contains an index definition for an index named SearchIndex1. It is a custom definition with static mappings for two fields named genres and plot.

{
  "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"
}

← Get All Atlas Search Indexes for a Collection Get All User-Defined Analyzers for a Cluster →