Update All User-Defined Analyzers for One Cluster

PUT /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/analyzers
Service accounts Digest auth

Updates one or more Atlas Search custom analyzers on the specified cluster. Custom analyzers define the operations to perform to index a field. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role.

Custom Analyzers

Path parameters

  • groupId string Required

    Unique 24-hexadecimal digit string that identifies your project. Use the /groups 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.

    Format should match the following pattern: ^([a-f0-9]{24})$.

  • clusterName string Required

    Name of the cluster that contains the collection with one or more Atlas Search indexes.

    Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

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.

    Default value is false.

  • pretty boolean

    Flag that indicates whether the response body should be in the prettyprint format.

    Default value is false.

    Prettyprint
application/json

Body Required

Updates one or more Atlas Search custom analyzers on the specified cluster.

  • charFilters array[object]

    Filters that examine text one character at a time and perform filtering operations.

    One of:
    charFilterhtmlStrip object charFiltericuNormalize object charFiltermapping object charFilterpersian object
  • name string Required

    Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:

    • lucene.
    • builtin.
    • mongodb.
  • tokenFilters array[object]

    Filter that performs operations such as:

    • Stemming, which reduces related words, such as "talking", "talked", and "talks" to their root word "talk".

    • Redaction, the removal of sensitive information from public documents.

    Any of:
    tokenFilterasciiFolding object tokenFilterdaitchMokotoffSoundex object tokenFilteredgeGram object TokenFilterEnglishPossessive object TokenFilterFlattenGraph object tokenFiltericuFolding object tokenFiltericuNormalizer object TokenFilterkStemming object tokenFilterlength object tokenFilterlowercase object tokenFilternGram object TokenFilterPorterStemming object tokenFilterregex object tokenFilterreverse object tokenFiltershingle object tokenFiltersnowballStemming object TokenFilterSpanishPluralStemming object TokenFilterStempel object tokenFilterstopword object tokenFiltertrim object TokenFilterWordDelimiterGraph object

  • tokenizer object Required

    Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing.

    One of:
    edgeGram object keyword object nGram object regexCaptureGroup object regexSplit object standard object uaxUrlEmail object whitespace object

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • charFilters array[object]

      Filters that examine text one character at a time and perform filtering operations.

      One of:
      charFilterhtmlStrip object charFiltericuNormalize object charFiltermapping object charFilterpersian object
    • name string Required

      Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:

      • lucene.
      • builtin.
      • mongodb.
    • tokenFilters array[object]

      Filter that performs operations such as:

      • Stemming, which reduces related words, such as "talking", "talked", and "talks" to their root word "talk".

      • Redaction, the removal of sensitive information from public documents.

      Any of:
      tokenFilterasciiFolding object tokenFilterdaitchMokotoffSoundex object tokenFilteredgeGram object TokenFilterEnglishPossessive object TokenFilterFlattenGraph object tokenFiltericuFolding object tokenFiltericuNormalizer object TokenFilterkStemming object tokenFilterlength object tokenFilterlowercase object tokenFilternGram object TokenFilterPorterStemming object tokenFilterregex object tokenFilterreverse object tokenFiltershingle object tokenFiltersnowballStemming object TokenFilterSpanishPluralStemming object TokenFilterStempel object tokenFilterstopword object tokenFiltertrim object TokenFilterWordDelimiterGraph object

    • tokenizer object Required

      Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing.

      One of:
      edgeGram object keyword object nGram object regexCaptureGroup object regexSplit object standard object uaxUrlEmail object whitespace object
  • 400 application/json

    Bad Request.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      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 application/json

    Not Found.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      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 application/json

    Internal Server Error.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      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.
PUT /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/analyzers 
curl \
 --request PUT 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/fts/analyzers' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '[{"charFilters":[{"ignoredTags":["string"],"type":"htmlStrip"}],"name":"string","tokenFilters":[{"originalTokens":"omit","type":"asciiFolding"}],"tokenizer":{"maxGram":42,"minGram":42,"type":"edgeGram"}}]'
Request examples 
[
  {
    "charFilters": [
      {
        "ignoredTags": [
          "string"
        ],
        "type": "htmlStrip"
      }
    ],
    "name": "string",
    "tokenFilters": [
      {
        "originalTokens": "omit",
        "type": "asciiFolding"
      }
    ],
    "tokenizer": {
      "maxGram": 42,
      "minGram": 42,
      "type": "edgeGram"
    }
  }
]
Response examples (200) 
[
  {
    "charFilters": [
      {
        "ignoredTags": [
          "string"
        ],
        "type": "htmlStrip"
      }
    ],
    "name": "string",
    "tokenFilters": [
      {
        "originalTokens": "omit",
        "type": "asciiFolding"
      }
    ],
    "tokenizer": {
      "maxGram": 42,
      "minGram": 42,
      "type": "edgeGram"
    }
  }
]
Response examples (400) 
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
Response examples (404) 
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Response examples (500) 
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}