Verify Connect via Peering-Only Mode for One Project

Create One Atlas Search Index Deprecated

POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes

Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role.

Atlas Search Indexes

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

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

Body object Required

Creates one Atlas Search index on the specified collection.

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
- 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.
- 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
  
  type string Required
  
  Human-readable label that identifies this character filter type.
  
  Value is htmlStrip.
  
  ignoredTags array[string]
  
  The HTML tags that you want to exclude from filtering.
  
  Filter that applies normalization mappings that you specify to characters.
  
  Hide attributes Show attributes
  
  type string Required
  
  Human-readable label that identifies this character filter type.
  
  Value is mapping.
  
  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
- 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
  
  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
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is edgeGram.
  
  minGram integer Required
  
  Characters to include in the shortest token that Atlas Search creates.
  
  maxGram integer Required
  
  Characters to include in the longest token that Atlas Search creates.
  
  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
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  minGram integer Required
  
  Characters to include in the shortest token that Atlas Search creates.
  
  maxGram integer Required
  
  Characters to include in the longest token that Atlas Search creates.
  
  Tokenizer that uses a regular expression pattern to extract tokens.
  
  Hide attributes Show attributes
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is regexCaptureGroup.
  
  pattern string Required
  
  Regular expression to match against.
  
  group integer Required
  
  Index of the character group within the matching expression to extract into tokens. Use 0 to extract all character groups.
  
  Tokenizer that splits tokens using a regular-expression based delimiter.
  
  Hide attributes Show attributes
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is regexSplit.
  
  pattern string Required
  
  Regular expression to match against.
  
  Tokenizer that splits tokens based on word break rules from the Unicode Text Segmentation algorithm.
  
  Hide attributes Show attributes
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is standard.
  
  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.
  
  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
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is uaxUrlEmail.
  
  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.
  
  Tokenizer that creates tokens based on occurrences of whitespace between words.
  
  Hide attributes Show attributes
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is whitespace.
  
  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.
- 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
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is asciiFolding.
  
  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.
  
  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
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is daitchMokotoffSoundex.
  
  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.
  
  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
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is edgeGram.
  
  minGram integer Required
  
  Value that specifies the minimum length of generated n-grams. This value must be less than or equal to maxGram.
  
  maxGram integer Required
  
  Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to minGram.
  
  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.
  
  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 normalizes tokens using a standard Unicode Normalization Mode.
  
  Hide attributes Show attributes
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is icuNormalizer.
  
  normalizationForm string
  
  Normalization form to apply.
  
  Values are nfd, nfc, nfkd, or nfkc. Default value is nfc.
  
  Filter that removes tokens that are too short or too long.
  
  Hide attributes Show attributes
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is length.
  
  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.
  
  max integer
  
  Number that specifies the maximum length of a token. Value must be greater than or equal to min.
  
  Default value is 255.
  
  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
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is nGram.
  
  minGram integer Required
  
  Value that specifies the minimum length of generated n-grams. This value must be less than or equal to maxGram.
  
  maxGram integer Required
  
  Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to minGram.
  
  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.
  
  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
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is regex.
  
  pattern string Required
  
  Regular expression pattern to apply to each token.
  
  replacement string Required
  
  Replacement string to substitute wherever a matching pattern occurs.
  
  matches string Required
  
  Value that indicates whether to replace only the first matching pattern or all matching patterns.
  
  Values are all or first.
  
  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
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is shingle.
  
  minShingleSize integer Required
  
  Value that specifies the minimum number of tokens per shingle. This value must be less than or equal to maxShingleSize.
  
  maxShingleSize integer Required
  
  Value that specifies the maximum number of tokens per shingle. This value must be greater than or equal to minShingleSize.
  
  Filter that stems tokens using a Snowball-generated stemmer.
  
  Hide attributes Show attributes
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is snowballStemming.
  
  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.
  
  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
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is stopword.
  
  tokens array[string] Required
  
  The stop words that correspond to the tokens to remove. Value must be one or more stop words.
  
  ignoreCase boolean
  
  Flag that indicates whether to ignore the case of stop words when filtering the tokens to remove.
  
  Default value is true.
  
  Filter that splits tokens into sub-tokens based on configured rules.
  
  Hide attributes Show attributes
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is wordDelimiterGraph.
  
  delimiterOptions object
  
  Object that contains the rules that determine how to split words into sub-words.
  
  Hide delimiterOptions attributes Show delimiterOptions attributes object
  
  generateWordParts boolean
  
  Flag that indicates whether to split tokens based on sub-words.
  
  Default value is true.
  
  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.
  
  concatenateWords boolean
  
  Flag that indicates whether to concatenate runs of sub-words.
  
  Default value is false.
  
  concatenateNumbers boolean
  
  Flag that indicates whether to concatenate runs of sub-numbers.
  
  Default value is false.
  
  concatenateAll boolean
  
  Flag that indicates whether to concatenate runs.
  
  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.
  
  ignoreKeywords boolean
  
  Flag that indicates whether to skip tokens with the keyword attribute set to true.
  
  Default value is false.
  
  protectedWords object
  
  Object that contains options for protected words.
  
  Hide protectedWords attributes Show protectedWords attributes object
  
  words array[string] Required
  
  List that contains the tokens to protect from delimination.
  
  ignoreCase boolean
  
  Flag that indicates whether to ignore letter case sensitivity for protected words.
  
  Default value is true.
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.

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

Responses

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

OK
One of:
search object vectorSearch 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

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.

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

type string Required

Human-readable label that identifies this character filter type.

Value is htmlStrip.

ignoredTags array[string]

The HTML tags that you want to exclude from filtering.

Filter that applies normalization mappings that you specify to characters.

Hide attributes Show attributes

type string Required

Human-readable label that identifies this character filter type.

Value is mapping.

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

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

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

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is edgeGram.

minGram integer Required

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

maxGram integer Required

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

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

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

minGram integer Required

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

maxGram integer Required

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

Tokenizer that uses a regular expression pattern to extract tokens.

Hide attributes Show attributes

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is regexCaptureGroup.

pattern string Required

Regular expression to match against.

group integer Required

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

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

Hide attributes Show attributes

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is regexSplit.

pattern string Required

Regular expression to match against.

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

Hide attributes Show attributes

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is standard.

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.

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

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is uaxUrlEmail.

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.

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

Hide attributes Show attributes

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is whitespace.

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.

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

type string Required

Human-readable label that identifies this token filter type.

Value is asciiFolding.

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.

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

type string Required

Human-readable label that identifies this token filter type.

Value is daitchMokotoffSoundex.

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.

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

type string Required

Human-readable label that identifies this token filter type.

Value is edgeGram.

minGram integer Required

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

maxGram integer Required

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

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.

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 normalizes tokens using a standard Unicode Normalization Mode.

Hide attributes Show attributes

type string Required

Human-readable label that identifies this token filter type.

Value is icuNormalizer.

normalizationForm string

Normalization form to apply.

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

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

Hide attributes Show attributes

type string Required

Human-readable label that identifies this token filter type.

Value is length.

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.

max integer

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

Default value is 255.

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

type string Required

Human-readable label that identifies this token filter type.

Value is nGram.

minGram integer Required

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

maxGram integer Required

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

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.

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

type string Required

Human-readable label that identifies this token filter type.

Value is regex.

pattern string Required

Regular expression pattern to apply to each token.

replacement string Required

Replacement string to substitute wherever a matching pattern occurs.

matches string Required

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

Values are all or first.

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

type string Required

Human-readable label that identifies this token filter type.

Value is shingle.

minShingleSize integer Required

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

maxShingleSize integer Required

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

Filter that stems tokens using a Snowball-generated stemmer.

Hide attributes Show attributes

type string Required

Human-readable label that identifies this token filter type.

Value is snowballStemming.

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.

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

type string Required

Human-readable label that identifies this token filter type.

Value is stopword.

tokens array[string] Required

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

ignoreCase boolean

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

Default value is true.

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

Hide attributes Show attributes

type string Required

Human-readable label that identifies this token filter type.

Value is wordDelimiterGraph.

delimiterOptions object

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

Hide delimiterOptions attributes Show delimiterOptions attributes object

generateWordParts boolean

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

Default value is true.

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.

concatenateWords boolean

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

Default value is false.

concatenateNumbers boolean

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

Default value is false.

concatenateAll boolean

Flag that indicates whether to concatenate runs.

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.

ignoreKeywords boolean

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

Default value is false.

protectedWords object

Object that contains options for protected words.

Hide protectedWords attributes Show protectedWords attributes object

words array[string] Required

List that contains the tokens to protect from delimination.

ignoreCase boolean

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

Default value is true.

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

POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes

curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v2/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/fts/indexes' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/vnd.atlas.2023-01-01+json"

Request examples

{
  "collectionName": "string",
  "database": "string",
  "name": "string",
  "numPartitions": 1,
  "type": "search",
  "analyzer": "lucene.standard",
  "analyzers": [
    {
      "name": "string",
      "charFilters": [
        {
          "type": "htmlStrip",
          "ignoredTags": [
            "string"
          ]
        }
      ],
      "tokenizer": {
        "type": "edgeGram",
        "minGram": 42,
        "maxGram": 42
      },
      "tokenFilters": [
        {
          "type": "asciiFolding",
          "originalTokens": "omit"
        }
      ]
    }
  ],
  "mappings": {
    "dynamic": false,
    "fields": {
      "additionalProperty1": {},
      "additionalProperty2": {}
    }
  },
  "searchAnalyzer": "lucene.standard",
  "storedSource": {
    "include | exclude": [
      "field1",
      "field2"
    ]
  },
  "synonyms": [
    {
      "analyzer": "lucene.standard",
      "name": "string",
      "source": {
        "collection": "string"
      }
    }
  ]
}

{
  "collectionName": "string",
  "database": "string",
  "name": "string",
  "numPartitions": 1,
  "type": "vectorSearch",
  "fields": [
    {
      "additionalProperty1": {},
      "additionalProperty2": {}
    }
  ]
}

Response examples (200)

{
  "collectionName": "string",
  "database": "string",
  "name": "string",
  "numPartitions": 1,
  "type": "search",
  "analyzer": "lucene.standard",
  "analyzers": [
    {
      "name": "string",
      "charFilters": [
        {
          "type": "htmlStrip",
          "ignoredTags": [
            "string"
          ]
        }
      ],
      "tokenizer": {
        "type": "edgeGram",
        "minGram": 42,
        "maxGram": 42
      },
      "tokenFilters": [
        {
          "type": "asciiFolding",
          "originalTokens": "omit"
        }
      ]
    }
  ],
  "mappings": {
    "dynamic": false,
    "fields": {
      "additionalProperty1": {},
      "additionalProperty2": {}
    }
  },
  "searchAnalyzer": "lucene.standard",
  "storedSource": {
    "include | exclude": [
      "field1",
      "field2"
    ]
  },
  "synonyms": [
    {
      "analyzer": "lucene.standard",
      "name": "string",
      "source": {
        "collection": "string"
      }
    }
  ]
}

{
  "collectionName": "string",
  "database": "string",
  "name": "string",
  "numPartitions": 1,
  "type": "vectorSearch",
  "fields": [
    {
      "additionalProperty1": {},
      "additionalProperty2": {}
    }
  ]
}

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 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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 (409)

{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}

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

Remove One Atlas Search Index by Name

DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}

Service accounts Digest auth

Removes one Atlas Search index that you identified with its database, collection, and name. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent.

Atlas Search Indexes

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 database and collection with one or more Application 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

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

Name of the Atlas Search index to delete.

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

204 application/vnd.atlas.2024-05-30+json

This endpoint does not return a response body.
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.
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.

DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}

curl \
 --request DELETE 'https://cloud.mongodb.com/api/atlas/v2/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

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 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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

Return All Restore Jobs for One Serverless Instance

GET /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs

Service accounts Digest auth

Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role.

This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Please use the listFlexBackupRestoreJobs endpoint instead.

listFlexBackupRestoreJobs

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

Human-readable label that identifies the serverless instance.

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.
includeCount boolean

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

Default value is true.
itemsPerPage integer

Number of items that the response returns per page.

Minimum value is 1, maximum value is 500. Default value is 100.
pageNum integer

Number of the page that displays the current set of the total objects that the response returns.

Minimum value is 1. Default value is 1.
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
Hide response attributes Show response attributes object
- links array[object]
  
  List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
  
  Web Linking Specification (RFC 5988)
  
  Hide links attributes Show links attributes object
  
  href string
  
  Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
  
  rel string
  
  Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
- results array[object]
  
  List of returned documents that MongoDB Cloud provides when completing this request.
  
  Hide results attributes Show results attributes object
  
  cancelled boolean
  
  Flag that indicates whether someone canceled this restore job.
  
  deliveryType string Required
  
  Human-readable label that categorizes the restore job to create.
  
  Values are automated, download, or pointInTime.
  
  deliveryUrl array[string]
  
  One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when "deliveryType" : "download".
  
  desiredTimestamp object
  
  BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.
  
  Hide desiredTimestamp attributes Show desiredTimestamp attributes object
  
  increment integer(int32)
  
  Order of the database operation that the oplog recorded at specific date and time.
  
  Minimum value is 1199145600.
  
  date string(date-time)
  
  Date and time when the oplog recorded this database operation. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  expired boolean
  
  Flag that indicates whether the restore job expired.
  
  expiresAt string(date-time)
  
  Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  failed boolean
  
  Flag that indicates whether the restore job failed.
  
  finishedAt string(date-time)
  
  Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  id string
  
  Unique 24-hexadecimal character string that identifies the restore job.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  links array[object]
  
  List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
  
  Web Linking Specification (RFC 5988)
  
  Hide links attributes Show links attributes object
  
  href string
  
  Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
  
  rel string
  
  Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
  
  oplogInc integer(int32)
  
  Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when "deliveryType" : "pointInTime" and oplogTs exceeds 0.
  
  Minimum value is 1.
  
  oplogTs integer(int32)
  
  Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when "deliveryType" : "pointInTime" and oplogTs exceeds 0.
  
  Minimum value is 1199145600.
  
  pointInTimeUTCSeconds integer(int32)
  
  Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when "deliveryType" : "pointInTime" and pointInTimeUTCSeconds exceeds 0.
  
  Minimum value is 1199145600.
  
  snapshotId string
  
  Unique 24-hexadecimal character string that identifies the snapshot.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  targetClusterName string Required
  
  Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when "deliveryType": "automated".
  
  Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
  
  targetGroupId string Required
  
  Unique 24-hexadecimal digit string that identifies the target project for the specified targetClusterName.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  timestamp string(date-time)
  
  Date and time when MongoDB Cloud took the snapshot associated with snapshotId. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- totalCount integer(int32)
  
  Total number of documents available. MongoDB Cloud omits this value if includeCount is set to false. The total number is an estimate and may not be exact.
  
  Minimum value is 0.
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.
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.

GET /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v2/groups/32b6e34b3d91647abb20e7b8/serverless/{clusterName}/backup/restoreJobs' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "cancelled": true,
      "deliveryType": "automated",
      "deliveryUrl": [
        "string"
      ],
      "desiredTimestamp": {
        "increment": 1199145600,
        "date": "2025-05-04T09:42:00Z"
      },
      "expired": true,
      "expiresAt": "2025-05-04T09:42:00Z",
      "failed": true,
      "finishedAt": "2025-05-04T09:42:00Z",
      "id": "32b6e34b3d91647abb20e7b8",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "oplogInc": 1,
      "oplogTs": 42,
      "pointInTimeUTCSeconds": 42,
      "snapshotId": "32b6e34b3d91647abb20e7b8",
      "targetClusterName": "string",
      "targetGroupId": "32b6e34b3d91647abb20e7b8",
      "timestamp": "2025-05-04T09:42:00Z"
    }
  ],
  "totalCount": 42
}

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 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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

Return All Projects Available for Migration

GET /api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects

Service accounts Digest auth

Return all projects that you can migrate to the specified organization.

Path parameters

orgId string Required

Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.

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

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
Hide response attributes Show response attributes object
- deployments array[object]
  
  List of clusters that can be migrated to MongoDB Cloud.
  
  Deployments that can be migrated to MongoDB Atlas.
  
  Hide deployments attributes Show deployments attributes object
  
  agentVersion string
  
  Version of MongoDB Agent that monitors/manages the cluster.
  
  clusterId string
  
  Unique 24-hexadecimal digit string that identifies the cluster.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  dbSizeBytes integer(int64)
  
  Size of this database on disk at the time of the request expressed in bytes.
  
  featureCompatibilityVersion string Required
  
  Version of MongoDB features that this cluster supports.
  
  MongoDB feature versions
  
  managed boolean Required
  
  Flag that indicates whether Automation manages this cluster.
  
  mongoDBVersion string Required
  
  Version of MongoDB that this cluster runs.
  
  name string Required
  
  Human-readable label that identifies this cluster.
  
  oplogSizeMB integer(int32)
  
  Size of the Oplog on disk at the time of the request expressed in MB.
  
  sharded boolean Required
  
  Flag that indicates whether someone configured this cluster as a sharded cluster.
  
  If true, this cluster serves as a sharded cluster.
  
  If false, this cluster serves as a replica set.
  
  shardsSize integer(int32)
  
  Number of shards that comprise this cluster.
  
  tlsEnabled boolean Required
  
  Flag that indicates whether someone enabled TLS for this cluster.
- migrationHosts array[string]
  
  Hostname of MongoDB Agent list that you configured to perform a migration.
- name string Required
  
  Human-readable label that identifies this project.
  
  Minimum length is 1, maximum length is 64.
- projectId string Required
  
  Unique 24-hexadecimal digit string that identifies the project to be migrated.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
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.
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.

GET /api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v2/orgs/4888442a3354817a7320eb61/liveMigrations/availableProjects' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

[
  {
    "deployments": [
      {
        "agentVersion": "string",
        "clusterId": "32b6e34b3d91647abb20e7b8",
        "dbSizeBytes": 8192,
        "featureCompatibilityVersion": "string",
        "managed": true,
        "mongoDBVersion": "string",
        "name": "Project X sharded cluster",
        "oplogSizeMB": 3,
        "sharded": true,
        "shardsSize": 3,
        "tlsEnabled": true
      }
    ],
    "migrationHosts": [
      "string"
    ],
    "name": "string",
    "projectId": "32b6e34b3d91647abb20e7b8"
  }
]

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 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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

Return One Migration Job

GET /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}

Service accounts Digest auth

Return details of one cluster migration job. Each push live migration job uses one migration host. Your API Key must have the Organization Member role to successfully call this resource.

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})$.
liveMigrationId string Required

Unique 24-hexadecimal digit string that identifies the migration.

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

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
Hide response attributes Show response attributes object
- _id string
  
  Unique 24-hexadecimal digit string that identifies the migration job.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- lagTimeSeconds integer(int64) | null
  
  Replication lag between the source and destination clusters. Atlas returns this setting only during an active migration, before the cutover phase.
- migrationHosts array[string]
  
  List of hosts running MongoDB Agents. These Agents can transfer your MongoDB data between one source and one destination cluster.
  
  Format of each should match the following pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?$.
- readyForCutover boolean
  
  Flag that indicates the migrated cluster can be cut over to MongoDB Atlas.
- status string
  
  Progress made in migrating one cluster to MongoDB Atlas.
  
  NEW: Someone scheduled a local cluster migration to MongoDB Atlas.
  
  FAILED: The cluster migration to MongoDB Atlas failed.
  
  COMPLETE: The cluster migration to MongoDB Atlas succeeded.
  
  EXPIRED: MongoDB Atlas prepares to begin the cut over of the migrating cluster when source and destination clusters have almost synchronized. If "readyForCutover" : true, this synchronization starts a timer of 120 hours. You can extend this timer. If the timer expires, MongoDB Atlas returns this status.
  
  WORKING: The cluster migration to MongoDB Atlas is performing one of the following tasks:
  
  Preparing connections to source and destination clusters.
  
  Replicating data from source to destination.
  
  Verifying MongoDB Atlas connection settings.
  
  Stopping replication after the cut over.
  
  Values are NEW, WORKING, FAILED, COMPLETE, or EXPIRED.
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.

GET /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v2/groups/32b6e34b3d91647abb20e7b8/liveMigrations/6296fb4c7c7aa997cf94e9a8' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "_id": "32b6e34b3d91647abb20e7b8",
  "lagTimeSeconds": 42,
  "migrationHosts": [
    "vm001.example.com"
  ],
  "readyForCutover": true,
  "status": "NEW"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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

Update Advanced Configuration Options for One Cluster

PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs

Service accounts Digest auth

Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters.

Global Clusters

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

Human-readable label that identifies the cluster.

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

Body Required

Advanced configuration details to add for one cluster in the specified project.

changeStreamOptionsPreAndPostImagesExpireAfterSeconds integer(int32)

The minimum pre- and post-image retention time in seconds.

Default value is -1.

This option corresponds to the ``changeStreamOptionspreAndPostImagesexpireAfterSeconds`` cluster parameter This setting controls the retention policy of change stream pre- and post-images Pre- and post-images are the versions of a document before and after document modification, respectively ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog To set the minimum pre- and post-image retention time, specify an integer value greater than zero Setting this too low could increase the risk of interrupting Realm sync or triggers processing The default value is -1 (off)
chunkMigrationConcurrency integer(int32)

Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.

This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option
customOpensslCipherConfigTls12 array[string]

The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when tlsCipherConfigMode is set to CUSTOM.

Values are TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 or TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256.
defaultMaxTimeMS integer(int32)

Default time limit in milliseconds for individual read operations to complete.

This option corresponds to the defaultMaxTimeMS cluster parameter
defaultReadConcern string

Default level of acknowledgment requested from MongoDB for read operations set for this cluster.

MongoDB 4.4 clusters default to available. MongoDB 5.0 and later clusters default to local.

Values are local or available. Default value is available.

This option corresponds to the global default read concern
defaultWriteConcern string

Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.

This option corresponds to the the implicit default write concern
failIndexKeyTooLong boolean Deprecated

Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, mongod writes documents that exceed this limit but doesn't index them. This parameter has been removed as of MongoDB 4.4.

Default value is true.

This option corresponds to the `failIndexKeyTooLong` `mongod` configuration file option
javascriptEnabled boolean

Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript. When using 8.0+, we recommend disabling server-side JavaScript and using operators of aggregation pipeline as more performant alternative.

This option corresponds to modifying the `securityjavascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster
minimumEnabledTlsProtocol string

Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.

Values are TLS1_0, TLS1_1, or TLS1_2.

This option corresponds to the `netssldisabledProtocols` `mongod` configuration file option
noTableScan boolean

Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.

This option corresponds to the `notablescan` `mongod` configuration file option
oplogMinRetentionHours number(double) | null

Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.

This option corresponds to the `storageoplogMinRetentionHours` `mongod` configuration file option
oplogSizeMB integer(int32) | null

Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.

This option corresponds to the `replicationoplogSizeMB` `mongod` configuration file option
queryStatsLogVerbosity integer(int32)

May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.

This option corresponds to the queryStats component for the logComponentVerbosity server parameter
sampleRefreshIntervalBIConnector integer(int32)

Interval in seconds at which the mongosqld process re-samples data to create its relational schema.

Minimum value is 0. Default value is 0.

This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option
sampleSizeBIConnector integer(int32)

Number of documents per database to sample when gathering schema information.

Minimum value is 0.

This option corresponds to the `sampleSize` `mongosqld` option
tlsCipherConfigMode string

The TLS cipher suite configuration mode. The default mode uses the default cipher suites. The custom mode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3.

Values are CUSTOM or DEFAULT.
transactionLifetimeLimitSeconds integer(int64)

Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.

Minimum value is 1.

This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option

Responses

200

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

application/vnd.atlas.2023-01-01+json application/vnd.atlas.2024-08-05+json

OK
Hide response attributes Show response attributes object
- changeStreamOptionsPreAndPostImagesExpireAfterSeconds integer(int32)
  
  The minimum pre- and post-image retention time in seconds.
  
  Default value is -1.
  
  This option corresponds to the ``changeStreamOptionspreAndPostImagesexpireAfterSeconds`` cluster parameter This setting controls the retention policy of change stream pre- and post-images Pre- and post-images are the versions of a document before and after document modification, respectively ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog To set the minimum pre- and post-image retention time, specify an integer value greater than zero Setting this too low could increase the risk of interrupting Realm sync or triggers processing The default value is -1 (off)
- chunkMigrationConcurrency integer(int32)
  
  Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.
  
  This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option
- customOpensslCipherConfigTls12 array[string]
  
  The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when tlsCipherConfigMode is set to CUSTOM.
  
  Values are TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 or TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256.
- defaultMaxTimeMS integer(int32)
  
  Default time limit in milliseconds for individual read operations to complete.
  
  This option corresponds to the defaultMaxTimeMS cluster parameter
- defaultReadConcern string
  
  Default level of acknowledgment requested from MongoDB for read operations set for this cluster.
  
  MongoDB 4.4 clusters default to available. MongoDB 5.0 and later clusters default to local.
  
  Values are local or available. Default value is available.
  
  This option corresponds to the global default read concern
- defaultWriteConcern string
  
  Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.
  
  This option corresponds to the the implicit default write concern
- failIndexKeyTooLong boolean Deprecated
  
  Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, mongod writes documents that exceed this limit but doesn't index them. This parameter has been removed as of MongoDB 4.4.
  
  Default value is true.
  
  This option corresponds to the `failIndexKeyTooLong` `mongod` configuration file option
- javascriptEnabled boolean
  
  Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript. When using 8.0+, we recommend disabling server-side JavaScript and using operators of aggregation pipeline as more performant alternative.
  
  This option corresponds to modifying the `securityjavascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster
- minimumEnabledTlsProtocol string
  
  Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.
  
  Values are TLS1_0, TLS1_1, or TLS1_2.
  
  This option corresponds to the `netssldisabledProtocols` `mongod` configuration file option
- noTableScan boolean
  
  Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.
  
  This option corresponds to the `notablescan` `mongod` configuration file option
- oplogMinRetentionHours number(double) | null
  
  Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
  
  This option corresponds to the `storageoplogMinRetentionHours` `mongod` configuration file option
- oplogSizeMB integer(int32) | null
  
  Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.
  
  This option corresponds to the `replicationoplogSizeMB` `mongod` configuration file option
- queryStatsLogVerbosity integer(int32)
  
  May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.
  
  This option corresponds to the queryStats component for the logComponentVerbosity server parameter
- sampleRefreshIntervalBIConnector integer(int32)
  
  Interval in seconds at which the mongosqld process re-samples data to create its relational schema.
  
  Minimum value is 0. Default value is 0.
  
  This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option
- sampleSizeBIConnector integer(int32)
  
  Number of documents per database to sample when gathering schema information.
  
  Minimum value is 0.
  
  This option corresponds to the `sampleSize` `mongosqld` option
- tlsCipherConfigMode string
  
  The TLS cipher suite configuration mode. The default mode uses the default cipher suites. The custom mode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3.
  
  Values are CUSTOM or DEFAULT.
- transactionLifetimeLimitSeconds integer(int64)
  
  Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.
  
  Minimum value is 1.
  
  This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option
Hide response attributes Show response attributes object
- changeStreamOptionsPreAndPostImagesExpireAfterSeconds integer(int32)
  
  The minimum pre- and post-image retention time in seconds.
  
  Default value is -1.
  
  This option corresponds to the ``changeStreamOptionspreAndPostImagesexpireAfterSeconds`` cluster parameter This setting controls the retention policy of change stream pre- and post-images Pre- and post-images are the versions of a document before and after document modification, respectively ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog To set the minimum pre- and post-image retention time, specify an integer value greater than zero Setting this too low could increase the risk of interrupting Realm sync or triggers processing The default value is -1 (off)
- chunkMigrationConcurrency integer(int32)
  
  Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.
  
  This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option
- customOpensslCipherConfigTls12 array[string]
  
  The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when tlsCipherConfigMode is set to CUSTOM.
  
  Values are TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 or TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256.
- defaultMaxTimeMS integer(int32)
  
  Default time limit in milliseconds for individual read operations to complete.
  
  This option corresponds to the defaultMaxTimeMS cluster parameter
- defaultWriteConcern string
  
  Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.
  
  This option corresponds to the the implicit default write concern
- javascriptEnabled boolean
  
  Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript. When using 8.0+, we recommend disabling server-side JavaScript and using operators of aggregation pipeline as more performant alternative.
  
  This option corresponds to modifying the `securityjavascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster
- minimumEnabledTlsProtocol string
  
  Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.
  
  Values are TLS1_0, TLS1_1, or TLS1_2.
  
  This option corresponds to the `netssldisabledProtocols` `mongod` configuration file option
- noTableScan boolean
  
  Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.
  
  This option corresponds to the `notablescan` `mongod` configuration file option
- oplogMinRetentionHours number(double) | null
  
  Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
  
  This option corresponds to the `storageoplogMinRetentionHours` `mongod` configuration file option
- oplogSizeMB integer(int32) | null
  
  Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.
  
  This option corresponds to the `replicationoplogSizeMB` `mongod` configuration file option
- queryStatsLogVerbosity integer(int32)
  
  May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.
  
  This option corresponds to the queryStats component for the logComponentVerbosity server parameter
- sampleRefreshIntervalBIConnector integer(int32)
  
  Interval in seconds at which the mongosqld process re-samples data to create its relational schema.
  
  Minimum value is 0. Default value is 0.
  
  This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option
- sampleSizeBIConnector integer(int32)
  
  Number of documents per database to sample when gathering schema information.
  
  Minimum value is 0.
  
  This option corresponds to the `sampleSize` `mongosqld` option
- tlsCipherConfigMode string
  
  The TLS cipher suite configuration mode. The default mode uses the default cipher suites. The custom mode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3.
  
  Values are CUSTOM or DEFAULT.
- transactionLifetimeLimitSeconds integer(int64)
  
  Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.
  
  Minimum value is 1.
  
  This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option
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.
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.

PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs

curl \
 --request PATCH 'https://cloud.mongodb.com/api/atlas/v2/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/processArgs' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/vnd.atlas.2023-01-01+json"

curl \
 --request PATCH 'https://cloud.mongodb.com/api/atlas/v2/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/processArgs' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/vnd.atlas.2024-08-05+json"

Request examples

{
  "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  "chunkMigrationConcurrency": 42,
  "customOpensslCipherConfigTls12": [
    "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
  ],
  "defaultMaxTimeMS": 42,
  "defaultReadConcern": "available",
  "defaultWriteConcern": "string",
  "failIndexKeyTooLong": true,
  "javascriptEnabled": true,
  "minimumEnabledTlsProtocol": "TLS1_0",
  "noTableScan": true,
  "oplogMinRetentionHours": 42.0,
  "oplogSizeMB": 42,
  "queryStatsLogVerbosity": 42,
  "sampleRefreshIntervalBIConnector": 0,
  "sampleSizeBIConnector": 42,
  "tlsCipherConfigMode": "CUSTOM",
  "transactionLifetimeLimitSeconds": 42
}

Request examples

{
  "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  "chunkMigrationConcurrency": 42,
  "customOpensslCipherConfigTls12": [
    "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
  ],
  "defaultMaxTimeMS": 42,
  "defaultWriteConcern": "string",
  "javascriptEnabled": true,
  "minimumEnabledTlsProtocol": "TLS1_0",
  "noTableScan": true,
  "oplogMinRetentionHours": 42.0,
  "oplogSizeMB": 42,
  "queryStatsLogVerbosity": 42,
  "sampleRefreshIntervalBIConnector": 0,
  "sampleSizeBIConnector": 42,
  "tlsCipherConfigMode": "CUSTOM",
  "transactionLifetimeLimitSeconds": 42
}

Response examples (200)

{
  "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  "chunkMigrationConcurrency": 42,
  "customOpensslCipherConfigTls12": [
    "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
  ],
  "defaultMaxTimeMS": 42,
  "defaultReadConcern": "available",
  "defaultWriteConcern": "string",
  "failIndexKeyTooLong": true,
  "javascriptEnabled": true,
  "minimumEnabledTlsProtocol": "TLS1_0",
  "noTableScan": true,
  "oplogMinRetentionHours": 42.0,
  "oplogSizeMB": 42,
  "queryStatsLogVerbosity": 42,
  "sampleRefreshIntervalBIConnector": 0,
  "sampleSizeBIConnector": 42,
  "tlsCipherConfigMode": "CUSTOM",
  "transactionLifetimeLimitSeconds": 42
}

Response examples (200)

{
  "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  "chunkMigrationConcurrency": 42,
  "customOpensslCipherConfigTls12": [
    "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
  ],
  "defaultMaxTimeMS": 42,
  "defaultWriteConcern": "string",
  "javascriptEnabled": true,
  "minimumEnabledTlsProtocol": "TLS1_0",
  "noTableScan": true,
  "oplogMinRetentionHours": 42.0,
  "oplogSizeMB": 42,
  "queryStatsLogVerbosity": 42,
  "sampleRefreshIntervalBIConnector": 0,
  "sampleSizeBIConnector": 42,
  "tlsCipherConfigMode": "CUSTOM",
  "transactionLifetimeLimitSeconds": 42
}

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 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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

Return Host-Level Query Latency

GET /api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements

Service accounts Digest auth

Get a list of the Coll Stats Latency process-level measurements for the given namespace.

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})$.
processId string Required

Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

Format should match the following pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$.
databaseName string Required

Human-readable label that identifies the database.
collectionName string Required

Human-readable label that identifies the collection.

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.
metrics array[string]

List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.

Values are READS_OPS, READS_LATENCY, AVERAGE_READS_LATENCY, READS_P50_VALUE, READS_P95_VALUE, READS_P99_VALUE, WRITES_OPS, WRITES_LATENCY, AVERAGE_WRITES_LATENCY, WRITES_P50_VALUE, WRITES_P95_VALUE, WRITES_P99_VALUE, COMMANDS_OPS, COMMANDS_LATENCY, AVERAGE_COMMANDS_LATENCY, COMMANDS_P50_VALUE, COMMANDS_P95_VALUE, COMMANDS_P99_VALUE, TOTAL_OPS, TOTAL_LATENCY, AVERAGE_TOTAL_OPS_LATENCY, TOTAL_OPS_P50_VALUE, TOTAL_OPS_P95_VALUE, or TOTAL_OPS_P99_VALUE.
start string(date-time)

Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
end string(date-time)

Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
period string

Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.

Responses

200 application/vnd.atlas.2023-11-15+json

Succeeded
Hide response attributes Show response attributes object
- collectionName string
  
  Human-readable label that identifies the collection.
- databaseName string
  
  Human-readable label that identifies the database that the specified MongoDB process serves.
- end string(date-time)
  
  Date and time that specifies when to stop retrieving measurements. If you set end, you must set start. You can't set this parameter and period in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- granularity string
  
  Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either period or start and end.
  
  Values are PT1M, PT5M, PT1H, or P1D.
- groupId string
  
  Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the mongod or mongos.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- links array[object]
  
  List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
  
  Web Linking Specification (RFC 5988)
  
  Hide links attributes Show links attributes object
  
  href string
  
  Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
  
  rel string
  
  Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
- measurements array[object]
  
  List that contains measurements and their data points.
  
  Hide measurements attributes Show measurements attributes object
  
  dataPoints array[object]
  
  List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the value parameter returns null.
  
  value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the value parameter returns null.
  
  Hide dataPoints attributes Show dataPoints attributes object
  
  timestamp string(date-time)
  
  Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  value number
  
  Value that comprises this data point.
  
  name string
  
  Human-readable label of the measurement that this data point covers.
  
  units string
  
  Element used to quantify the measurement. The resource returns units of throughput, storage, and time.
  
  Values are BYTES, BYTES_PER_SECOND, GIGABYTES, GIGABYTES_PER_HOUR, MEGABYTES_PER_SECOND, MICROSECONDS, MILLISECONDS, PERCENT, SCALAR, or SCALAR_PER_SECOND.
- processId string
  
  Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.
  
  Format should match the following pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$.
- start string(date-time)
  
  Date and time that specifies when to start retrieving measurements. If you set start, you must set end. You can't set this parameter and period in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
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.
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.

GET /api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v2/groups/32b6e34b3d91647abb20e7b8/processes/my.host.name.com:27017/mydb/mycoll/collStats/measurements' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "collectionName": "string",
  "databaseName": "string",
  "end": "2025-05-04T09:42:00Z",
  "granularity": "PT1M",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "measurements": [
    {
      "dataPoints": [
        {
          "timestamp": "2025-05-04T09:42:00Z",
          "value": 42.0
        }
      ],
      "name": "string",
      "units": "BYTES"
    }
  ],
  "processId": "mongodb.example.com:27017",
  "start": "2025-05-04T09:42:00Z"
}

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 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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

Remove One Custom Role from One Project

DELETE /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}

Service accounts Digest auth

Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role.

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})$.
roleName string Required

Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.

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

204 application/vnd.atlas.2023-01-01+json

No Content
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.

DELETE /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}

curl \
 --request DELETE 'https://cloud.mongodb.com/api/atlas/v2/groups/32b6e34b3d91647abb20e7b8/customDBRoles/roles/{roleName}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

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 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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 (409)

{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}

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

Download Query Logs for One Federated Database Instance

GET /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz

Service accounts Digest auth

Downloads the query logs for the specified federated database instance. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".

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})$.
tenantName string Required

Human-readable label that identifies the federated database instance for which you want to download query logs.

Query parameters

endDate integer(int64)

Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.

Format should match the following pattern: 1199145600.
startDate integer(int64)

Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.

Format should match the following pattern: 1199145600.

Responses

200 application/vnd.atlas.2023-01-01+gzip

OK

Compressed archive labeled queryLogs.gz downloads
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.

GET /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v2/groups/32b6e34b3d91647abb20e7b8/dataFederation/{tenantName}/queryLogs.gz' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

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 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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 (409)

{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}

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

Return One Event from One Organization

GET /api/atlas/v2/orgs/{orgId}/events/{eventId}

Service accounts Digest auth

Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. Use the Return Events from One Organization endpoint to retrieve all events to which the authenticated user has access.

This resource remains under revision and may change.

Return Events from One Organization

Path parameters

orgId string Required

Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.

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

Unique 24-hexadecimal digit string that identifies the event that you want to return.

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

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
includeRaw boolean

Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.

Default value is false.

Responses

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

OK
One of:
DefaultEventViewForOrg object AlertAudit object AlertConfigAudit object ApiUserEventViewForOrg object ServiceAccountOrgEvents object BillingEventViewForOrg object NDSAuditViewForOrg object OrgEventViewForOrg object TeamEvent object UserEventViewForOrg object ResourceEventViewForOrg object AtlasResourcePolicyAuditForOrg object
Other events which don't have extra details beside of basic one.

Hide attributes Show attributes

apiKeyId string

Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the userId parameter.

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

Create Programmatic API Key

created string(date-time) Required

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

eventTypeName string Required

Unique identifier of event type.

One of:
Federation Settings Event Types string Group Audit Types string Mlab Migration Audit Types string Partner Event Types string Support Event Types string

Values are FEDERATION_SETTINGS_CREATED, FEDERATION_SETTINGS_DELETED, FEDERATION_SETTINGS_UPDATED, IDENTITY_PROVIDER_CREATED, IDENTITY_PROVIDER_UPDATED, IDENTITY_PROVIDER_DELETED, IDENTITY_PROVIDER_ACTIVATED, OIDC_IDENTITY_PROVIDER_UPDATED, IDENTITY_PROVIDER_DEACTIVATED, IDENTITY_PROVIDER_JWKS_REVOKED, OIDC_IDENTITY_PROVIDER_ENABLED, OIDC_IDENTITY_PROVIDER_DISABLED, DOMAINS_ASSOCIATED, DOMAIN_CREATED, DOMAIN_DELETED, DOMAIN_VERIFIED, ORG_SETTINGS_CONFIGURED, ORG_SETTINGS_UPDATED, ORG_SETTINGS_DELETED, RESTRICT_ORG_MEMBERSHIP_ENABLED, RESTRICT_ORG_MEMBERSHIP_DISABLED, ROLE_MAPPING_CREATED, ROLE_MAPPING_UPDATED, or ROLE_MAPPING_DELETED.

Values are MLAB_MIGRATION_COMPLETED, MLAB_MIGRATION_TARGET_CLUSTER_CREATED, MLAB_MIGRATION_DATABASE_USERS_IMPORTED, MLAB_MIGRATION_IP_WHITELIST_IMPORTED, MLAB_MIGRATION_TARGET_CLUSTER_SET, MLAB_MIGRATION_DATABASE_RENAMED, MLAB_MIGRATION_LIVE_IMPORT_STARTED, MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER, MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE, MLAB_MIGRATION_LIVE_IMPORT_ERROR, MLAB_MIGRATION_LIVE_IMPORT_CANCELLED, MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED, MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED, MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED, MLAB_MIGRATION_SUPPORT_PLAN_SELECTED, or MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT.

Values are AWS_SELF_SERVE_ACCOUNT_LINKED, AWS_SELF_SERVE_ACCOUNT_LINK_PENDING, AWS_SELF_SERVE_ACCOUNT_CANCELLED, AWS_SELF_SERVE_ACCOUNT_LINK_FAILED, GCP_SELF_SERVE_ACCOUNT_LINK_PENDING, GCP_SELF_SERVE_ACCOUNT_LINK_FAILED, AZURE_SELF_SERVE_ACCOUNT_LINKED, AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING, AZURE_SELF_SERVE_ACCOUNT_CANCELLED, AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED, GCP_SELF_SERVE_ACCOUNT_LINKED, GCP_SELF_SERVE_ACCOUNT_CANCELLED, VERCEL_SELF_SERVE_ACCOUNT_LINKED, VERCEL_SELF_SERVE_ACCOUNT_LINK_PENDING, VERCEL_SELF_SERVE_ACCOUNT_CANCELLED, VERCEL_SELF_SERVE_ACCOUNT_LINK_FAILED, VERCEL_INVOICE_CREATED, VERCEL_INVOICE_NOT_PAID, VERCEL_INVOICE_PAID, or VERCEL_INVOICE_REFUNDED.

groupId string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The eventId identifies the specific event.

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

id string Required

Unique 24-hexadecimal digit string that identifies the event.

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

isGlobalAdmin boolean

Flag that indicates whether a MongoDB employee triggered the specified event.

links array[object]

List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.

Web Linking Specification (RFC 5988)

Hide links attributes Show links attributes object

href string

Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

rel string

Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

publicKey string

Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the username parameter.

External documentation

raw object

Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter includeRaw=true. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.

Hide raw attributes Show raw attributes object

_t string

Unique identifier of event type.

alertConfigId string

Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.

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

cid string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred.

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

cre string(date-time)

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

description string

Description of the event.

gn string

Human-readable label that identifies the project.

Minimum length is 1, maximum length is 64.

id string

Unique 24-hexadecimal digit string that identifies the event.

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

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

orgName string

Human-readable label that identifies the organization that contains the project.

Minimum length is 1, maximum length is 64.

severity string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.

remoteAddress string

IPv4 or IPv6 address from which the user triggered this event.

Format should match the following pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

userId string

Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the apiKeyId parameter.

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

username string(email)

Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the publicApiKey parameter.
Alert audit indicates acknowledgement status of an alert.

Hide attributes Show attributes

alertId string

Unique 24-hexadecimal digit string that identifies the alert associated with the event.

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

apiKeyId string

Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the userId parameter.

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

Create Programmatic API Key

created string(date-time) Required

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

eventTypeName string Required

Unique identifier of event type.

Values are ALERT_ACKNOWLEDGED_AUDIT or ALERT_UNACKNOWLEDGED_AUDIT.

groupId string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The eventId identifies the specific event.

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

id string Required

Unique 24-hexadecimal digit string that identifies the event.

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

isGlobalAdmin boolean

Flag that indicates whether a MongoDB employee triggered the specified event.

links array[object]

List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.

Web Linking Specification (RFC 5988)

Hide links attributes Show links attributes object

href string

Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

rel string

Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

publicKey string

Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the username parameter.

External documentation

raw object

Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter includeRaw=true. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.

Hide raw attributes Show raw attributes object

_t string

Unique identifier of event type.

alertConfigId string

Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.

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

cid string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred.

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

cre string(date-time)

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

description string

Description of the event.

gn string

Human-readable label that identifies the project.

Minimum length is 1, maximum length is 64.

id string

Unique 24-hexadecimal digit string that identifies the event.

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

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

orgName string

Human-readable label that identifies the organization that contains the project.

Minimum length is 1, maximum length is 64.

severity string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.

remoteAddress string

IPv4 or IPv6 address from which the user triggered this event.

Format should match the following pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

userId string

Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the apiKeyId parameter.

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

username string(email)

Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the publicApiKey parameter.
Alert config audit indicates any activities around alert settings.

Hide attributes Show attributes

alertConfigId string

Unique 24-hexadecimal digit string that identifies the alert configuration associated with the alertId.

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

apiKeyId string

Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the userId parameter.

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

Create Programmatic API Key

created string(date-time) Required

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

eventTypeName string Required

Unique identifier of event type.

Values are ALERT_CONFIG_DISABLED_AUDIT, ALERT_CONFIG_ENABLED_AUDIT, ALERT_CONFIG_ADDED_AUDIT, ALERT_CONFIG_DELETED_AUDIT, or ALERT_CONFIG_CHANGED_AUDIT.

groupId string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The eventId identifies the specific event.

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

id string Required

Unique 24-hexadecimal digit string that identifies the event.

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

isGlobalAdmin boolean

Flag that indicates whether a MongoDB employee triggered the specified event.

links array[object]

List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.

Web Linking Specification (RFC 5988)

Hide links attributes Show links attributes object

href string

Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

rel string

Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

publicKey string

Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the username parameter.

External documentation

raw object

Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter includeRaw=true. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.

Hide raw attributes Show raw attributes object

_t string

Unique identifier of event type.

alertConfigId string

Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.

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

cid string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred.

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

cre string(date-time)

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

description string

Description of the event.

gn string

Human-readable label that identifies the project.

Minimum length is 1, maximum length is 64.

id string

Unique 24-hexadecimal digit string that identifies the event.

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

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

orgName string

Human-readable label that identifies the organization that contains the project.

Minimum length is 1, maximum length is 64.

severity string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.

remoteAddress string

IPv4 or IPv6 address from which the user triggered this event.

Format should match the following pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

userId string

Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the apiKeyId parameter.

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

username string(email)

Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the publicApiKey parameter.
API User event identifies different activities around user api keys.

Hide attributes Show attributes

apiKeyId string

Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the userId parameter.

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

Create Programmatic API Key

created string(date-time) Required

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

eventTypeName string Required

Unique identifier of event type.

Values are API_KEY_CREATED, API_KEY_DELETED, API_KEY_ACCESS_LIST_ENTRY_ADDED, API_KEY_ACCESS_LIST_ENTRY_DELETED, API_KEY_ROLES_CHANGED, API_KEY_DESCRIPTION_CHANGED, API_KEY_ADDED_TO_GROUP, API_KEY_REMOVED_FROM_GROUP, API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED, or API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED.

groupId string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The eventId identifies the specific event.

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

id string Required

Unique 24-hexadecimal digit string that identifies the event.

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

isGlobalAdmin boolean

Flag that indicates whether a MongoDB employee triggered the specified event.

links array[object]

List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.

Web Linking Specification (RFC 5988)

Hide links attributes Show links attributes object

href string

Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

rel string

Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

publicKey string

Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the username parameter.

External documentation

raw object

Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter includeRaw=true. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.

Hide raw attributes Show raw attributes object

_t string

Unique identifier of event type.

alertConfigId string

Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.

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

cid string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred.

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

cre string(date-time)

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

description string

Description of the event.

gn string

Human-readable label that identifies the project.

Minimum length is 1, maximum length is 64.

id string

Unique 24-hexadecimal digit string that identifies the event.

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

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

orgName string

Human-readable label that identifies the organization that contains the project.

Minimum length is 1, maximum length is 64.

severity string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.

remoteAddress string

IPv4 or IPv6 address from which the user triggered this event.

Format should match the following pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

targetPublicKey string

Public part of the API key that this event targets.

userId string

Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the apiKeyId parameter.

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

username string(email)

Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the publicApiKey parameter.

whitelistEntry string

Entry in the list of source host addresses that the API key accepts and this event targets.
Service Account event identifies different activities around user api keys.

Hide attributes Show attributes

apiKeyId string

Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the userId parameter.

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

Create Programmatic API Key

created string(date-time) Required

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

eventTypeName string Required

Unique identifier of event type.

Values are SERVICE_ACCOUNT_CREATED, SERVICE_ACCOUNT_DELETED, SERVICE_ACCOUNT_ROLES_CHANGED, SERVICE_ACCOUNT_DETAILS_CHANGED, SERVICE_ACCOUNT_ADDED_TO_GROUP, SERVICE_ACCOUNT_REMOVED_FROM_GROUP, SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED, SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED, SERVICE_ACCOUNT_SECRET_ADDED, SERVICE_ACCOUNT_SECRET_DELETED, SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED, or SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED.

groupId string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The eventId identifies the specific event.

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

id string Required

Unique 24-hexadecimal digit string that identifies the event.

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

isGlobalAdmin boolean

Flag that indicates whether a MongoDB employee triggered the specified event.

links array[object]

List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.

Web Linking Specification (RFC 5988)

Hide links attributes Show links attributes object

href string

Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

rel string

Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

publicKey string

Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the username parameter.

External documentation

raw object

Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter includeRaw=true. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.

Hide raw attributes Show raw attributes object

_t string

Unique identifier of event type.

alertConfigId string

Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.

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

cid string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred.

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

cre string(date-time)

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

description string

Description of the event.

gn string

Human-readable label that identifies the project.

Minimum length is 1, maximum length is 64.

id string

Unique 24-hexadecimal digit string that identifies the event.

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

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

orgName string

Human-readable label that identifies the organization that contains the project.

Minimum length is 1, maximum length is 64.

severity string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.

remoteAddress string

IPv4 or IPv6 address from which the user triggered this event.

Format should match the following pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

userId string

Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the apiKeyId parameter.

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

username string(email)

Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the publicApiKey parameter.
Billing event identifies different activities related to billing, payment or financial status change of an organization.

Hide attributes Show attributes

apiKeyId string

Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the userId parameter.

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

Create Programmatic API Key

created string(date-time) Required

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

eventTypeName string Required

Unique identifier of event type.

Values are CHARGE_SUCCEEDED, CHARGE_FAILED, CHARGE_PROCESSING, CHARGE_PENDING_REVERSAL, BRAINTREE_CHARGE_FAILED, INVOICE_CLOSED, CHECK_PAYMENT_RECEIVED, WIRE_TRANSFER_PAYMENT_RECEIVED, DISCOUNT_APPLIED, CREDIT_ISSUED, CREDIT_PULLED_FWD, CREDIT_END_DATE_MODIFIED, PROMO_CODE_APPLIED, PAYMENT_FORGIVEN, REFUND_ISSUED, ACCOUNT_DOWNGRADED, ACCOUNT_UPGRADED, ACCOUNT_MODIFIED, SUPPORT_PLAN_ACTIVATED, SUPPORT_PLAN_CANCELLED, SUPPORT_PLAN_CANCELLATION_SCHEDULED, INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC, INVOICE_ADDRESS_CHANGED, INVOICE_ADDRESS_ADDED, PREPAID_PLAN_ACTIVATED, ELASTIC_INVOICING_MODE_ACTIVATED, ELASTIC_INVOICING_MODE_DEACTIVATED, TERMINATE_PAID_SERVICES, BILLING_EMAIL_ADDRESS_ADDED, BILLING_EMAIL_ADDRESS_CHANGED, BILLING_EMAIL_ADDRESS_REMOVED, AWS_BILLING_ACCOUNT_CREDIT_ISSUED, GCP_BILLING_ACCOUNT_CREDIT_ISSUED, CREDIT_SFOLID_MODIFIED, PREPAID_PLAN_MODIFIED, AWS_USAGE_REPORTED, AZURE_USAGE_REPORTED, GCP_USAGE_REPORTED, BECAME_PAYING_ORG, NEW_LINKED_ORG, UNLINKED_ORG, ORG_LINKED_TO_PAYING_ORG, ORG_UNLINKED_FROM_PAYING_ORG, ORG_UNLINK_REQUESTED, ORG_UNLINK_CANCELLED, PAYMENT_UPDATED_THROUGH_API, AZURE_BILLING_ACCOUNT_CREDIT_ISSUED, CREDIT_START_DATE_MODIFIED, CREDIT_ELASTIC_INVOICING_MODIFIED, CREDIT_TYPE_MODIFIED, CREDIT_AMOUNT_CENTS_MODIFIED, CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED, CREDIT_TOTAL_BILLED_CENTS_MODIFIED, CREDIT_AWS_CUSTOMER_ID_MODIFIED, CREDIT_AWS_PRODUCT_CODE_MODIFIED, CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED, CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED, CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED, TARGETED_REBILL_EXECUTED, LEGACY_REBILL_EXECUTED, EVERGREEN_DEAL_CANCELLED, GRACE_PERIOD_ACTIVATED, GRACE_PERIOD_NO_LONGER_IN_EFFECT, PENDING_DEAL_ACTIVATION_ADDED, PENDING_DEAL_ACTIVATION_CANCELED, PENDING_DEAL_APPLIED, PENDING_DEAL_ACTIVATION_FAILED, or EVERGREEN_PRIORITY_MODIFIED.

groupId string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The eventId identifies the specific event.

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

id string Required

Unique 24-hexadecimal digit string that identifies the event.

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

invoiceId string

Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.

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

isGlobalAdmin boolean

Flag that indicates whether a MongoDB employee triggered the specified event.

links array[object]

List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.

Web Linking Specification (RFC 5988)

Hide links attributes Show links attributes object

href string

Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

rel string

Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

paymentId string

Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.

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

publicKey string

Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the username parameter.

External documentation

raw object

Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter includeRaw=true. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.

Hide raw attributes Show raw attributes object

_t string

Unique identifier of event type.

alertConfigId string

Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.

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

cid string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred.

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

cre string(date-time)

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

description string

Description of the event.

gn string

Human-readable label that identifies the project.

Minimum length is 1, maximum length is 64.

id string

Unique 24-hexadecimal digit string that identifies the event.

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

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

orgName string

Human-readable label that identifies the organization that contains the project.

Minimum length is 1, maximum length is 64.

severity string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.

remoteAddress string

IPv4 or IPv6 address from which the user triggered this event.

Format should match the following pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

userId string

Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the apiKeyId parameter.

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

username string(email)

Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the publicApiKey parameter.
NDS audit saving information about atlas cloud provider and other atlas related details.

Hide attributes Show attributes

apiKeyId string

Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the userId parameter.

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

Create Programmatic API Key

created string(date-time) Required

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

dbUserUsername string

The username of the MongoDB User that was created, deleted, or edited.

eventTypeName string Required

Unique identifier of event type.

Value is ORG_LIMIT_UPDATED.

groupId string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The eventId identifies the specific event.

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

id string Required

Unique 24-hexadecimal digit string that identifies the event.

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

isGlobalAdmin boolean

Flag that indicates whether a MongoDB employee triggered the specified event.

links array[object]

List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.

Web Linking Specification (RFC 5988)

Hide links attributes Show links attributes object

href string

Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

rel string

Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

publicKey string

Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the username parameter.

External documentation

raw object

Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter includeRaw=true. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.

Hide raw attributes Show raw attributes object

_t string

Unique identifier of event type.

alertConfigId string

Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.

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

cid string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred.

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

cre string(date-time)

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

description string

Description of the event.

gn string

Human-readable label that identifies the project.

Minimum length is 1, maximum length is 64.

id string

Unique 24-hexadecimal digit string that identifies the event.

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

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

orgName string

Human-readable label that identifies the organization that contains the project.

Minimum length is 1, maximum length is 64.

severity string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.

remoteAddress string

IPv4 or IPv6 address from which the user triggered this event.

Format should match the following pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

userId string

Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the apiKeyId parameter.

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

username string(email)

Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the publicApiKey parameter.

whitelistEntry string

Entry in the list of source host addresses that the API key accepts and this event targets.
Org event identifies different activities and changes in an organization settings.

Hide attributes Show attributes

apiKeyId string

Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the userId parameter.

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

Create Programmatic API Key

created string(date-time) Required

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

eventTypeName string Required

Unique identifier of event type.

Values are ORG_CREATED, CUSTOM_SESSION_TIMEOUT_MODIFIED, SECURITY_CONTACT_MODIFIED, ORG_CREDIT_CARD_ADDED, ORG_CREDIT_CARD_UPDATED, ORG_CREDIT_CARD_CURRENT, ORG_CREDIT_CARD_ABOUT_TO_EXPIRE, ORG_PAYPAL_LINKED, ORG_PAYPAL_UPDATED, ORG_PAYPAL_CANCELLED, ORG_OVERRIDE_PAYMENT_METHOD_ADDED, ORG_ACTIVATED, ORG_TEMPORARILY_ACTIVATED, ORG_SUSPENSION_DATE_CHANGED, ORG_SUSPENDED, ORG_ADMIN_SUSPENDED, ORG_ADMIN_LOCKED, ORG_CLUSTERS_DELETED, ORG_CLUSTERS_PAUSED, ORG_LOCKED, ORG_UNDER_FINANCIAL_PROTECTION, ORG_NO_FINANCIAL_PROTECTION, ORG_RENAMED, ALL_ORG_USERS_HAVE_MFA, ORG_USERS_WITHOUT_MFA, ORG_INVOICE_UNDER_THRESHOLD, ORG_INVOICE_OVER_THRESHOLD, ORG_DAILY_BILL_UNDER_THRESHOLD, ORG_DAILY_BILL_OVER_THRESHOLD, ORG_GROUP_CHARGES_UNDER_THRESHOLD, ORG_GROUP_CHARGES_OVER_THRESHOLD, ORG_TWO_FACTOR_AUTH_REQUIRED, ORG_TWO_FACTOR_AUTH_OPTIONAL, ORG_PUBLIC_API_ACCESS_LIST_REQUIRED, ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED, ORG_EMPLOYEE_ACCESS_RESTRICTED, ORG_EMPLOYEE_ACCESS_UNRESTRICTED, ORG_SFDC_ACCOUNT_ID_CHANGED, ORG_CONNECTED_TO_MLAB, ORG_DISCONNECTED_FROM_MLAB, ORG_IDP_CERTIFICATE_CURRENT, ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE, ORG_CONNECTED_TO_VERCEL, ORG_DISCONNECTED_TO_VERCEL, ORG_CONNECTION_UNINSTALLED_FROM_VERCEL, ORG_UI_IP_ACCESS_LIST_ENABLED, ORG_UI_IP_ACCESS_LIST_DISABLED, ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES, ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED, ORG_SERVICE_ACCOUNT_SECRETS_EXPIRED, ORG_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRED, ORG_SERVICE_ACCOUNT_SECRETS_EXPIRING, ORG_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRING, ORG_MONGODB_VERSION_EOL_EXTENSION_ACCEPTED, ORG_MONGODB_VERSION_EOL_EXTENSION_PENDING, ORG_MONGODB_VERSION_EOL_EXTENSION_CANCELLED, GROUP_MOVED_FROM_ORG, SANDBOX_ENABLED_FOR_ORG, or SANDBOX_DISABLED_FOR_ORG.

groupId string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The eventId identifies the specific event.

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

id string Required

Unique 24-hexadecimal digit string that identifies the event.

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

invoiceId string

Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.

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

isGlobalAdmin boolean

Flag that indicates whether a MongoDB employee triggered the specified event.

links array[object]

List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.

Web Linking Specification (RFC 5988)

Hide links attributes Show links attributes object

href string

Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

rel string

Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

publicKey string

Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the username parameter.

External documentation

raw object

Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter includeRaw=true. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.

Hide raw attributes Show raw attributes object

_t string

Unique identifier of event type.

alertConfigId string

Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.

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

cid string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred.

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

cre string(date-time)

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

description string

Description of the event.

gn string

Human-readable label that identifies the project.

Minimum length is 1, maximum length is 64.

id string

Unique 24-hexadecimal digit string that identifies the event.

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

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

orgName string

Human-readable label that identifies the organization that contains the project.

Minimum length is 1, maximum length is 64.

severity string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.

remoteAddress string

IPv4 or IPv6 address from which the user triggered this event.

Format should match the following pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

userId string

Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the apiKeyId parameter.

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

username string(email)

Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the publicApiKey parameter.
Team event identifies different activities around organization teams.

Hide attributes Show attributes

apiKeyId string

Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the userId parameter.

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

Create Programmatic API Key

created string(date-time) Required

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

eventTypeName string Required

Unique identifier of event type.

Values are TEAM_CREATED, TEAM_DELETED, TEAM_UPDATED, TEAM_NAME_CHANGED, TEAM_ADDED_TO_GROUP, TEAM_REMOVED_FROM_GROUP, or TEAM_ROLES_MODIFIED.

groupId string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The eventId identifies the specific event.

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

id string Required

Unique 24-hexadecimal digit string that identifies the event.

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

isGlobalAdmin boolean

Flag that indicates whether a MongoDB employee triggered the specified event.

links array[object]

List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.

Web Linking Specification (RFC 5988)

Hide links attributes Show links attributes object

href string

Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

rel string

Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

publicKey string

Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the username parameter.

External documentation

raw object

Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter includeRaw=true. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.

Hide raw attributes Show raw attributes object

_t string

Unique identifier of event type.

alertConfigId string

Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.

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

cid string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred.

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

cre string(date-time)

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

description string

Description of the event.

gn string

Human-readable label that identifies the project.

Minimum length is 1, maximum length is 64.

id string

Unique 24-hexadecimal digit string that identifies the event.

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

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

orgName string

Human-readable label that identifies the organization that contains the project.

Minimum length is 1, maximum length is 64.

severity string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.

remoteAddress string

IPv4 or IPv6 address from which the user triggered this event.

Format should match the following pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

teamId string

Unique 24-hexadecimal digit string that identifies the organization team associated with this event.

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

userId string

Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the apiKeyId parameter.

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

username string(email)

Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the publicApiKey parameter.
User event reflects different activities about the atlas user.

Hide attributes Show attributes

apiKeyId string

Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the userId parameter.

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

Create Programmatic API Key

created string(date-time) Required

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

eventTypeName string Required

Unique identifier of event type.

Values are JOINED_ORG, JOINED_TEAM, INVITED_TO_ORG, ORG_INVITATION_DELETED, REMOVED_FROM_ORG, REMOVED_FROM_TEAM, USER_ROLES_CHANGED_AUDIT, ORG_FLEX_CONSULTING_PURCHASED, ORG_FLEX_CONSULTING_PURCHASE_FAILED, or INVITED_TO_TEAM.

groupId string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The eventId identifies the specific event.

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

id string Required

Unique 24-hexadecimal digit string that identifies the event.

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

isGlobalAdmin boolean

Flag that indicates whether a MongoDB employee triggered the specified event.

links array[object]

List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.

Web Linking Specification (RFC 5988)

Hide links attributes Show links attributes object

href string

Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

rel string

Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

publicKey string

Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the username parameter.

External documentation

raw object

Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter includeRaw=true. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.

Hide raw attributes Show raw attributes object

_t string

Unique identifier of event type.

alertConfigId string

Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.

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

cid string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred.

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

cre string(date-time)

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

description string

Description of the event.

gn string

Human-readable label that identifies the project.

Minimum length is 1, maximum length is 64.

id string

Unique 24-hexadecimal digit string that identifies the event.

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

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

orgName string

Human-readable label that identifies the organization that contains the project.

Minimum length is 1, maximum length is 64.

severity string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.

remoteAddress string

IPv4 or IPv6 address from which the user triggered this event.

Format should match the following pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

targetUsername string(email)

Email address for the console user that this event targets. The resource returns this parameter when "eventTypeName" : "USER".

userId string

Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the apiKeyId parameter.

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

username string(email)

Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the publicApiKey parameter.
Resource event reflects different activities about resources.

Hide attributes Show attributes

apiKeyId string

Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the userId parameter.

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

Create Programmatic API Key

created string(date-time) Required

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

eventTypeName string Required

Unique identifier of event type.

Values are TAGS_MODIFIED or GROUP_TAGS_MODIFIED.

groupId string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The eventId identifies the specific event.

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

id string Required

Unique 24-hexadecimal digit string that identifies the event.

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

isGlobalAdmin boolean

Flag that indicates whether a MongoDB employee triggered the specified event.

links array[object]

List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.

Web Linking Specification (RFC 5988)

Hide links attributes Show links attributes object

href string

Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

rel string

Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

publicKey string

Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the username parameter.

External documentation

raw object

Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter includeRaw=true. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.

Hide raw attributes Show raw attributes object

_t string

Unique identifier of event type.

alertConfigId string

Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.

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

cid string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred.

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

cre string(date-time)

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

description string

Description of the event.

gn string

Human-readable label that identifies the project.

Minimum length is 1, maximum length is 64.

id string

Unique 24-hexadecimal digit string that identifies the event.

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

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

orgName string

Human-readable label that identifies the organization that contains the project.

Minimum length is 1, maximum length is 64.

severity string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.

remoteAddress string

IPv4 or IPv6 address from which the user triggered this event.

Format should match the following pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

resourceId string

Unique 24-hexadecimal digit string that identifies the resource associated with the event.

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

resourceType string Required

Unique identifier of resource type.

userId string

Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the apiKeyId parameter.

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

username string(email)

Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the publicApiKey parameter.
Atlas resource policy audits indicate org level changes to resource policies

Hide attributes Show attributes

apiKeyId string

Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the userId parameter.

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

Create Programmatic API Key

created string(date-time) Required

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

eventTypeName string Required

Unique identifier of event type.

Values are RESOURCE_POLICY_CREATED, RESOURCE_POLICY_MODIFIED, RESOURCE_POLICY_DELETED, or RESOURCE_POLICY_VIOLATED.

groupId string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The eventId identifies the specific event.

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

id string Required

Unique 24-hexadecimal digit string that identifies the event.

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

isGlobalAdmin boolean

Flag that indicates whether a MongoDB employee triggered the specified event.

links array[object]

List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.

Web Linking Specification (RFC 5988)

Hide links attributes Show links attributes object

href string

Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

rel string

Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

publicKey string

Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the username parameter.

External documentation

raw object

Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter includeRaw=true. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.

Hide raw attributes Show raw attributes object

_t string

Unique identifier of event type.

alertConfigId string

Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.

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

cid string

Unique 24-hexadecimal digit string that identifies the project in which the event occurred.

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

cre string(date-time)

Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

ISO 8601

description string

Description of the event.

gn string

Human-readable label that identifies the project.

Minimum length is 1, maximum length is 64.

id string

Unique 24-hexadecimal digit string that identifies the event.

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

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

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

orgName string

Human-readable label that identifies the organization that contains the project.

Minimum length is 1, maximum length is 64.

severity string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.

remoteAddress string

IPv4 or IPv6 address from which the user triggered this event.

Format should match the following pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

resourcePolicyId string

Unique 24-hexadecimal character string that identifies the resource policy.

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

userId string

Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the apiKeyId parameter.

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

username string(email)

Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the publicApiKey parameter.
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.

GET /api/atlas/v2/orgs/{orgId}/events/{eventId}

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v2/orgs/4888442a3354817a7320eb61/events/{eventId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "FEDERATION_SETTINGS_CREATED",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}

{
  "alertId": "32b6e34b3d91647abb20e7b8",
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "ALERT_ACKNOWLEDGED_AUDIT",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}

{
  "alertConfigId": "32b6e34b3d91647abb20e7b8",
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "ALERT_CONFIG_ADDED_AUDIT",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}

{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "API_KEY_CREATED",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "targetPublicKey": "zmmrboas",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com",
  "whitelistEntry": "0.0.0.0"
}

{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "SERVICE_ACCOUNT_CREATED",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}

{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "CHARGE_SUCCEEDED",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "invoiceId": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "paymentId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}

{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "dbUserUsername": "user1",
  "eventTypeName": "ORG_LIMIT_UPDATED",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com",
  "whitelistEntry": "0.0.0.0"
}

{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "ORG_CREATED",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "invoiceId": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}

{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "TEAM_ADDED_TO_GROUP",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "teamId": "32b6e34b3d91647abb20e7b8",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}

{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "JOINED_ORG",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "targetUsername": "test.user@mongodb.com",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}

{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "GROUP_TAGS_MODIFIED",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "resourceId": "32b6e34b3d91647abb20e7b8",
  "resourceType": "cluster",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}

{
  "apiKeyId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "RESOURCE_POLICY_CREATED",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "isGlobalAdmin": true,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "publicKey": "string",
  "raw": {
    "_t": "ALERT_AUDIT",
    "alertConfigId": "32b6e34b3d91647abb20e7b8",
    "cid": "32b6e34b3d91647abb20e7b8",
    "cre": "2025-05-04T09:42:00Z",
    "description": "Alert Acknowledged",
    "gn": "Test Project",
    "id": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8",
    "orgName": "Test Organization",
    "severity": "INFO"
  },
  "remoteAddress": "216.172.40.186",
  "resourcePolicyId": "32b6e34b3d91647abb20e7b8",
  "userId": "32b6e34b3d91647abb20e7b8",
  "username": "hello@example.com"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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

Return All Organization Configurations from One Federation

GET /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs

Service accounts Digest auth

Returns all connected org configs in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected orgs.

Path parameters

federationSettingsId string Required

Unique 24-hexadecimal digit string that identifies your federation.

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

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.
itemsPerPage integer

Number of items that the response returns per page.

Minimum value is 1, maximum value is 500. Default value is 100.
pageNum integer

Number of the page that displays the current set of the total objects that the response returns.

Minimum value is 1. Default value is 1.

Responses

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

OK
Hide response attributes Show response attributes object
- links array[object]
  
  List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
  
  Web Linking Specification (RFC 5988)
  
  Hide links attributes Show links attributes object
  
  href string
  
  Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
  
  rel string
  
  Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
- results array[object]
  
  List of returned documents that MongoDB Cloud provides when completing this request.
  
  Hide results attributes Show results attributes object
  
  dataAccessIdentityProviderIds array[string]
  
  The collection of unique ids representing the identity providers that can be used for data access in this organization.
  
  domainAllowList array[string]
  
  Approved domains that restrict users who can join the organization based on their email address.
  
  domainRestrictionEnabled boolean Required
  
  Value that indicates whether domain restriction is enabled for this connected org.
  
  identityProviderId string
  
  Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.
  
  Format should match the following pattern: ^([a-f0-9]{20})$.
  
  orgId string Required
  
  Unique 24-hexadecimal digit string that identifies the connected organization configuration.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  postAuthRoleGrants array[string]
  
  Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.
  
  Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
  
  roleMappings array[object]
  
  Role mappings that are configured in this organization.
  
  Mapping settings that link one IdP and MongoDB Cloud.
  
  Hide roleMappings attributes Show roleMappings attributes object
  
  externalGroupName string Required
  
  Unique human-readable label that identifies the identity provider group to which this role mapping applies.
  
  Minimum length is 1, maximum length is 200.
  
  id string
  
  Unique 24-hexadecimal digit string that identifies this role mapping.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  roleAssignments array[object]
  
  Atlas roles and the unique identifiers of the groups and organizations associated with each role. The array must include at least one element with an Organization role and its respective orgId. Each element in the array can have a value for orgId or groupId, but not both.
  
  Hide roleAssignments attributes Show roleAssignments attributes object
  
  groupId string
  
  Unique 24-hexadecimal digit string that identifies the project to which this role belongs. Each element within roleAssignments can have a value for groupId or orgId, but not both.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  orgId string
  
  Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within roleAssignments can have a value for orgId or groupId, but not both.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  role string
  
  Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.
  
  Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_READ_ONLY, GROUP_BACKUP_MANAGER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATABASE_ACCESS_ADMIN, GROUP_OBSERVABILITY_VIEWER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, or GROUP_STREAM_PROCESSING_OWNER.
  
  userConflicts array[object]
  
  List that contains the users who have an email address that doesn't match any domain on the allowed list.
  
  MongoDB Cloud user linked to this federated authentication.
  
  Hide userConflicts attributes Show userConflicts attributes object
  
  emailAddress string(email) Required
  
  Email address of the MongoDB Cloud user linked to the federated organization.
  
  federationSettingsId string Required
  
  Unique 24-hexadecimal digit string that identifies the federation to which this MongoDB Cloud user belongs.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  firstName string Required
  
  First or given name that belongs to the MongoDB Cloud user.
  
  lastName string Required
  
  Last name, family name, or surname that belongs to the MongoDB Cloud user.
  
  userId string
  
  Unique 24-hexadecimal digit string that identifies this user.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- totalCount integer(int32)
  
  Total number of documents available. MongoDB Cloud omits this value if includeCount is set to false. The total number is an estimate and may not be exact.
  
  Minimum value is 0.
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.
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.

GET /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v2/federationSettings/55fa922fb343282757d9554e/connectedOrgConfigs' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "dataAccessIdentityProviderIds": [
        "string"
      ],
      "domainAllowList": [
        "string"
      ],
      "domainRestrictionEnabled": true,
      "identityProviderId": "string",
      "orgId": "32b6e34b3d91647abb20e7b8",
      "postAuthRoleGrants": [
        "ORG_OWNER"
      ],
      "roleMappings": [
        {
          "externalGroupName": "string",
          "id": "32b6e34b3d91647abb20e7b8",
          "roleAssignments": [
            {
              "groupId": "32b6e34b3d91647abb20e7b8",
              "orgId": "32b6e34b3d91647abb20e7b8",
              "role": "ORG_OWNER"
            }
          ]
        }
      ],
      "userConflicts": [
        {
          "emailAddress": "hello@example.com",
          "federationSettingsId": "32b6e34b3d91647abb20e7b8",
          "firstName": "string",
          "lastName": "string",
          "userId": "32b6e34b3d91647abb20e7b8"
        }
      ]
    }
  ],
  "totalCount": 42
}

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 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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

Return One Flex Cluster from One Project

GET /api/atlas/v2/groups/{groupId}/flexClusters/{name}

Service accounts Digest auth

Returns details for one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.

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})$.
name string Required

Human-readable label that identifies the flex cluster.

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

200 application/vnd.atlas.2024-11-13+json

OK
Hide response attributes Show response attributes object
- backupSettings object
  
  Flex backup configuration.
  
  Hide backupSettings attribute Show backupSettings attribute object
  
  enabled boolean
  
  Flag that indicates whether backups are performed for this flex cluster. Backup uses flex cluster backups.
  
  Default value is true.
  
  Flex Cluster Backups
- clusterType string
  
  Flex cluster topology.
  
  Value is REPLICASET. Default value is REPLICASET.
- connectionStrings object
  
  Collection of Uniform Resource Locators that point to the MongoDB database.
  
  Connection string URI format
  
  Hide connectionStrings attributes Show connectionStrings attributes object
  
  standard string
  
  Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.
  
  Connection String URI Format
  
  standardSrv string
  
  Public connection string that you can use to connect to this flex cluster. This connection string uses the mongodb+srv:// protocol.
  
  Connection String URI Format
- createDate string(date-time)
  
  Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.
- groupId string
  
  Unique 24-hexadecimal character string that identifies the project.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- id string
  
  Unique 24-hexadecimal digit string that identifies the instance.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- links array[object]
  
  List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
  
  Web Linking Specification (RFC 5988)
  
  Hide links attributes Show links attributes object
  
  href string
  
  Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
  
  rel string
  
  Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
- mongoDBVersion string
  
  Version of MongoDB that the instance runs.
  
  Format should match the following pattern: ([\d]+\.[\d]+\.[\d]+).
- name string
  
  Human-readable label that identifies the instance.
  
  Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
- providerSettings object Required
  
  Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
  
  Hide providerSettings attributes Show providerSettings attributes object
  
  backingProviderName string
  
  Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
  
  Values are AWS, AZURE, or GCP.
  
  diskSizeGB number(double)
  
  Storage capacity available to the flex cluster expressed in gigabytes.
  
  providerName string
  
  Human-readable label that identifies the provider type.
  
  Value is FLEX. Default value is FLEX.
  
  regionName string
  
  Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see AWS, GCP, and Azure.
- stateName string
  
  Human-readable label that indicates any current activity being taken on this cluster by the Atlas control plane. With the exception of CREATING and DELETING states, clusters should always be available and have a Primary node even when in states indicating ongoing activity.
  
  IDLE: Atlas is making no changes to this cluster and all changes requested via the UI or API can be assumed to have been applied.
  
  CREATING: A cluster being provisioned for the very first time returns state CREATING until it is ready for connections. Ensure IP Access List and DB Users are configured before attempting to connect.
  
  UPDATING: A change requested via the UI, API, AutoScaling, or other scheduled activity is taking place.
  
  DELETING: The cluster is in the process of deletion and will soon be deleted.
  
  REPAIRING: One or more nodes in the cluster are being returned to service by the Atlas control plane. Other nodes should continue to provide service as normal.
  
  Values are IDLE, CREATING, UPDATING, DELETING, or REPAIRING.
- tags array[object]
  
  List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.
  
  Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, environment : production.
  
  Resource Tags
  
  Hide tags attributes Show tags attributes object
  
  key string Required
  
  Constant that defines the set of the tag. For example, environment in the environment : production tag.
  
  Minimum length is 1, maximum length is 255.
  
  value string Required
  
  Variable that belongs to the set of the tag. For example, production in the environment : production tag.
  
  Minimum length is 1, maximum length is 255.
- terminationProtectionEnabled boolean
  
  Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
  
  Default value is false.
- versionReleaseSystem string
  
  Method by which the cluster maintains the MongoDB versions.
  
  Value is LTS. Default value is LTS.
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.

GET /api/atlas/v2/groups/{groupId}/flexClusters/{name}

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v2/groups/32b6e34b3d91647abb20e7b8/flexClusters/{name}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "backupSettings": {
    "enabled": true
  },
  "clusterType": "REPLICASET",
  "connectionStrings": {
    "standard": "string",
    "standardSrv": "string"
  },
  "createDate": "2025-05-04T09:42:00Z",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "mongoDBVersion": "string",
  "name": "string",
  "providerSettings": {
    "backingProviderName": "AWS",
    "diskSizeGB": 42.0,
    "providerName": "FLEX",
    "regionName": "string"
  },
  "stateName": "IDLE",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "terminationProtectionEnabled": false,
  "versionReleaseSystem": "LTS"
}

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 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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 (409)

{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}

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

Download One Flex Cluster Snapshot

POST /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/download

Service accounts Digest auth

Requests one snapshot for the specified flex cluster. This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role.

Path parameters

name string Required

Human-readable label that identifies the flex cluster.

Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
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})$.

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/vnd.atlas.2024-11-13+json

Body Required

Snapshot to be downloaded.

snapshotId string Required

Unique 24-hexadecimal digit string that identifies the snapshot to download.

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

Responses

200 application/vnd.atlas.2024-11-13+json

OK
Hide response attributes Show response attributes object
- deliveryType string
  
  Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.
  
  Values are RESTORE or DOWNLOAD.
- expirationDate string(date-time)
  
  Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- id string
  
  Unique 24-hexadecimal digit string that identifies the restore job.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- instanceName string
  
  Human-readable label that identifies the source instance.
  
  Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
- links array[object]
  
  List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
  
  Web Linking Specification (RFC 5988)
  
  Hide links attributes Show links attributes object
  
  href string
  
  Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
  
  rel string
  
  Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
- projectId string
  
  Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- restoreFinishedDate string(date-time)
  
  Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to CLOSED. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- restoreScheduledDate string(date-time)
  
  Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- snapshotFinishedDate string(date-time)
  
  Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- snapshotId string
  
  Unique 24-hexadecimal digit string that identifies the snapshot to restore.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- snapshotUrl string
  
  Internet address from which you can download the compressed snapshot files. The resource returns this parameter when "deliveryType" : "DOWNLOAD".
- status string
  
  Phase of the restore workflow for this job at the time this resource made this request.
  
  Values are PENDING, QUEUED, RUNNING, FAILED, or COMPLETED.
- targetDeploymentItemName string
  
  Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another flex or dedicated cluster tier.
  
  Format should match the following pattern: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$.
- targetProjectId string
  
  Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
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.

POST /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/download

curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v2/groups/32b6e34b3d91647abb20e7b8/flexClusters/{name}/backup/download' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/vnd.atlas.2024-11-13+json"

Request examples

{
  "snapshotId": "32b6e34b3d91647abb20e7b8"
}

Response examples (200)

{
  "deliveryType": "RESTORE",
  "expirationDate": "2025-05-04T09:42:00Z",
  "id": "32b6e34b3d91647abb20e7b8",
  "instanceName": "string",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "projectId": "32b6e34b3d91647abb20e7b8",
  "restoreFinishedDate": "2025-05-04T09:42:00Z",
  "restoreScheduledDate": "2025-05-04T09:42:00Z",
  "snapshotFinishedDate": "2025-05-04T09:42:00Z",
  "snapshotId": "32b6e34b3d91647abb20e7b8",
  "snapshotUrl": "string",
  "status": "PENDING",
  "targetDeploymentItemName": "string",
  "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

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 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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 (409)

{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}

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

Return results from a given Cost Explorer query, or notify that the results are not ready yet.

GET /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}

Service accounts Digest auth

Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data.

Path parameters

orgId string Required

Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.

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

Unique 64 digit string that identifies the Cost Explorer query.

Minimum length is 64, maximum length is 64.

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.

Responses

200

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

application/vnd.atlas.2023-01-01+json application/vnd.atlas.2023-01-01+csv

OK
102

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

GET /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v2/orgs/4888442a3354817a7320eb61/billing/costExplorer/usage/4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{}

Response examples (200)

Billed Date,666acb8787ba90706905dcae,
Invoice Id,"June 1, 2024 - July 1, 2024",
Organization Name,Test 2,
Organization ID,666acb8787ba90706905dcae,
Project Name,666acb8787ba90706905dcae,
Project Id,666acb8787ba90706905dcae,
Cluster Name,TestCluster
Cluster Unique Id,666acb8787ba90706905dcae
Usage Amount, 1018.39

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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

Add One Project Role to One MongoDB Cloud User

POST /api/atlas/v2/groups/{groupId}/users/{userId}:addRole

Service accounts Digest auth

Adds one project-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has been invited to join the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role.

Note: This resource cannot be used to add a role to users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint.

Deprecated: Invite One MongoDB Cloud User to Join One Project

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})$.
userId string Required

Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username.

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

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/vnd.atlas.2025-02-19+json

Body Required

Project-level role to assign to the MongoDB Cloud user.

groupRole string Required

Project-level role.

Values are GROUP_OWNER, GROUP_CLUSTER_MANAGER, GROUP_STREAM_PROCESSING_OWNER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATA_ACCESS_READ_ONLY, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, GROUP_BACKUP_MANAGER, GROUP_OBSERVABILITY_VIEWER, or GROUP_DATABASE_ACCESS_ADMIN.

Responses

200 application/vnd.atlas.2025-02-19+json

OK
One of:
PENDING object ACTIVE object
Hide attributes Show attributes

id string Required

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.

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

orgMembershipStatus string Required Discriminator

String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.

Value is PENDING.

roles object Required

Organization- and project-level roles assigned to one MongoDB Cloud user within one organization.

Hide roles attributes Show roles attributes object

groupRoleAssignments array[object]

List of project-level role assignments assigned to the MongoDB Cloud user.

Hide groupRoleAssignments attributes Show groupRoleAssignments attributes object

groupId string

Unique 24-hexadecimal digit string that identifies the project to which these roles belong.

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

groupRoles array[string]

One or more project-level roles assigned to the MongoDB Cloud user.

Values are GROUP_OWNER, GROUP_CLUSTER_MANAGER, GROUP_STREAM_PROCESSING_OWNER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATA_ACCESS_READ_ONLY, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, GROUP_BACKUP_MANAGER, GROUP_OBSERVABILITY_VIEWER, or GROUP_DATABASE_ACCESS_ADMIN.

orgRoles array[string]

One or more organization-level roles assigned to the MongoDB Cloud user.

Values are ORG_OWNER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_READ_ONLY, or ORG_MEMBER.

teamIds array[string]

List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.

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

username string(email) Required

Email address that represents the username of the MongoDB Cloud user.

invitationCreatedAt string(date-time) Required

Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.

invitationExpiresAt string(date-time) Required

Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.

inviterUsername string(email) Required

Username of the MongoDB Cloud user who sent the invitation to join the organization.
Hide attributes Show attributes

id string Required

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.

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

orgMembershipStatus string Required Discriminator

String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.

Value is ACTIVE.

roles object Required

Organization- and project-level roles assigned to one MongoDB Cloud user within one organization.

Hide roles attributes Show roles attributes object

groupRoleAssignments array[object]

List of project-level role assignments assigned to the MongoDB Cloud user.

Hide groupRoleAssignments attributes Show groupRoleAssignments attributes object

groupId string

Unique 24-hexadecimal digit string that identifies the project to which these roles belong.

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

groupRoles array[string]

One or more project-level roles assigned to the MongoDB Cloud user.

Values are GROUP_OWNER, GROUP_CLUSTER_MANAGER, GROUP_STREAM_PROCESSING_OWNER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATA_ACCESS_READ_ONLY, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, GROUP_BACKUP_MANAGER, GROUP_OBSERVABILITY_VIEWER, or GROUP_DATABASE_ACCESS_ADMIN.

orgRoles array[string]

One or more organization-level roles assigned to the MongoDB Cloud user.

Values are ORG_OWNER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_READ_ONLY, or ORG_MEMBER.

teamIds array[string]

List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.

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

username string(email) Required

Email address that represents the username of the MongoDB Cloud user.

country string

Two-character alphabetical string that identifies the MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.

Format should match the following pattern: ^([A-Z]{2})$.

createdAt string(date-time) Required

Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.

firstName string Required

First or given name that belongs to the MongoDB Cloud user.

lastAuth string(date-time)

Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.

lastName string Required

Last name, family name, or surname that belongs to the MongoDB Cloud user.

mobileNumber string

Mobile phone number that belongs to the MongoDB Cloud user.

Format should match the following pattern: (?:(?:\\+?1\\s*(?:[.-]\\s*)?)?(?:(\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\s*(?:[.-]\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\s*(?:[.-]\\s*)?([0-9]{4})$.
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.

POST /api/atlas/v2/groups/{groupId}/users/{userId}:addRole

curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v2/groups/32b6e34b3d91647abb20e7b8/users/{userId}:addRole' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/vnd.atlas.2025-02-19+json"

Request examples

{
  "groupRole": "GROUP_OWNER"
}

Response examples (200)

{
  "id": "32b6e34b3d91647abb20e7b8",
  "orgMembershipStatus": "PENDING",
  "roles": {
    "groupRoleAssignments": [
      {
        "groupId": "32b6e34b3d91647abb20e7b8",
        "groupRoles": [
          "GROUP_OWNER"
        ]
      }
    ],
    "orgRoles": [
      "ORG_OWNER"
    ]
  },
  "teamIds": [
    "32b6e34b3d91647abb20e7b8"
  ],
  "username": "hello@example.com",
  "invitationCreatedAt": "2025-05-04T09:42:00Z",
  "invitationExpiresAt": "2025-05-04T09:42:00Z",
  "inviterUsername": "hello@example.com"
}

{
  "id": "32b6e34b3d91647abb20e7b8",
  "orgMembershipStatus": "ACTIVE",
  "roles": {
    "groupRoleAssignments": [
      {
        "groupId": "32b6e34b3d91647abb20e7b8",
        "groupRoles": [
          "GROUP_OWNER"
        ]
      }
    ],
    "orgRoles": [
      "ORG_OWNER"
    ]
  },
  "teamIds": [
    "32b6e34b3d91647abb20e7b8"
  ],
  "username": "hello@example.com",
  "country": "US",
  "createdAt": "2025-05-04T09:42:00Z",
  "firstName": "John",
  "lastAuth": "2025-05-04T09:42:00Z",
  "lastName": "Doe",
  "mobileNumber": "string"
}

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 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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 (409)

{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}

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

Add One MongoDB Cloud User to One Project

POST /api/atlas/v2/groups/{groupId}/users

Service accounts Digest auth

Adds one MongoDB Cloud user to one project. To use this resource, the requesting Service Account or API Key must have the Project Owner role.

If the user has a pending invitation to join the project's organization, MongoDB Cloud modifies it and grants project access.
If the user doesn't have an invitation to join the organization, MongoDB Cloud sends a new invitation that grants the user organization and project access.
If the user is already active in the project's organization, MongoDB Cloud grants access to the project.

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})$.

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/vnd.atlas.2025-02-19+json

Body Required

The active or pending MongoDB Cloud user that you want to add to the specified project.

roles array[string] Required

One or more project-level roles to assign the MongoDB Cloud user.

At least 1 element. Values are GROUP_OWNER, GROUP_CLUSTER_MANAGER, GROUP_STREAM_PROCESSING_OWNER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATA_ACCESS_READ_ONLY, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, GROUP_BACKUP_MANAGER, GROUP_OBSERVABILITY_VIEWER, or GROUP_DATABASE_ACCESS_ADMIN.
username string(email) Required

Email address that represents the username of the MongoDB Cloud user.

Responses

201 application/vnd.atlas.2025-02-19+json

Created
One of:
PENDING object ACTIVE object
Hide attributes Show attributes

id string Required

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.

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

orgMembershipStatus string Required Discriminator

String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.

Value is PENDING.

roles array[string] Required

One or more project-level roles assigned to the MongoDB Cloud user.

Values are GROUP_OWNER, GROUP_CLUSTER_MANAGER, GROUP_STREAM_PROCESSING_OWNER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATA_ACCESS_READ_ONLY, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, GROUP_BACKUP_MANAGER, GROUP_OBSERVABILITY_VIEWER, or GROUP_DATABASE_ACCESS_ADMIN.

username string(email) Required

Email address that represents the username of the MongoDB Cloud user.

invitationCreatedAt string(date-time) Required

Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.

invitationExpiresAt string(date-time) Required

Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.

inviterUsername string(email) Required

Username of the MongoDB Cloud user who sent the invitation to join the organization.
Hide attributes Show attributes

id string Required

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.

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

orgMembershipStatus string Required Discriminator

String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.

Value is ACTIVE.

roles array[string] Required

One or more project-level roles assigned to the MongoDB Cloud user.

Values are GROUP_OWNER, GROUP_CLUSTER_MANAGER, GROUP_STREAM_PROCESSING_OWNER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATA_ACCESS_READ_ONLY, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, GROUP_BACKUP_MANAGER, GROUP_OBSERVABILITY_VIEWER, or GROUP_DATABASE_ACCESS_ADMIN.

username string(email) Required

Email address that represents the username of the MongoDB Cloud user.

country string

Two-character alphabetical string that identifies the MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.

Format should match the following pattern: ^([A-Z]{2})$.

createdAt string(date-time) Required

Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.

firstName string Required

First or given name that belongs to the MongoDB Cloud user.

lastAuth string(date-time)

Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.

lastName string Required

Last name, family name, or surname that belongs to the MongoDB Cloud user.

mobileNumber string

Mobile phone number that belongs to the MongoDB Cloud user.

Format should match the following pattern: (?:(?:\\+?1\\s*(?:[.-]\\s*)?)?(?:(\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\s*(?:[.-]\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\s*(?:[.-]\\s*)?([0-9]{4})$.
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.

POST /api/atlas/v2/groups/{groupId}/users

curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v2/groups/32b6e34b3d91647abb20e7b8/users' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/vnd.atlas.2025-02-19+json"

Request examples

{
  "roles": [
    "GROUP_OWNER"
  ],
  "username": "hello@example.com"
}

Response examples (201)

{
  "id": "32b6e34b3d91647abb20e7b8",
  "orgMembershipStatus": "PENDING",
  "roles": [
    "GROUP_OWNER"
  ],
  "username": "hello@example.com",
  "invitationCreatedAt": "2025-05-04T09:42:00Z",
  "invitationExpiresAt": "2025-05-04T09:42:00Z",
  "inviterUsername": "hello@example.com"
}

{
  "id": "32b6e34b3d91647abb20e7b8",
  "orgMembershipStatus": "ACTIVE",
  "roles": [
    "GROUP_OWNER"
  ],
  "username": "hello@example.com",
  "country": "US",
  "createdAt": "2025-05-04T09:42:00Z",
  "firstName": "John",
  "lastAuth": "2025-05-04T09:42:00Z",
  "lastName": "Doe",
  "mobileNumber": "string"
}

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 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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 (409)

{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}

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

Return One MongoDB Cloud User in One Project

GET /api/atlas/v2/groups/{groupId}/users/{userId}

Service accounts Digest auth

Returns information about the specified MongoDB Cloud user within the context of the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.

Note: You can only use this resource to fetch information about MongoDB Cloud human users. To return information about an API Key, use the Return One Organization API Key endpoint.

Note: This resource does not return information about pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint.

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})$.
userId string Required

Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username.

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

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.2025-02-19+json

OK
One of:
PENDING object ACTIVE object
Hide attributes Show attributes

id string Required

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.

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

orgMembershipStatus string Required Discriminator

String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.

Value is PENDING.

roles array[string] Required

One or more project-level roles assigned to the MongoDB Cloud user.

Values are GROUP_OWNER, GROUP_CLUSTER_MANAGER, GROUP_STREAM_PROCESSING_OWNER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATA_ACCESS_READ_ONLY, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, GROUP_BACKUP_MANAGER, GROUP_OBSERVABILITY_VIEWER, or GROUP_DATABASE_ACCESS_ADMIN.

username string(email) Required

Email address that represents the username of the MongoDB Cloud user.

invitationCreatedAt string(date-time) Required

Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.

invitationExpiresAt string(date-time) Required

Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.

inviterUsername string(email) Required

Username of the MongoDB Cloud user who sent the invitation to join the organization.
Hide attributes Show attributes

id string Required

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.

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

orgMembershipStatus string Required Discriminator

String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.

Value is ACTIVE.

roles array[string] Required

One or more project-level roles assigned to the MongoDB Cloud user.

Values are GROUP_OWNER, GROUP_CLUSTER_MANAGER, GROUP_STREAM_PROCESSING_OWNER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATA_ACCESS_READ_ONLY, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, GROUP_BACKUP_MANAGER, GROUP_OBSERVABILITY_VIEWER, or GROUP_DATABASE_ACCESS_ADMIN.

username string(email) Required

Email address that represents the username of the MongoDB Cloud user.

country string

Two-character alphabetical string that identifies the MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.

Format should match the following pattern: ^([A-Z]{2})$.

createdAt string(date-time) Required

Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.

firstName string Required

First or given name that belongs to the MongoDB Cloud user.

lastAuth string(date-time)

Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.

lastName string Required

Last name, family name, or surname that belongs to the MongoDB Cloud user.

mobileNumber string

Mobile phone number that belongs to the MongoDB Cloud user.

Format should match the following pattern: (?:(?:\\+?1\\s*(?:[.-]\\s*)?)?(?:(\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\s*(?:[.-]\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\s*(?:[.-]\\s*)?([0-9]{4})$.
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.
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.

GET /api/atlas/v2/groups/{groupId}/users/{userId}

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v2/groups/32b6e34b3d91647abb20e7b8/users/{userId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "id": "32b6e34b3d91647abb20e7b8",
  "orgMembershipStatus": "PENDING",
  "roles": [
    "GROUP_OWNER"
  ],
  "username": "hello@example.com",
  "invitationCreatedAt": "2025-05-04T09:42:00Z",
  "invitationExpiresAt": "2025-05-04T09:42:00Z",
  "inviterUsername": "hello@example.com"
}

{
  "id": "32b6e34b3d91647abb20e7b8",
  "orgMembershipStatus": "ACTIVE",
  "roles": [
    "GROUP_OWNER"
  ],
  "username": "hello@example.com",
  "country": "US",
  "createdAt": "2025-05-04T09:42:00Z",
  "firstName": "John",
  "lastAuth": "2025-05-04T09:42:00Z",
  "lastName": "Doe",
  "mobileNumber": "string"
}

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 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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

Add One MongoDB Cloud User to One Team

POST /api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser

Service accounts Digest auth

Adds one MongoDB Cloud user to one team. You can add an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role.

Note: This resource cannot be used to add a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint.

Deprecated: Invite One MongoDB Cloud User to Join One Project endpoint

Path parameters

orgId string Required

Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.

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

Unique 24-hexadecimal digit string that identifies the team to add the MongoDB Cloud user to.

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

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/vnd.atlas.2025-02-19+json

Body Required

The active or pending MongoDB Cloud user that you want to add to the specified team.

id string Required

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.

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

Responses

200 application/vnd.atlas.2025-02-19+json

OK
One of:
PENDING object ACTIVE object
Hide attributes Show attributes

id string Required

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.

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

orgMembershipStatus string Required Discriminator

String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.

Value is PENDING.

roles object Required

Organization- and project-level roles assigned to one MongoDB Cloud user within one organization.

Hide roles attributes Show roles attributes object

groupRoleAssignments array[object]

List of project-level role assignments assigned to the MongoDB Cloud user.

Hide groupRoleAssignments attributes Show groupRoleAssignments attributes object

groupId string

Unique 24-hexadecimal digit string that identifies the project to which these roles belong.

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

groupRoles array[string]

One or more project-level roles assigned to the MongoDB Cloud user.

Values are GROUP_OWNER, GROUP_CLUSTER_MANAGER, GROUP_STREAM_PROCESSING_OWNER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATA_ACCESS_READ_ONLY, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, GROUP_BACKUP_MANAGER, GROUP_OBSERVABILITY_VIEWER, or GROUP_DATABASE_ACCESS_ADMIN.

orgRoles array[string]

One or more organization-level roles assigned to the MongoDB Cloud user.

Values are ORG_OWNER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_READ_ONLY, or ORG_MEMBER.

teamIds array[string]

List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.

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

username string(email) Required

Email address that represents the username of the MongoDB Cloud user.

invitationCreatedAt string(date-time) Required

Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.

invitationExpiresAt string(date-time) Required

Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.

inviterUsername string(email) Required

Username of the MongoDB Cloud user who sent the invitation to join the organization.
Hide attributes Show attributes

id string Required

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.

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

orgMembershipStatus string Required Discriminator

String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.

Value is ACTIVE.

roles object Required

Organization- and project-level roles assigned to one MongoDB Cloud user within one organization.

Hide roles attributes Show roles attributes object

groupRoleAssignments array[object]

List of project-level role assignments assigned to the MongoDB Cloud user.

Hide groupRoleAssignments attributes Show groupRoleAssignments attributes object

groupId string

Unique 24-hexadecimal digit string that identifies the project to which these roles belong.

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

groupRoles array[string]

One or more project-level roles assigned to the MongoDB Cloud user.

Values are GROUP_OWNER, GROUP_CLUSTER_MANAGER, GROUP_STREAM_PROCESSING_OWNER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATA_ACCESS_READ_ONLY, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, GROUP_BACKUP_MANAGER, GROUP_OBSERVABILITY_VIEWER, or GROUP_DATABASE_ACCESS_ADMIN.

orgRoles array[string]

One or more organization-level roles assigned to the MongoDB Cloud user.

Values are ORG_OWNER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_READ_ONLY, or ORG_MEMBER.

teamIds array[string]

List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.

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

username string(email) Required

Email address that represents the username of the MongoDB Cloud user.

country string

Two-character alphabetical string that identifies the MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.

Format should match the following pattern: ^([A-Z]{2})$.

createdAt string(date-time) Required

Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.

firstName string Required

First or given name that belongs to the MongoDB Cloud user.

lastAuth string(date-time)

Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.

lastName string Required

Last name, family name, or surname that belongs to the MongoDB Cloud user.

mobileNumber string

Mobile phone number that belongs to the MongoDB Cloud user.

Format should match the following pattern: (?:(?:\\+?1\\s*(?:[.-]\\s*)?)?(?:(\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\s*(?:[.-]\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\s*(?:[.-]\\s*)?([0-9]{4})$.
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.
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.

POST /api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser

curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v2/orgs/4888442a3354817a7320eb61/teams/{teamId}:addUser' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/vnd.atlas.2025-02-19+json"

Request examples

{
  "id": "32b6e34b3d91647abb20e7b8"
}

Response examples (200)

{
  "id": "32b6e34b3d91647abb20e7b8",
  "orgMembershipStatus": "PENDING",
  "roles": {
    "groupRoleAssignments": [
      {
        "groupId": "32b6e34b3d91647abb20e7b8",
        "groupRoles": [
          "GROUP_OWNER"
        ]
      }
    ],
    "orgRoles": [
      "ORG_OWNER"
    ]
  },
  "teamIds": [
    "32b6e34b3d91647abb20e7b8"
  ],
  "username": "hello@example.com",
  "invitationCreatedAt": "2025-05-04T09:42:00Z",
  "invitationExpiresAt": "2025-05-04T09:42:00Z",
  "inviterUsername": "hello@example.com"
}

{
  "id": "32b6e34b3d91647abb20e7b8",
  "orgMembershipStatus": "ACTIVE",
  "roles": {
    "groupRoleAssignments": [
      {
        "groupId": "32b6e34b3d91647abb20e7b8",
        "groupRoles": [
          "GROUP_OWNER"
        ]
      }
    ],
    "orgRoles": [
      "ORG_OWNER"
    ]
  },
  "teamIds": [
    "32b6e34b3d91647abb20e7b8"
  ],
  "username": "hello@example.com",
  "country": "US",
  "createdAt": "2025-05-04T09:42:00Z",
  "firstName": "John",
  "lastAuth": "2025-05-04T09:42:00Z",
  "lastName": "Doe",
  "mobileNumber": "string"
}

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 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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

Add One Organization Role to One MongoDB Cloud User

POST /api/atlas/v2/orgs/{orgId}/users/{userId}:addRole

Service accounts Digest auth

Adds one organization-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role.

Note: This operation is atomic.

Note: This resource cannot be used to add a role to users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint.

Deprecated: Invite One MongoDB Cloud User to Join One Project

Path parameters

orgId string Required

Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.

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

Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.

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

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/vnd.atlas.2025-02-19+json

Body Required

Organization-level role to assign to the MongoDB Cloud user.

orgRole string Required

Organization-level role.

Values are ORG_OWNER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_READ_ONLY, or ORG_MEMBER.

Responses

200 application/vnd.atlas.2025-02-19+json

OK
One of:
PENDING object ACTIVE object
Hide attributes Show attributes

id string Required

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.

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

orgMembershipStatus string Required Discriminator

String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.

Value is PENDING.

roles object Required

Organization- and project-level roles assigned to one MongoDB Cloud user within one organization.

Hide roles attributes Show roles attributes object

groupRoleAssignments array[object]

List of project-level role assignments assigned to the MongoDB Cloud user.

Hide groupRoleAssignments attributes Show groupRoleAssignments attributes object

groupId string

Unique 24-hexadecimal digit string that identifies the project to which these roles belong.

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

groupRoles array[string]

One or more project-level roles assigned to the MongoDB Cloud user.

Values are GROUP_OWNER, GROUP_CLUSTER_MANAGER, GROUP_STREAM_PROCESSING_OWNER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATA_ACCESS_READ_ONLY, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, GROUP_BACKUP_MANAGER, GROUP_OBSERVABILITY_VIEWER, or GROUP_DATABASE_ACCESS_ADMIN.

orgRoles array[string]

One or more organization-level roles assigned to the MongoDB Cloud user.

Values are ORG_OWNER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_READ_ONLY, or ORG_MEMBER.

teamIds array[string]

List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.

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

username string(email) Required

Email address that represents the username of the MongoDB Cloud user.

invitationCreatedAt string(date-time) Required

Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.

invitationExpiresAt string(date-time) Required

Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.

inviterUsername string(email) Required

Username of the MongoDB Cloud user who sent the invitation to join the organization.
Hide attributes Show attributes

id string Required

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.

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

orgMembershipStatus string Required Discriminator

String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.

Value is ACTIVE.

roles object Required

Organization- and project-level roles assigned to one MongoDB Cloud user within one organization.

Hide roles attributes Show roles attributes object

groupRoleAssignments array[object]

List of project-level role assignments assigned to the MongoDB Cloud user.

Hide groupRoleAssignments attributes Show groupRoleAssignments attributes object

groupId string

Unique 24-hexadecimal digit string that identifies the project to which these roles belong.

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

groupRoles array[string]

One or more project-level roles assigned to the MongoDB Cloud user.

Values are GROUP_OWNER, GROUP_CLUSTER_MANAGER, GROUP_STREAM_PROCESSING_OWNER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATA_ACCESS_READ_ONLY, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, GROUP_BACKUP_MANAGER, GROUP_OBSERVABILITY_VIEWER, or GROUP_DATABASE_ACCESS_ADMIN.

orgRoles array[string]

One or more organization-level roles assigned to the MongoDB Cloud user.

Values are ORG_OWNER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_READ_ONLY, or ORG_MEMBER.

teamIds array[string]

List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.

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

username string(email) Required

Email address that represents the username of the MongoDB Cloud user.

country string

Two-character alphabetical string that identifies the MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.

Format should match the following pattern: ^([A-Z]{2})$.

createdAt string(date-time) Required

Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.

firstName string Required

First or given name that belongs to the MongoDB Cloud user.

lastAuth string(date-time)

Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.

lastName string Required

Last name, family name, or surname that belongs to the MongoDB Cloud user.

mobileNumber string

Mobile phone number that belongs to the MongoDB Cloud user.

Format should match the following pattern: (?:(?:\\+?1\\s*(?:[.-]\\s*)?)?(?:(\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\s*(?:[.-]\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\s*(?:[.-]\\s*)?([0-9]{4})$.
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.

POST /api/atlas/v2/orgs/{orgId}/users/{userId}:addRole

curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v2/orgs/4888442a3354817a7320eb61/users/{userId}:addRole' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/vnd.atlas.2025-02-19+json"

Request examples

{
  "orgRole": "ORG_OWNER"
}

Response examples (200)

{
  "id": "32b6e34b3d91647abb20e7b8",
  "orgMembershipStatus": "PENDING",
  "roles": {
    "groupRoleAssignments": [
      {
        "groupId": "32b6e34b3d91647abb20e7b8",
        "groupRoles": [
          "GROUP_OWNER"
        ]
      }
    ],
    "orgRoles": [
      "ORG_OWNER"
    ]
  },
  "teamIds": [
    "32b6e34b3d91647abb20e7b8"
  ],
  "username": "hello@example.com",
  "invitationCreatedAt": "2025-05-04T09:42:00Z",
  "invitationExpiresAt": "2025-05-04T09:42:00Z",
  "inviterUsername": "hello@example.com"
}

{
  "id": "32b6e34b3d91647abb20e7b8",
  "orgMembershipStatus": "ACTIVE",
  "roles": {
    "groupRoleAssignments": [
      {
        "groupId": "32b6e34b3d91647abb20e7b8",
        "groupRoles": [
          "GROUP_OWNER"
        ]
      }
    ],
    "orgRoles": [
      "ORG_OWNER"
    ]
  },
  "teamIds": [
    "32b6e34b3d91647abb20e7b8"
  ],
  "username": "hello@example.com",
  "country": "US",
  "createdAt": "2025-05-04T09:42:00Z",
  "firstName": "John",
  "lastAuth": "2025-05-04T09:42:00Z",
  "lastName": "Doe",
  "mobileNumber": "string"
}

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 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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 (409)

{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}

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

Return Atlas Search Hardware and Status Metrics

GET /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements

Service accounts Digest auth

Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types.

Path parameters

processId string Required

Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

Format should match the following pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$.
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})$.

Query parameters

granularity string Required

Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.
period string

Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.
start string(date-time)

Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
end string(date-time)

Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
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.
metrics array[string] Required

List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.

Not more than 10 elements. Values are FTS_DISK_USAGE, FTS_PROCESS_CPU_KERNEL, FTS_PROCESS_CPU_USER, FTS_PROCESS_NORMALIZED_CPU_KERNEL, FTS_PROCESS_NORMALIZED_CPU_USER, FTS_PROCESS_RESIDENT_MEMORY, FTS_PROCESS_SHARED_MEMORY, FTS_PROCESS_VIRTUAL_MEMORY, JVM_CURRENT_MEMORY, JVM_MAX_MEMORY, or PAGE_FAULTS.

Responses

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

OK
Hide response attributes Show response attributes object
- end string(date-time)
  
  Date and time that specifies when to stop retrieving measurements. If you set end, you must set start. You can't set this parameter and period in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- granularity string
  
  Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either period or start and end.
  
  Values are PT1M, PT5M, PT1H, or P1D.
- groupId string
  
  Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the mongod or mongos.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- hardwareMeasurements array[object]
  
  List that contains the Atlas Search hardware measurements.
  
  Hide hardwareMeasurements attributes Show hardwareMeasurements attributes object
  
  dataPoints array[object]
  
  List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the value parameter returns null.
  
  value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the value parameter returns null.
  
  Hide dataPoints attributes Show dataPoints attributes object
  
  timestamp string(date-time)
  
  Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  value number
  
  Value that comprises this data point.
  
  name string
  
  Human-readable label of the measurement that this data point covers.
  
  units string
  
  Element used to quantify the measurement. The resource returns units of throughput, storage, and time.
  
  Values are BYTES, BYTES_PER_SECOND, GIGABYTES, GIGABYTES_PER_HOUR, MEGABYTES_PER_SECOND, MICROSECONDS, MILLISECONDS, PERCENT, SCALAR, or SCALAR_PER_SECOND.
- links array[object]
  
  List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
  
  Web Linking Specification (RFC 5988)
  
  Hide links attributes Show links attributes object
  
  href string
  
  Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
  
  rel string
  
  Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
- processId string
  
  Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.
  
  Format should match the following pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$.
- start string(date-time)
  
  Date and time that specifies when to start retrieving measurements. If you set start, you must set end. You can't set this parameter and period in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- statusMeasurements array[object]
  
  List that contains the Atlas Search status measurements.
  
  Hide statusMeasurements attributes Show statusMeasurements attributes object
  
  dataPoints array[object]
  
  List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the value parameter returns null.
  
  value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the value parameter returns null.
  
  Hide dataPoints attributes Show dataPoints attributes object
  
  timestamp string(date-time)
  
  Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  value number
  
  Value that comprises this data point.
  
  name string
  
  Human-readable label of the measurement that this data point covers.
  
  units string
  
  Element used to quantify the measurement. The resource returns units of throughput, storage, and time.
  
  Values are BYTES, BYTES_PER_SECOND, GIGABYTES, GIGABYTES_PER_HOUR, MEGABYTES_PER_SECOND, MICROSECONDS, MILLISECONDS, PERCENT, SCALAR, or SCALAR_PER_SECOND.
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.
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.
429 application/json

Too Many Requests.
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.

GET /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v2/groups/32b6e34b3d91647abb20e7b8/hosts/my.host.name.com:27017/fts/metrics/measurements?granularity=PT1M&metrics=FTS_DISK_USAGE' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "end": "2025-05-04T09:42:00Z",
  "granularity": "PT1M",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "hardwareMeasurements": [
    {
      "dataPoints": [
        {
          "timestamp": "2025-05-04T09:42:00Z",
          "value": 42.0
        }
      ],
      "name": "string",
      "units": "BYTES"
    }
  ],
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "processId": "mongodb.example.com:27017",
  "start": "2025-05-04T09:42:00Z",
  "statusMeasurements": [
    {
      "dataPoints": [
        {
          "timestamp": "2025-05-04T09:42:00Z",
          "value": 42.0
        }
      ],
      "name": "string",
      "units": "BYTES"
    }
  ]
}

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 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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

Response examples (429)

{
  "error": 429,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Too Many Requests",
  "errorCode": "RATE_LIMITED"
}

Return Measurements for One Disk

GET /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}

Service accounts Digest auth

Returns measurement details for one disk or partition for the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.

Path parameters

partitionName string Required

Human-readable label of the disk or partition to which the measurements apply.
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})$.
processId string Required

Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

Format should match the following pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$.

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.

Responses

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

OK
Hide response attributes Show response attributes object
- links array[object]
  
  List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
  
  Web Linking Specification (RFC 5988)
  
  Hide links attributes Show links attributes object
  
  href string
  
  Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
  
  rel string
  
  Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
- partitionName string
  
  Human-readable label of the disk or partition to which the measurements apply.
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.

GET /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v2/groups/32b6e34b3d91647abb20e7b8/processes/mongodb.example.com:27017/disks/{partitionName}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "partitionName": "string"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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

Create One Network Peering Connection

POST /api/atlas/v2/groups/{groupId}/peers

Service accounts Digest auth

Creates one new network peering connection in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation.

Azure Network Peering Prerequisites

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})$.

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/vnd.atlas.2023-01-01+json

Body object Required

Create one network peering connection.

Group of Network Peering connection settings.

containerId string Required

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.

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

Cloud service provider that serves the requested network peering connection.

Value is AWS.
accepterRegionName string Required

Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns null if your VPC and the MongoDB Cloud VPC reside in the same region.
awsAccountId string Required

Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC.

Format should match the following pattern: ^[0-9]{12}$.
routeTableCidrBlock string Required

Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC.

Format should match the following pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.
vpcId string Required

Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC.

Format should match the following pattern: ^vpc-[0-9a-f]{17}$.

Group of Network Peering connection settings.

containerId string Required

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.

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

Cloud service provider that serves the requested network peering connection.

Value is AZURE.
azureDirectoryId string(uuid) Required

Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides.
azureSubscriptionId string(uuid) Required

Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides.
resourceGroupName string Required

Human-readable label that identifies the resource group in which the VNet to peer with the MongoDB Cloud VNet resides.

Format should match the following pattern: ^([-\w._()])+$.
vnetName string Required

Human-readable label that identifies the VNet that you want to peer with the MongoDB Cloud VNet.

Format should match the following pattern: ^([-\w._()])$.

Group of Network Peering connection settings.

containerId string Required

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.

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

Cloud service provider that serves the requested network peering connection.

Value is GCP.
gcpProjectId string Required

Human-readable label that identifies the GCP project that contains the network that you want to peer with the MongoDB Cloud VPC.

Format should match the following pattern: ^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}.
networkName string Required

Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.

Format should match the following pattern: [a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?.

Responses

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

OK
One of:
AWS object AZURE object GCP object
Group of Network Peering connection settings.

Hide attributes Show attributes

containerId string Required

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.

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

id string

Unique 24-hexadecimal digit string that identifies the network peering connection.

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

providerName string Discriminator

Cloud service provider that serves the requested network peering connection.

Value is AWS.

accepterRegionName string Required

Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns null if your VPC and the MongoDB Cloud VPC reside in the same region.

awsAccountId string Required

Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC.

Format should match the following pattern: ^[0-9]{12}$.

connectionId string

Unique string that identifies the peering connection on AWS.

errorStateName string

Type of error that can be returned when requesting an Amazon Web Services (AWS) peering connection. The resource returns null if the request succeeded.

Values are REJECTED, EXPIRED, or INVALID_ARGUMENT.

routeTableCidrBlock string Required

Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC.

Format should match the following pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

statusName string

State of the network peering connection at the time you made the request.

Values are INITIATING, PENDING_ACCEPTANCE, FAILED, FINALIZING, AVAILABLE, or TERMINATING.

vpcId string Required

Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC.

Format should match the following pattern: ^vpc-[0-9a-f]{17}$.
Group of Network Peering connection settings.

Hide attributes Show attributes

containerId string Required

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.

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

id string

Unique 24-hexadecimal digit string that identifies the network peering connection.

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

providerName string Discriminator

Cloud service provider that serves the requested network peering connection.

Value is AZURE.

azureDirectoryId string(uuid) Required

Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides.

azureSubscriptionId string(uuid) Required

Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides.

errorState string

Error message returned when a requested Azure network peering resource returns "status" : "FAILED". The resource returns null if the request succeeded.

resourceGroupName string Required

Human-readable label that identifies the resource group in which the VNet to peer with the MongoDB Cloud VNet resides.

Format should match the following pattern: ^([-\w._()])+$.

status string

State of the network peering connection at the time you made the request.

Values are ADDING_PEER, AVAILABLE, FAILED, DELETION_FAILED, or DELETING.

vnetName string Required

Human-readable label that identifies the VNet that you want to peer with the MongoDB Cloud VNet.

Format should match the following pattern: ^([-\w._()])$.
Group of Network Peering connection settings.

Hide attributes Show attributes

containerId string Required

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.

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

id string

Unique 24-hexadecimal digit string that identifies the network peering connection.

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

providerName string Discriminator

Cloud service provider that serves the requested network peering connection.

Value is GCP.

errorMessage string

Details of the error returned when requesting a GCP network peering resource. The resource returns null if the request succeeded.

gcpProjectId string Required

Human-readable label that identifies the GCP project that contains the network that you want to peer with the MongoDB Cloud VPC.

Format should match the following pattern: ^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}.

networkName string Required

Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.

Format should match the following pattern: [a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?.

status string

State of the network peering connection at the time you made the request.

Values are ADDING_PEER, WAITING_FOR_USER, AVAILABLE, FAILED, or DELETING.
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.

POST /api/atlas/v2/groups/{groupId}/peers

curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v2/groups/32b6e34b3d91647abb20e7b8/peers' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/vnd.atlas.2023-01-01+json"

Request examples

{
  "containerId": "32b6e34b3d91647abb20e7b8",
  "providerName": "AWS",
  "accepterRegionName": "string",
  "awsAccountId": "string",
  "routeTableCidrBlock": "string",
  "vpcId": "string"
}

{
  "containerId": "32b6e34b3d91647abb20e7b8",
  "providerName": "AZURE",
  "azureDirectoryId": "string",
  "azureSubscriptionId": "string",
  "resourceGroupName": "string",
  "vnetName": "string"
}

{
  "containerId": "32b6e34b3d91647abb20e7b8",
  "providerName": "GCP",
  "gcpProjectId": "string",
  "networkName": "string"
}

Response examples (200)

{
  "containerId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "providerName": "AWS",
  "accepterRegionName": "string",
  "awsAccountId": "string",
  "connectionId": "string",
  "errorStateName": "REJECTED",
  "routeTableCidrBlock": "string",
  "statusName": "INITIATING",
  "vpcId": "string"
}

{
  "containerId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "providerName": "AZURE",
  "azureDirectoryId": "string",
  "azureSubscriptionId": "string",
  "errorState": "string",
  "resourceGroupName": "string",
  "status": "ADDING_PEER",
  "vnetName": "string"
}

{
  "containerId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "providerName": "GCP",
  "errorMessage": "string",
  "gcpProjectId": "string",
  "networkName": "string",
  "status": "ADDING_PEER"
}

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 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

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 (409)

{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}

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