Update an Atlas Search Index¶
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.
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.
Required Roles¶
You must have the:
Project Data Access Read Onlyor higher role to view Atlas Search analyzers and indexes using the Atlas UI or API.Project Data Access Adminor higher role to create and manage Atlas Search analyzers and indexes using the Atlas UI or API.
Resource¶
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
PATCH /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/fts/indexes/{INDEX-ID}
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. |
INDEX-ID | string | Required | 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¶
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 Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body. | false |
Request Body Parameters¶
Name | Type | Necessity | Description |
|---|---|---|---|
analyzer | string | Optional | Analyzer to use when creating the
index. Defaults to lucene.standard. |
collectionName | string | Optional | Name of the collection the index is on. |
database | string | Optional | 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 Indicates whether the index uses dynamic or static mappings. For
dynamic mapping, set the value to |
mappings.fields | object | Conditional | Required if Object containing one or more field specifications. |
name | string | Optional | Name of the index. |
searchAnalyzer | string | Optional | Analyzer to use when searching the
index. Defaults to lucene.standard. |
The name body parameter must contain the current name of the
index. It can't be changed.
Response Elements¶
The HTTP response returns a JSON document with an index definition for the updated index. An 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. |
status | string | Status of the index. Value can be one of the following statuses:
|
Example Request¶
The following example request updates an existing index to use the specified parameters.
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Content-Type: application/json" \ 3 --include \ 4 --request PATCH "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/fts/indexes/5d129aef87d9d64f310bd79f?pretty=true" \ 5 --data ' 6 { 7 "collectionName": "orders", 8 "analyzer": "lucene.swedish", 9 "searchAnalyzer": "lucene.whitespace", 10 "database": "fiscalYear2018", 11 "mappings": { 12 "dynamic": true 13 }, 14 "name": "2018ordersIndex" 15 }'
Example Response¶
Response Header¶
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
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 index definition for an
index named 2018ordersIndex.
{ "analyzer" : "lucene.swedish", "searchAnalyzer" : "lucene.whitespace", "collectionName" : "orders", "database" : "fiscalYear2018", "indexID" : "5d129aef87d9d64f310bd79f", "mappings" : { "dynamic" : true }, "name" : "2018ordersIndex" }