# Update One Atlas Search Index

**PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}**

Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role.

[Atlas Search Indexes](https://dochub.mongodb.org/core/index-definitions-fts)

## Servers
- https://cloud.mongodb.com: https://cloud.mongodb.com ()


## Authentication methods
- Service accounts
- Digest auth


## Parameters

#### Path parameters
- **groupId** (string)
  Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has 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.
- **clusterName** (string)
  Name of the cluster that contains the collection whose Atlas Search index to update.
- **indexId** (string)
  Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.

#### Query parameters
- **envelope** (boolean)
  Flag that indicates whether Application wraps the response in an `envelope` JSON object. 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. Application adds the status parameter to the response body.
- **pretty** (boolean)
  Flag that indicates whether the response body should be in the prettyprint format.

## Body parameters
Content-type: application/json
Details to update on the Atlas Search index.
- **collectionName** (string)
  Human-readable label that identifies the collection that contains one or more Atlas Search indexes.
- **database** (string)
  Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.
- **name** (string)
  Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique.
- **numPartitions** (integer(int32))
  Number of index partitions. Allowed values are [1, 2, 4].
- **type** (string)
  Type of the index. Default type is search.
- **analyzer** (string)
  Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:

- extracting words
- removing punctuation
- removing accents
- changing to lowercase
- removing common words
- reducing words to their root form (stemming)
- changing words to their base form (lemmatization)
 MongoDB Cloud uses the selected process to build the Atlas Search index.
- **analyzers** (array[object])
  List of user-defined methods to convert database field text into searchable words.
- **mappings** (object)
  Index specifications for the collection's fields.
- **searchAnalyzer** (string)
  Method applied to identify words when searching this index.
- **storedSource** (object)
  Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search.  Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see documentation.
- **synonyms** (array[object])
  Rule sets that map words to their synonyms in this index.

## Responses
### 200: OK

#### Body Parameters: application/json (object)
- **collectionName** (string)
  Human-readable label that identifies the collection that contains one or more Atlas Search indexes.
- **database** (string)
  Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.
- **name** (string)
  Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique.
- **numPartitions** (integer(int32))
  Number of index partitions. Allowed values are [1, 2, 4].
- **type** (string)
  Type of the index. Default type is search.
- **analyzer** (string)
  Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:

- extracting words
- removing punctuation
- removing accents
- changing to lowercase
- removing common words
- reducing words to their root form (stemming)
- changing words to their base form (lemmatization)
 MongoDB Cloud uses the selected process to build the Atlas Search index.
- **analyzers** (array[object])
  List of user-defined methods to convert database field text into searchable words.
- **mappings** (object)
  Index specifications for the collection's fields.
- **searchAnalyzer** (string)
  Method applied to identify words when searching this index.
- **storedSource** (object)
  Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search.  Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see documentation.
- **synonyms** (array[object])
  Rule sets that map words to their synonyms in this index.

### 400: Bad Request.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 401: Unauthorized.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 403: Forbidden.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 404: Not Found.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 409: Conflict.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 500: Internal Server Error.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.


[Powered by Bump.sh](https://bump.sh)