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

Responses

• 200 application/vnd.atlas.2023-01-01+json

  OK

  One of:

  MatcherFieldView string MatcherFieldView string MatcherFieldView string MatcherFieldView string MatcherFieldView string MatcherFieldView string

  Value is APPLICATION_ID.

  Value is CLUSTER_NAME.

  Values are TYPE_NAME, HOSTNAME, PORT, HOSTNAME_AND_PORT, or REPLICA_SET_NAME.

  Values are REPLICA_SET_NAME, SHARD_NAME, or CLUSTER_NAME.

  Values are INSTANCE_NAME or PROCESSOR_NAME.

  Value is RULE_ID.

• 401 application/json

  Unauthorized.

  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.

• 403 application/json

  Forbidden.

  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.

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-]*$.

• collectionName string Required

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

• databaseName string Required

  Human-readable label that identifies the database that contains the collection with one or more 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.

  Default value is false.

• pretty boolean

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

  Default value is false.

  Prettyprint

Responses

• 200 application/vnd.atlas.2023-01-01+json

  OK

  One of:

  SearchIndex object VectorSearchIndex object

  Hide attributes Show attributes

  • collectionName string Required

    Human-readable label that identifies the collection that contains one or more Atlas Search indexes.

  • database string Required

    Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.

  • name string Required

    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].

    Default value is 1.

  • type string Discriminator

    Type of the index. Default type is search.

    Value 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.

    Values are lucene.standard, lucene.simple, lucene.whitespace, lucene.keyword, lucene.arabic, lucene.armenian, lucene.basque, lucene.bengali, lucene.brazilian, lucene.bulgarian, lucene.catalan, lucene.chinese, lucene.cjk, lucene.czech, lucene.danish, lucene.dutch, lucene.english, lucene.finnish, lucene.french, lucene.galician, lucene.german, lucene.greek, lucene.hindi, lucene.hungarian, lucene.indonesian, lucene.irish, lucene.italian, lucene.japanese, lucene.korean, lucene.kuromoji, lucene.latvian, lucene.lithuanian, lucene.morfologik, lucene.nori, lucene.norwegian, lucene.persian, lucene.portuguese, lucene.romanian, lucene.russian, lucene.smartcn, lucene.sorani, lucene.spanish, lucene.swedish, lucene.thai, lucene.turkish, or lucene.ukrainian. Default value is lucene.standard.

    Atlas Search Analyzers
  • analyzers array[object]

    List of user-defined methods to convert database field text into searchable words.

    Settings that describe one Atlas Search custom analyzer.

    Custom Atlas Search Analyzers
    Hide analyzers attributes Show analyzers 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

      Filter that strips out HTML constructs.

      Hide attributes Show attributes

      • ignoredTags array[string]

        The HTML tags that you want to exclude from filtering.

      • type string Required

        Human-readable label that identifies this character filter type.

        Value is htmlStrip.

      Filter that processes normalized text with the ICU Normalizer. It is based on Lucene's ICUNormalizer2CharFilter.

      Hide attribute Show attribute

      • type string Required

        Human-readable label that identifies this character filter type.

        Value is icuNormalize.

      Filter that applies normalization mappings that you specify to characters.

      Hide attributes Show attributes

      • mappings object Required

        Comma-separated list of mappings. A mapping indicates that one character or group of characters should be substituted for another, using the following format:

        <original> : <replacement>.

        Hide mappings attribute Show mappings attribute object

        • * string Additional properties
      • type string Required

        Human-readable label that identifies this character filter type.

        Value is mapping.

      Filter that replaces instances of a zero-width non-joiner with an ordinary space. It is based on Lucene's PersianCharFilter.

      Hide attribute Show attribute

      • type string Required

        Human-readable label that identifies this character filter type.

        Value is persian.

    • 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

      Filter that converts alphabetic, numeric, and symbolic Unicode characters that are not in the Basic Latin Unicode block to their ASCII equivalents, if available.

      Hide attributes Show attributes

      • originalTokens string

        Value that indicates whether to include or omit the original tokens in the output of the token filter.

        Choose include if you want to support queries on both the original tokens as well as the converted forms.

        Choose omit if you want to query only on the converted forms of the original tokens.

        Values are omit or include. Default value is omit.

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is asciiFolding.

      Filter that creates tokens for words that sound the same based on the Daitch-Mokotoff Soundex phonetic algorithm. This filter can generate multiple encodings for each input, where each encoded token is a 6 digit number.

      NOTE: Don't use the daitchMokotoffSoundex token filter in:

      -Synonym or autocomplete mapping definitions

      • Operators where fuzzy is enabled. Atlas Search supports the fuzzy option only for the autocomplete, term, and text operators.

      Hide attributes Show attributes

      • originalTokens string

        Value that indicates whether to include or omit the original tokens in the output of the token filter.

        Choose include if you want to support queries on both the original tokens as well as the converted forms.

        Choose omit if you want to query only on the converted forms of the original tokens.

        Values are omit or include. Default value is include.

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is daitchMokotoffSoundex.

      Filter that tokenizes input from the left side, or "edge", of a text input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.

      Hide attributes Show attributes

      • maxGram integer Required

        Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to minGram.

      • minGram integer Required

        Value that specifies the minimum length of generated n-grams. This value must be less than or equal to maxGram.

      • termNotInBounds string

        Value that indicates whether to index tokens shorter than minGram or longer than maxGram.

        Values are omit or include. Default value is omit.

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is edgeGram.

      Filter that removes possessives (trailing 's) from words.

      Hide attribute Show attribute

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is englishPossessive.

      Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.

      Hide attribute Show attribute

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is flattenGraph.

      Filter that applies character folding from Unicode Technical Report #30.

      Hide attribute Show attribute

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is icuFolding.

      Filter that normalizes tokens using a standard Unicode Normalization Mode.

      Hide attributes Show attributes

      • normalizationForm string

        Normalization form to apply.

        Values are nfd, nfc, nfkd, or nfkc. Default value is nfc.

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is icuNormalizer.

      Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.

      Hide attribute Show attribute

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is kStemming.

      Filter that removes tokens that are too short or too long.

      Hide attributes Show attributes

      • max integer

        Number that specifies the maximum length of a token. Value must be greater than or equal to min.

        Default value is 255.

      • min integer

        Number that specifies the minimum length of a token. This value must be less than or equal to max.

        Default value is 0.

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is length.

      Filter that normalizes token text to lowercase.

      Hide attribute Show attribute

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is lowercase.

      Filter that tokenizes input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.

      Hide attributes Show attributes

      • maxGram integer Required

        Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to minGram.

      • minGram integer Required

        Value that specifies the minimum length of generated n-grams. This value must be less than or equal to maxGram.

      • termNotInBounds string

        Value that indicates whether to index tokens shorter than minGram or longer than maxGram.

        Values are omit or include. Default value is omit.

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is nGram.

      Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.

      Hide attribute Show attribute

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is porterStemming.

      Filter that applies a regular expression to each token, replacing matches with a specified string.

      Hide attributes Show attributes

      • matches string Required

        Value that indicates whether to replace only the first matching pattern or all matching patterns.

        Values are all or first.

      • pattern string Required

        Regular expression pattern to apply to each token.

      • replacement string Required

        Replacement string to substitute wherever a matching pattern occurs.

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is regex.

      Filter that reverses each string token.

      Hide attribute Show attribute

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is reverse.

      Filter that constructs shingles (token n-grams) from a series of tokens. You can't use this token filter in synonym or autocomplete mapping definitions.

      Hide attributes Show attributes

      • maxShingleSize integer Required

        Value that specifies the maximum number of tokens per shingle. This value must be greater than or equal to minShingleSize.

      • minShingleSize integer Required

        Value that specifies the minimum number of tokens per shingle. This value must be less than or equal to maxShingleSize.

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is shingle.

      Filter that stems tokens using a Snowball-generated stemmer.

      Hide attributes Show attributes

      • stemmerName string Required

        Snowball-generated stemmer to use.

        Values are arabic, armenian, basque, catalan, danish, dutch, english, finnish, french, german, german2, hungarian, irish, italian, kp, lithuanian, lovins, norwegian, porter, portuguese, romanian, russian, spanish, swedish, or turkish.

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is snowballStemming.

      Filter that stems Spanish plural words. It expects lowercase text.

      Hide attribute Show attribute

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is spanishPluralStemming.

      Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.

      Hide attribute Show attribute

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is stempel.

      Filter that removes tokens that correspond to the specified stop words. This token filter doesn't analyze the stop words that you specify.

      Hide attributes Show attributes

      • ignoreCase boolean

        Flag that indicates whether to ignore the case of stop words when filtering the tokens to remove.

        Default value is true.

      • tokens array[string] Required

        The stop words that correspond to the tokens to remove. Value must be one or more stop words.

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is stopword.

      Filter that trims leading and trailing whitespace from tokens.

      Hide attribute Show attribute

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is trim.

      Filter that splits tokens into sub-tokens based on configured rules.

      Hide attributes Show attributes

      • delimiterOptions object

        Object that contains the rules that determine how to split words into sub-words.

        Hide delimiterOptions attributes Show delimiterOptions attributes object

        • concatenateAll boolean

          Flag that indicates whether to concatenate runs.

          Default value is false.

        • concatenateNumbers boolean

          Flag that indicates whether to concatenate runs of sub-numbers.

          Default value is false.

        • concatenateWords boolean

          Flag that indicates whether to concatenate runs of sub-words.

          Default value is false.

        • generateNumberParts boolean

          Flag that indicates whether to split tokens based on sub-numbers. For example, if true, this option splits 100-2 into 100 and 2.

          Default value is true.

        • generateWordParts boolean

          Flag that indicates whether to split tokens based on sub-words.

          Default value is true.

        • ignoreKeywords boolean

          Flag that indicates whether to skip tokens with the keyword attribute set to true.

          Default value is false.

        • preserveOriginal boolean

          Flag that indicates whether to generate tokens of the original words.

          Default value is true.

        • splitOnCaseChange boolean

          Flag that indicates whether to split tokens based on letter-case transitions.

          Default value is true.

        • splitOnNumerics boolean

          Flag that indicates whether to split tokens based on letter-number transitions.

          Default value is true.

        • stemEnglishPossessive boolean

          Flag that indicates whether to remove trailing possessives from each sub-word.

          Default value is true.

      • protectedWords object

        Object that contains options for protected words.

        Hide protectedWords attributes Show protectedWords attributes object

        • ignoreCase boolean

          Flag that indicates whether to ignore letter case sensitivity for protected words.

          Default value is true.

        • words array[string] Required

          List that contains the tokens to protect from delimination.

      • type string Required

        Human-readable label that identifies this token filter type.

        Value is wordDelimiterGraph.

    • 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:

      tokenizeredgeGram object tokenizerkeyword object tokenizernGram object tokenizerregexCaptureGroup object tokenizerregexSplit object tokenizerstandard object tokenizeruaxUrlEmail object tokenizerwhitespace object

      Tokenizer that splits input from the left side, or "edge", of a text input into n-grams of given sizes. You can't use the edgeGram tokenizer in synonym or autocomplete mapping definitions.

      Hide attributes Show attributes

      • maxGram integer Required

        Characters to include in the longest token that Atlas Search creates.

      • minGram integer Required

        Characters to include in the shortest token that Atlas Search creates.

      • type string Required Discriminator

        Human-readable label that identifies this tokenizer type.

        Value is edgeGram.

      Tokenizer that combines the entire input as a single token.

      Hide attribute Show attribute

      • type string Required Discriminator

        Human-readable label that identifies this tokenizer type.

        Value is keyword.

      Tokenizer that splits input into text chunks, or "n-grams", of into given sizes. You can't use the nGram tokenizer in synonym or autocomplete mapping definitions.

      Hide attributes Show attributes

      • maxGram integer Required

        Characters to include in the longest token that Atlas Search creates.

      • minGram integer Required

        Characters to include in the shortest token that Atlas Search creates.

      • type string Required Discriminator

        Human-readable label that identifies this tokenizer type.

        Value is edgeGram.

      Tokenizer that uses a regular expression pattern to extract tokens.

      Hide attributes Show attributes

      • group integer Required

        Index of the character group within the matching expression to extract into tokens. Use 0 to extract all character groups.

      • pattern string Required

        Regular expression to match against.

      • type string Required Discriminator

        Human-readable label that identifies this tokenizer type.

        Value is regexCaptureGroup.

      Tokenizer that splits tokens using a regular-expression based delimiter.

      Hide attributes Show attributes

      • pattern string Required

        Regular expression to match against.

      • type string Required Discriminator

        Human-readable label that identifies this tokenizer type.

        Value is regexSplit.

      Tokenizer that splits tokens based on word break rules from the Unicode Text Segmentation algorithm.

      Hide attributes Show attributes

      • maxTokenLength integer

        Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens.

        Default value is 255.

      • type string Required Discriminator

        Human-readable label that identifies this tokenizer type.

        Value is standard.

      Tokenizer that creates tokens from URLs and email addresses. Although this tokenizer uses word break rules from the Unicode Text Segmentation algorithm, we recommend using it only when the indexed field value includes URLs and email addresses. For fields that don't include URLs or email addresses, use the standard tokenizer to create tokens based on word break rules.

      Hide attributes Show attributes

      • maxTokenLength integer

        Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens.

        Default value is 255.

      • type string Required Discriminator

        Human-readable label that identifies this tokenizer type.

        Value is uaxUrlEmail.

      Tokenizer that creates tokens based on occurrences of whitespace between words.

      Hide attributes Show attributes

      • maxTokenLength integer

        Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens.

        Default value is 255.

      • type string Required Discriminator

        Human-readable label that identifies this tokenizer type.

        Value is whitespace.

  • mappings object

    Index specifications for the collection's fields.

    Hide mappings attributes Show mappings attributes object

    • dynamic boolean

      Flag that indicates whether the index uses dynamic or static mappings. Required if mappings.fields is omitted.

      Default value is false.

      Dynamic or Static Mappings
    • fields object

      One or more field specifications for the Atlas Search index. Required if mappings.dynamic is omitted or set to false.

      Atlas Search Index
      Hide fields attribute Show fields attribute object

      • * object Additional properties
        Atlas Search Field Mappings
  • searchAnalyzer string

    Method applied to identify words when searching this index.

    Values are lucene.standard, lucene.simple, lucene.whitespace, lucene.keyword, lucene.arabic, lucene.armenian, lucene.basque, lucene.bengali, lucene.brazilian, lucene.bulgarian, lucene.catalan, lucene.chinese, lucene.cjk, lucene.czech, lucene.danish, lucene.dutch, lucene.english, lucene.finnish, lucene.french, lucene.galician, lucene.german, lucene.greek, lucene.hindi, lucene.hungarian, lucene.indonesian, lucene.irish, lucene.italian, lucene.japanese, lucene.korean, lucene.kuromoji, lucene.latvian, lucene.lithuanian, lucene.morfologik, lucene.nori, lucene.norwegian, lucene.persian, lucene.portuguese, lucene.romanian, lucene.russian, lucene.smartcn, lucene.sorani, lucene.spanish, lucene.swedish, lucene.thai, lucene.turkish, or lucene.ukrainian. Default value is lucene.standard.

  • 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.

    Stored Source Fields
  • synonyms array[object]

    Rule sets that map words to their synonyms in this index.

    Synonyms used for this full text index.

    Synonym Mapping
    Hide synonyms attributes Show synonyms attributes object

    • analyzer string Required

      Specific pre-defined method chosen to apply to the synonyms to be searched.

      Values are lucene.standard, lucene.simple, lucene.whitespace, lucene.keyword, lucene.arabic, lucene.armenian, lucene.basque, lucene.bengali, lucene.brazilian, lucene.bulgarian, lucene.catalan, lucene.chinese, lucene.cjk, lucene.czech, lucene.danish, lucene.dutch, lucene.english, lucene.finnish, lucene.french, lucene.galician, lucene.german, lucene.greek, lucene.hindi, lucene.hungarian, lucene.indonesian, lucene.irish, lucene.italian, lucene.japanese, lucene.korean, lucene.kuromoji, lucene.latvian, lucene.lithuanian, lucene.morfologik, lucene.nori, lucene.norwegian, lucene.persian, lucene.portuguese, lucene.romanian, lucene.russian, lucene.smartcn, lucene.sorani, lucene.spanish, lucene.swedish, lucene.thai, lucene.turkish, or lucene.ukrainian.

    • name string Required

      Label that identifies the synonym definition. Each synonym.name must be unique within the same index definition.

    • source object Required

      Data set that stores words and their applicable synonyms.

      Hide source attribute Show source attribute object

      • collection string Required

        Label that identifies the MongoDB collection that stores words and their applicable synonyms.

  Hide attributes Show attributes

  • collectionName string Required

    Human-readable label that identifies the collection that contains one or more Atlas Search indexes.

  • database string Required

    Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.

  • name string Required

    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].

    Default value is 1.

  • type string Discriminator

    Type of the index. Default type is search.

    Value is vectorSearch.

  • fields array[object]

    Settings that configure the fields, one per object, to index. You must define at least one "vector" type field. You can optionally define "filter" type fields also.

    Vector Search Fields
    Hide fields attribute Show fields attribute object

    • * object Additional properties
• 401 application/json

  Unauthorized.

  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.

• 403 application/json

  Forbidden.

  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.

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 on which to create an Atlas Search index.

  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

Responses

• 201 application/vnd.atlas.2024-05-30+json

  Created

  One of:

  TextSearchIndexResponse object VectorSearchIndexResponse object

  Hide attributes Show attributes

  • collectionName string

    Label that identifies the collection that contains one or more Atlas Search indexes.

  • database string

    Label that identifies the database that contains the collection with one or more Atlas Search indexes.

  • indexID string

    Unique 24-hexadecimal digit string that identifies this Atlas Search index.

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

  • latestDefinition object

    The text search index definition set by the user.

    Hide latestDefinition attributes Show latestDefinition attributes object

    • numPartitions integer(int32)

      Number of index partitions. Allowed values are [1, 2, 4].

      Default value is 1.

    • 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 making the following changes 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 process you select to build the Atlas Search index.

      Values are lucene.standard, lucene.simple, lucene.whitespace, lucene.keyword, lucene.arabic, lucene.armenian, lucene.basque, lucene.bengali, lucene.brazilian, lucene.bulgarian, lucene.catalan, lucene.chinese, lucene.cjk, lucene.czech, lucene.danish, lucene.dutch, lucene.english, lucene.finnish, lucene.french, lucene.galician, lucene.german, lucene.greek, lucene.hindi, lucene.hungarian, lucene.indonesian, lucene.irish, lucene.italian, lucene.japanese, lucene.korean, lucene.kuromoji, lucene.latvian, lucene.lithuanian, lucene.morfologik, lucene.nori, lucene.norwegian, lucene.persian, lucene.portuguese, lucene.romanian, lucene.russian, lucene.smartcn, lucene.sorani, lucene.spanish, lucene.swedish, lucene.thai, lucene.turkish, or lucene.ukrainian. Default value is lucene.standard.

      Atlas Search Analyzers
    • analyzers array[object]

      List of user-defined methods to convert database field text into searchable words.

      Custom Atlas Search Analyzers
      Hide analyzers attributes Show analyzers attributes object

      • charFilters array[object]

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

        Hide charFilters attribute Show charFilters attribute object

        • * object Additional properties
      • name string Required

        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, which is the removal of sensitive information from public documents.

        Hide tokenFilters attribute Show tokenFilters attribute object

        • * object Additional properties
      • 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.

        Hide tokenizer attribute Show tokenizer attribute object

        • * object Additional properties

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

    • mappings object Required

      Index specifications for the collection's fields.

      Hide mappings attributes Show mappings attributes object

      • dynamic boolean

        Flag that indicates whether the index uses dynamic or static mappings. Required if mappings.fields is omitted.

        Dynamic or Static Mappings
      • fields object

        One or more field specifications for the Atlas Search index. Required if mappings.dynamic is omitted or set to false.

        Atlas Search Index
        Hide fields attribute Show fields attribute object

        • * object Additional properties
          Atlas Search Field Mappings
    • searchAnalyzer string

      Method applied to identify words when searching this index.

      Values are lucene.standard, lucene.simple, lucene.whitespace, lucene.keyword, lucene.arabic, lucene.armenian, lucene.basque, lucene.bengali, lucene.brazilian, lucene.bulgarian, lucene.catalan, lucene.chinese, lucene.cjk, lucene.czech, lucene.danish, lucene.dutch, lucene.english, lucene.finnish, lucene.french, lucene.galician, lucene.german, lucene.greek, lucene.hindi, lucene.hungarian, lucene.indonesian, lucene.irish, lucene.italian, lucene.japanese, lucene.korean, lucene.kuromoji, lucene.latvian, lucene.lithuanian, lucene.morfologik, lucene.nori, lucene.norwegian, lucene.persian, lucene.portuguese, lucene.romanian, lucene.russian, lucene.smartcn, lucene.sorani, lucene.spanish, lucene.swedish, lucene.thai, lucene.turkish, or lucene.ukrainian. Default value is lucene.standard.

    • 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 Stored Source Fields.

      Stored Source Fields
    • synonyms array[object]

      Rule sets that map words to their synonyms in this index.

      Synonyms used for this full text index.

      Synonym Mapping
      Hide synonyms attributes Show synonyms attributes object

      • analyzer string Required

        Specific pre-defined method chosen to apply to the synonyms to be searched.

        Values are lucene.standard, lucene.simple, lucene.whitespace, lucene.keyword, lucene.arabic, lucene.armenian, lucene.basque, lucene.bengali, lucene.brazilian, lucene.bulgarian, lucene.catalan, lucene.chinese, lucene.cjk, lucene.czech, lucene.danish, lucene.dutch, lucene.english, lucene.finnish, lucene.french, lucene.galician, lucene.german, lucene.greek, lucene.hindi, lucene.hungarian, lucene.indonesian, lucene.irish, lucene.italian, lucene.japanese, lucene.korean, lucene.kuromoji, lucene.latvian, lucene.lithuanian, lucene.morfologik, lucene.nori, lucene.norwegian, lucene.persian, lucene.portuguese, lucene.romanian, lucene.russian, lucene.smartcn, lucene.sorani, lucene.spanish, lucene.swedish, lucene.thai, lucene.turkish, or lucene.ukrainian.

      • name string Required

        Label that identifies the synonym definition. Each synonym.name must be unique within the same index definition.

      • source object Required

        Data set that stores words and their applicable synonyms.

        Hide source attribute Show source attribute object

        • collection string Required

          Label that identifies the MongoDB collection that stores words and their applicable synonyms.

  • latestDefinitionVersion object

    Object which includes the version number of the index definition and the time that the index definition was created.

    Hide latestDefinitionVersion attributes Show latestDefinitionVersion attributes object

    • createdAt string(date-time)

      The time at which this index definition was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    • version integer(int64)

      The version number associated with this index definition when it was created.

  • name string

    Label that identifies this index. Within each namespace, the names of all indexes must be unique.

  • queryable boolean

    Flag that indicates whether the index is queryable on all hosts.

  • status string

    Condition of the search index when you made this request.

    • DELETING: The index is being deleted.
    • FAILED The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
    • STALE: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
    • PENDING: Atlas has not yet started building the index.
    • BUILDING: Atlas is building or re-building the index after an edit.
    • READY: The index is ready and can support queries.

    Values are DELETING, FAILED, STALE, PENDING, BUILDING, READY, or DOES_NOT_EXIST.

  • statusDetail array[object]

    List of documents detailing index status on each host.

    Hide statusDetail attributes Show statusDetail attributes object

    • hostname string

      Hostname that corresponds to the status detail.

    • mainIndex object

      Contains status information about the active index.

      Hide mainIndex attributes Show mainIndex attributes object

      • definition object

        The search index definition set by the user.

        Hide definition attribute Show definition attribute object

        • numPartitions integer(int32)

          Number of index partitions. Allowed values are [1, 2, 4].

          Default value is 1.

      • definitionVersion object

        Object which includes the version number of the index definition and the time that the index definition was created.

        Hide definitionVersion attributes Show definitionVersion attributes object

        • createdAt string(date-time)

          The time at which this index definition was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

        • version integer(int64)

          The version number associated with this index definition when it was created.

      • message string

        Optional message describing an error.

      • queryable boolean

        Flag that indicates whether the index generation is queryable on the host.

      • status string

        Condition of the search index when you made this request.

        • DELETING: The index is being deleted.
        • FAILED The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
        • STALE: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
        • PENDING: Atlas has not yet started building the index.
        • BUILDING: Atlas is building or re-building the index after an edit.
        • READY: The index is ready and can support queries.

        Values are DELETING, FAILED, STALE, PENDING, BUILDING, READY, or DOES_NOT_EXIST.

    • queryable boolean

      Flag that indicates whether the index is queryable on the host.

    • stagedIndex object

      Contains status information about an index building in the background.

      Hide stagedIndex attributes Show stagedIndex attributes object

      • definition object

        The search index definition set by the user.

        Hide definition attribute Show definition attribute object

        • numPartitions integer(int32)

          Number of index partitions. Allowed values are [1, 2, 4].

          Default value is 1.

      • definitionVersion object

        Object which includes the version number of the index definition and the time that the index definition was created.

        Hide definitionVersion attributes Show definitionVersion attributes object

        • createdAt string(date-time)

          The time at which this index definition was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

        • version integer(int64)

          The version number associated with this index definition when it was created.

      • message string

        Optional message describing an error.

      • queryable boolean

        Flag that indicates whether the index generation is queryable on the host.

      • status string

        Condition of the search index when you made this request.

        • DELETING: The index is being deleted.
        • FAILED The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
        • STALE: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
        • PENDING: Atlas has not yet started building the index.
        • BUILDING: Atlas is building or re-building the index after an edit.
        • READY: The index is ready and can support queries.

        Values are DELETING, FAILED, STALE, PENDING, BUILDING, READY, or DOES_NOT_EXIST.

    • status string

      Condition of the search index when you made this request.

      • DELETING: The index is being deleted.
      • FAILED The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
      • STALE: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
      • PENDING: Atlas has not yet started building the index.
      • BUILDING: Atlas is building or re-building the index after an edit.
      • READY: The index is ready and can support queries.

      Values are DELETING, FAILED, STALE, PENDING, BUILDING, READY, or DOES_NOT_EXIST.

  • type string Discriminator

    Type of the index. The default type is search.

    Value is search.

  • synonymMappingStatus string

    Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.

    Values are FAILED, BUILDING, or READY.

  • synonymMappingStatusDetail array[object]

    A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.

    Hide synonymMappingStatusDetail attribute Show synonymMappingStatusDetail attribute object

    • * object Additional properties

      Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.

      Hide * attributes Show * attributes object

      • message string

        Optional message describing an error.

      • queryable boolean

        Flag that indicates whether the synonym mapping is queryable on a host.

      • status string

        Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.

        Values are FAILED, BUILDING, or READY.

  Hide attributes Show attributes

  • collectionName string

    Label that identifies the collection that contains one or more Atlas Search indexes.

  • database string

    Label that identifies the database that contains the collection with one or more Atlas Search indexes.

  • indexID string

    Unique 24-hexadecimal digit string that identifies this Atlas Search index.

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

  • latestDefinition object

    The vector search index definition set by the user.

    Hide latestDefinition attributes Show latestDefinition attributes object

    • numPartitions integer(int32)

      Number of index partitions. Allowed values are [1, 2, 4].

      Default value is 1.

    • fields array[object]

      Settings that configure the fields, one per object, to index. You must define at least one "vector" type field. You can optionally define "filter" type fields also.

      Vector Search Fields
      Hide fields attribute Show fields attribute object

      • * object Additional properties
  • latestDefinitionVersion object

    Object which includes the version number of the index definition and the time that the index definition was created.

    Hide latestDefinitionVersion attributes Show latestDefinitionVersion attributes object

    • createdAt string(date-time)

      The time at which this index definition was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    • version integer(int64)

      The version number associated with this index definition when it was created.

  • name string

    Label that identifies this index. Within each namespace, the names of all indexes must be unique.

  • queryable boolean

    Flag that indicates whether the index is queryable on all hosts.

  • status string

    Condition of the search index when you made this request.

    • DELETING: The index is being deleted.
    • FAILED The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
    • STALE: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
    • PENDING: Atlas has not yet started building the index.
    • BUILDING: Atlas is building or re-building the index after an edit.
    • READY: The index is ready and can support queries.

    Values are DELETING, FAILED, STALE, PENDING, BUILDING, READY, or DOES_NOT_EXIST.

  • statusDetail array[object]

    List of documents detailing index status on each host.

    Hide statusDetail attributes Show statusDetail attributes object

    • hostname string

      Hostname that corresponds to the status detail.

    • mainIndex object

      Contains status information about the active index.

      Hide mainIndex attributes Show mainIndex attributes object

      • definition object

        The search index definition set by the user.

        Hide definition attribute Show definition attribute object

        • numPartitions integer(int32)

          Number of index partitions. Allowed values are [1, 2, 4].

          Default value is 1.

      • definitionVersion object

        Object which includes the version number of the index definition and the time that the index definition was created.

        Hide definitionVersion attributes Show definitionVersion attributes object

        • createdAt string(date-time)

          The time at which this index definition was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

        • version integer(int64)

          The version number associated with this index definition when it was created.

      • message string

        Optional message describing an error.

      • queryable boolean

        Flag that indicates whether the index generation is queryable on the host.

      • status string

        Condition of the search index when you made this request.

        • DELETING: The index is being deleted.
        • FAILED The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
        • STALE: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
        • PENDING: Atlas has not yet started building the index.
        • BUILDING: Atlas is building or re-building the index after an edit.
        • READY: The index is ready and can support queries.

        Values are DELETING, FAILED, STALE, PENDING, BUILDING, READY, or DOES_NOT_EXIST.

    • queryable boolean

      Flag that indicates whether the index is queryable on the host.

    • stagedIndex object

      Contains status information about an index building in the background.

      Hide stagedIndex attributes Show stagedIndex attributes object

      • definition object

        The search index definition set by the user.

        Hide definition attribute Show definition attribute object

        • numPartitions integer(int32)

          Number of index partitions. Allowed values are [1, 2, 4].

          Default value is 1.

      • definitionVersion object

        Object which includes the version number of the index definition and the time that the index definition was created.

        Hide definitionVersion attributes Show definitionVersion attributes object

        • createdAt string(date-time)

          The time at which this index definition was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

        • version integer(int64)

          The version number associated with this index definition when it was created.

      • message string

        Optional message describing an error.

      • queryable boolean

        Flag that indicates whether the index generation is queryable on the host.

      • status string

        Condition of the search index when you made this request.

        • DELETING: The index is being deleted.
        • FAILED The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
        • STALE: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
        • PENDING: Atlas has not yet started building the index.
        • BUILDING: Atlas is building or re-building the index after an edit.
        • READY: The index is ready and can support queries.

        Values are DELETING, FAILED, STALE, PENDING, BUILDING, READY, or DOES_NOT_EXIST.

    • status string

      Condition of the search index when you made this request.

      • DELETING: The index is being deleted.
      • FAILED The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
      • STALE: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
      • PENDING: Atlas has not yet started building the index.
      • BUILDING: Atlas is building or re-building the index after an edit.
      • READY: The index is ready and can support queries.

      Values are DELETING, FAILED, STALE, PENDING, BUILDING, READY, or DOES_NOT_EXIST.

  • type string Discriminator

    Type of the index. The default type is search.

    Value is vectorSearch.

• 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.

• 401 application/json

  Unauthorized.

  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.

• 403 application/json

  Forbidden.

  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.

• 409 application/json

  Conflict.

  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.