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
- charFilters array[object]
  
  Filters that examine text one character at a time and perform filtering operations.
  One of:
  charFilterhtmlStrip object charFiltericuNormalize object charFiltermapping object charFilterpersian object
  
  Filter that strips out HTML constructs.
  
  Hide attributes Show attributes
  
  ignoredTags array[string]
  
  The HTML tags that you want to exclude from filtering.
  
  type string Required
  
  Human-readable label that identifies this character filter type.
  
  Value is htmlStrip.
  
  Filter that applies normalization mappings that you specify to characters.
  
  Hide attributes Show attributes
  
  mappings object Required
  
  Comma-separated list of mappings. A mapping indicates that one character or group of characters should be substituted for another, using the following format:
  
  <original> : <replacement>.
  
  Hide mappings attribute Show mappings attribute object
  
  * string Additional properties
  
  type string Required
  
  Human-readable label that identifies this character filter type.
  
  Value is mapping.
- name string Required
  Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:
  
  lucene.
  
  builtin.
  
  mongodb.
- tokenFilters array[object]
  Filter that performs operations such as:
  
  Stemming, which reduces related words, such as "talking", "talked", and "talks" to their root word "talk".
  
  Redaction, the removal of sensitive information from public documents.
  Any of:
  tokenFilterasciiFolding object tokenFilterdaitchMokotoffSoundex object tokenFilteredgeGram object TokenFilterEnglishPossessive object TokenFilterFlattenGraph object tokenFiltericuFolding object tokenFiltericuNormalizer object TokenFilterkStemming object tokenFilterlength object tokenFilterlowercase object tokenFilternGram object TokenFilterPorterStemming object tokenFilterregex object tokenFilterreverse object tokenFiltershingle object tokenFiltersnowballStemming object TokenFilterSpanishPluralStemming object TokenFilterStempel object tokenFilterstopword object tokenFiltertrim object TokenFilterWordDelimiterGraph object
  
  Filter that converts alphabetic, numeric, and symbolic Unicode characters that are not in the Basic Latin Unicode block to their ASCII equivalents, if available.
  
  Hide attributes Show attributes
  
  originalTokens string
  
  Value that indicates whether to include or omit the original tokens in the output of the token filter.
  
  Choose include if you want to support queries on both the original tokens as well as the converted forms.
  
  Choose omit if you want to query only on the converted forms of the original tokens.
  
  Values are omit or include. Default value is omit.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is asciiFolding.
  
  Filter that creates tokens for words that sound the same based on the Daitch-Mokotoff Soundex phonetic algorithm. This filter can generate multiple encodings for each input, where each encoded token is a 6 digit number.
  
  NOTE: Don't use the daitchMokotoffSoundex token filter in:
  
  -Synonym or autocomplete mapping definitions
  
  Operators where fuzzy is enabled. Atlas Search supports the fuzzy option only for the autocomplete, term, and text operators.
  
  Hide attributes Show attributes
  
  originalTokens string
  
  Value that indicates whether to include or omit the original tokens in the output of the token filter.
  
  Choose include if you want to support queries on both the original tokens as well as the converted forms.
  
  Choose omit if you want to query only on the converted forms of the original tokens.
  
  Values are omit or include. Default value is include.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is daitchMokotoffSoundex.
  
  Filter that tokenizes input from the left side, or "edge", of a text input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.
  
  Hide attributes Show attributes
  
  maxGram integer Required
  
  Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to minGram.
  
  minGram integer Required
  
  Value that specifies the minimum length of generated n-grams. This value must be less than or equal to maxGram.
  
  termNotInBounds string
  
  Value that indicates whether to index tokens shorter than minGram or longer than maxGram.
  
  Values are omit or include. Default value is omit.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is edgeGram.
  
  Filter that 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
  
  normalizationForm string
  
  Normalization form to apply.
  
  Values are nfd, nfc, nfkd, or nfkc. Default value is nfc.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is icuNormalizer.
  
  Filter that removes tokens that are too short or too long.
  
  Hide attributes Show attributes
  
  max integer
  
  Number that specifies the maximum length of a token. Value must be greater than or equal to min.
  
  Default value is 255.
  
  min integer
  
  Number that specifies the minimum length of a token. This value must be less than or equal to max.
  
  Default value is 0.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is length.
  
  Filter that tokenizes input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.
  
  Hide attributes Show attributes
  
  maxGram integer Required
  
  Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to minGram.
  
  minGram integer Required
  
  Value that specifies the minimum length of generated n-grams. This value must be less than or equal to maxGram.
  
  termNotInBounds string
  
  Value that indicates whether to index tokens shorter than minGram or longer than maxGram.
  
  Values are omit or include. Default value is omit.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is nGram.
  
  Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.
  
  Hide attribute Show attribute
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is porterStemming.
  
  Filter that applies a regular expression to each token, replacing matches with a specified string.
  
  Hide attributes Show attributes
  
  matches string Required
  
  Value that indicates whether to replace only the first matching pattern or all matching patterns.
  
  Values are all or first.
  
  pattern string Required
  
  Regular expression pattern to apply to each token.
  
  replacement string Required
  
  Replacement string to substitute wherever a matching pattern occurs.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is regex.
  
  Filter that constructs shingles (token n-grams) from a series of tokens. You can't use this token filter in synonym or autocomplete mapping definitions.
  
  Hide attributes Show attributes
  
  maxShingleSize integer Required
  
  Value that specifies the maximum number of tokens per shingle. This value must be greater than or equal to minShingleSize.
  
  minShingleSize integer Required
  
  Value that specifies the minimum number of tokens per shingle. This value must be less than or equal to maxShingleSize.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is shingle.
  
  Filter that stems tokens using a Snowball-generated stemmer.
  
  Hide attributes Show attributes
  
  stemmerName string Required
  
  Snowball-generated stemmer to use.
  
  Values are arabic, armenian, basque, catalan, danish, dutch, english, finnish, french, german, german2, hungarian, irish, italian, kp, lithuanian, lovins, norwegian, porter, portuguese, romanian, russian, spanish, swedish, or turkish.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is snowballStemming.
  
  Filter that removes tokens that correspond to the specified stop words. This token filter doesn't analyze the stop words that you specify.
  
  Hide attributes Show attributes
  
  ignoreCase boolean
  
  Flag that indicates whether to ignore the case of stop words when filtering the tokens to remove.
  
  Default value is true.
  
  tokens array[string] Required
  
  The stop words that correspond to the tokens to remove. Value must be one or more stop words.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is stopword.
  
  Filter that splits tokens into sub-tokens based on configured rules.
  
  Hide attributes Show attributes
  
  delimiterOptions object
  
  Object that contains the rules that determine how to split words into sub-words.
  
  Hide delimiterOptions attributes Show delimiterOptions attributes object
  
  concatenateAll boolean
  
  Flag that indicates whether to concatenate runs.
  
  Default value is false.
  
  concatenateNumbers boolean
  
  Flag that indicates whether to concatenate runs of sub-numbers.
  
  Default value is false.
  
  concatenateWords boolean
  
  Flag that indicates whether to concatenate runs of sub-words.
  
  Default value is false.
  
  generateNumberParts boolean
  
  Flag that indicates whether to split tokens based on sub-numbers. For example, if true, this option splits 100-2 into 100 and 2.
  
  Default value is true.
  
  generateWordParts boolean
  
  Flag that indicates whether to split tokens based on sub-words.
  
  Default value is true.
  
  ignoreKeywords boolean
  
  Flag that indicates whether to skip tokens with the keyword attribute set to true.
  
  Default value is false.
  
  preserveOriginal boolean
  
  Flag that indicates whether to generate tokens of the original words.
  
  Default value is true.
  
  splitOnCaseChange boolean
  
  Flag that indicates whether to split tokens based on letter-case transitions.
  
  Default value is true.
  
  splitOnNumerics boolean
  
  Flag that indicates whether to split tokens based on letter-number transitions.
  
  Default value is true.
  
  stemEnglishPossessive boolean
  
  Flag that indicates whether to remove trailing possessives from each sub-word.
  
  Default value is true.
  
  protectedWords object
  
  Object that contains options for protected words.
  
  Hide protectedWords attributes Show protectedWords attributes object
  
  ignoreCase boolean
  
  Flag that indicates whether to ignore letter case sensitivity for protected words.
  
  Default value is true.
  
  words array[string] Required
  
  List that contains the tokens to protect from delimination.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is wordDelimiterGraph.
- tokenizer object Required
  
  Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing.
  
  One of:
  tokenizeredgeGram object tokenizerkeyword object tokenizernGram object tokenizerregexCaptureGroup object tokenizerregexSplit object tokenizerstandard object tokenizeruaxUrlEmail object tokenizerwhitespace object
  
  Tokenizer that splits input from the left side, or "edge", of a text input into n-grams of given sizes. You can't use the edgeGram tokenizer in synonym or autocomplete mapping definitions.
  
  Hide attributes Show attributes
  
  maxGram integer Required
  
  Characters to include in the longest token that Atlas Search creates.
  
  minGram integer Required
  
  Characters to include in the shortest token that Atlas Search creates.
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is edgeGram.
  
  Tokenizer that splits input into text chunks, or "n-grams", of into given sizes. You can't use the nGram tokenizer in synonym or autocomplete mapping definitions.
  
  Hide attributes Show attributes
  
  maxGram integer Required
  
  Characters to include in the longest token that Atlas Search creates.
  
  minGram integer Required
  
  Characters to include in the shortest token that Atlas Search creates.
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is edgeGram.
  
  Tokenizer that uses a regular expression pattern to extract tokens.
  
  Hide attributes Show attributes
  
  group integer Required
  
  Index of the character group within the matching expression to extract into tokens. Use 0 to extract all character groups.
  
  pattern string Required
  
  Regular expression to match against.
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is regexCaptureGroup.
  
  Tokenizer that splits tokens using a regular-expression based delimiter.
  
  Hide attributes Show attributes
  
  pattern string Required
  
  Regular expression to match against.
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is regexSplit.
  
  Tokenizer that splits tokens based on word break rules from the Unicode Text Segmentation algorithm.
  
  Hide attributes Show attributes
  
  maxTokenLength integer
  
  Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens.
  
  Default value is 255.
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is standard.
  
  Tokenizer that creates tokens from URLs and email addresses. Although this tokenizer uses word break rules from the Unicode Text Segmentation algorithm, we recommend using it only when the indexed field value includes URLs and email addresses. For fields that don't include URLs or email addresses, use the standard tokenizer to create tokens based on word break rules.
  
  Hide attributes Show attributes
  
  maxTokenLength integer
  
  Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens.
  
  Default value is 255.
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is uaxUrlEmail.
  
  Tokenizer that creates tokens based on occurrences of whitespace between words.
  
  Hide attributes Show attributes
  
  maxTokenLength integer
  
  Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens.
  
  Default value is 255.
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is whitespace.
mappings object

Index specifications for the collection's fields.
Hide mappings attributes Show mappings attributes object
- dynamic boolean
  
  Flag that indicates whether the index uses dynamic or static mappings. Required if mappings.fields is omitted.
  
  Default value is false.
  
  Dynamic or Static Mappings
- fields object
  
  One or more field specifications for the Atlas Search index. Required if mappings.dynamic is omitted or set to false.
  
  Atlas Search Index
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  Atlas Search Field Mappings
searchAnalyzer string

Method applied to identify words when searching this index.

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

Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see documentation.

Stored Source Fields
synonyms array[object]

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

Synonyms used for this full text index.

Synonym Mapping
Hide synonyms attributes Show synonyms attributes object
- analyzer string Required
  
  Specific pre-defined method chosen to apply to the synonyms to be searched.
  
  Values are lucene.standard, lucene.simple, lucene.whitespace, lucene.keyword, lucene.arabic, lucene.armenian, lucene.basque, lucene.bengali, lucene.brazilian, lucene.bulgarian, lucene.catalan, lucene.chinese, lucene.cjk, lucene.czech, lucene.danish, lucene.dutch, lucene.english, lucene.finnish, lucene.french, lucene.galician, lucene.german, lucene.greek, lucene.hindi, lucene.hungarian, lucene.indonesian, lucene.irish, lucene.italian, lucene.japanese, lucene.korean, lucene.kuromoji, lucene.latvian, lucene.lithuanian, lucene.morfologik, lucene.nori, lucene.norwegian, lucene.persian, lucene.portuguese, lucene.romanian, lucene.russian, lucene.smartcn, lucene.sorani, lucene.spanish, lucene.swedish, lucene.thai, lucene.turkish, or lucene.ukrainian.
- name string Required
  
  Label that identifies the synonym definition. Each synonym.name must be unique within the same index definition.
- source object Required
  
  Data set that stores words and their applicable synonyms.
  Hide source attribute Show source attribute object
  
  collection string Required
  
  Label that identifies the MongoDB collection that stores words and their applicable synonyms.

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:
SearchIndex object VectorSearchIndex object
Hide attributes Show attributes

collectionName string Required

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

database string Required

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

name string Required

Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique.

numPartitions integer(int32)

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

Default value is 1.

type string Discriminator

Type of the index. Default type is search.

Value is search.

analyzer string

Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a term or token. This process, known as tokenization, involves a variety of changes made to the text in fields:

extracting words

removing punctuation

removing accents

changing to lowercase

removing common words

reducing words to their root form (stemming)

changing words to their base form (lemmatization) MongoDB Cloud uses the selected process to build the Atlas Search index.

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

Atlas Search Analyzers

analyzers array[object]

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

Settings that describe one Atlas Search custom analyzer.

Custom Atlas Search Analyzers

Hide analyzers attributes Show analyzers attributes object

charFilters array[object]

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

One of:
charFilterhtmlStrip object charFiltericuNormalize object charFiltermapping object charFilterpersian object

Filter that strips out HTML constructs.

Hide attributes Show attributes

ignoredTags array[string]

The HTML tags that you want to exclude from filtering.

type string Required

Human-readable label that identifies this character filter type.

Value is htmlStrip.

Filter that applies normalization mappings that you specify to characters.

Hide attributes Show attributes

mappings object Required

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

<original> : <replacement>.

Hide mappings attribute Show mappings attribute object

* string Additional properties

type string Required

Human-readable label that identifies this character filter type.

Value is mapping.

name string Required

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

lucene.

builtin.

mongodb.

tokenFilters array[object]

Filter that performs operations such as:

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

Redaction, the removal of sensitive information from public documents.

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

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

Hide attributes Show attributes

originalTokens string

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

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

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

Values are omit or include. Default value is omit.

type string Required

Human-readable label that identifies this token filter type.

Value is asciiFolding.

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

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

-Synonym or autocomplete mapping definitions

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

Hide attributes Show attributes

originalTokens string

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

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

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

Values are omit or include. Default value is include.

type string Required

Human-readable label that identifies this token filter type.

Value is daitchMokotoffSoundex.

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

Hide attributes Show attributes

maxGram integer Required

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

minGram integer Required

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

termNotInBounds string

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

Values are omit or include. Default value is omit.

type string Required

Human-readable label that identifies this token filter type.

Value is edgeGram.

Filter that 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

normalizationForm string

Normalization form to apply.

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

type string Required

Human-readable label that identifies this token filter type.

Value is icuNormalizer.

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

Hide attributes Show attributes

max integer

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

Default value is 255.

min integer

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

Default value is 0.

type string Required

Human-readable label that identifies this token filter type.

Value is length.

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

Hide attributes Show attributes

maxGram integer Required

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

minGram integer Required

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

termNotInBounds string

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

Values are omit or include. Default value is omit.

type string Required

Human-readable label that identifies this token filter type.

Value is nGram.

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

Hide attribute Show attribute

type string Required

Human-readable label that identifies this token filter type.

Value is porterStemming.

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

Hide attributes Show attributes

matches string Required

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

Values are all or first.

pattern string Required

Regular expression pattern to apply to each token.

replacement string Required

Replacement string to substitute wherever a matching pattern occurs.

type string Required

Human-readable label that identifies this token filter type.

Value is regex.

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

Hide attributes Show attributes

maxShingleSize integer Required

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

minShingleSize integer Required

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

type string Required

Human-readable label that identifies this token filter type.

Value is shingle.

Filter that stems tokens using a Snowball-generated stemmer.

Hide attributes Show attributes

stemmerName string Required

Snowball-generated stemmer to use.

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

type string Required

Human-readable label that identifies this token filter type.

Value is snowballStemming.

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

Hide attributes Show attributes

ignoreCase boolean

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

Default value is true.

tokens array[string] Required

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

type string Required

Human-readable label that identifies this token filter type.

Value is stopword.

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

Hide attributes Show attributes

delimiterOptions object

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

Hide delimiterOptions attributes Show delimiterOptions attributes object

concatenateAll boolean

Flag that indicates whether to concatenate runs.

Default value is false.

concatenateNumbers boolean

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

Default value is false.

concatenateWords boolean

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

Default value is false.

generateNumberParts boolean

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

Default value is true.

generateWordParts boolean

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

Default value is true.

ignoreKeywords boolean

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

Default value is false.

preserveOriginal boolean

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

Default value is true.

splitOnCaseChange boolean

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

Default value is true.

splitOnNumerics boolean

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

Default value is true.

stemEnglishPossessive boolean

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

Default value is true.

protectedWords object

Object that contains options for protected words.

Hide protectedWords attributes Show protectedWords attributes object

ignoreCase boolean

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

Default value is true.

words array[string] Required

List that contains the tokens to protect from delimination.

type string Required

Human-readable label that identifies this token filter type.

Value is wordDelimiterGraph.

tokenizer object Required

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

One of:
tokenizeredgeGram object tokenizerkeyword object tokenizernGram object tokenizerregexCaptureGroup object tokenizerregexSplit object tokenizerstandard object tokenizeruaxUrlEmail object tokenizerwhitespace object

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

Hide attributes Show attributes

maxGram integer Required

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

minGram integer Required

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

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is edgeGram.

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

Hide attributes Show attributes

maxGram integer Required

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

minGram integer Required

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

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is edgeGram.

Tokenizer that uses a regular expression pattern to extract tokens.

Hide attributes Show attributes

group integer Required

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

pattern string Required

Regular expression to match against.

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is regexCaptureGroup.

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

Hide attributes Show attributes

pattern string Required

Regular expression to match against.

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is regexSplit.

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

Hide attributes Show attributes

maxTokenLength integer

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

Default value is 255.

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is standard.

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

Hide attributes Show attributes

maxTokenLength integer

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

Default value is 255.

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is uaxUrlEmail.

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

Hide attributes Show attributes

maxTokenLength integer

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

Default value is 255.

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is whitespace.

mappings object

Index specifications for the collection's fields.

Hide mappings attributes Show mappings attributes object

dynamic boolean

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

Default value is false.

Dynamic or Static Mappings

fields object

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

Atlas Search Index

Hide fields attribute Show fields attribute object

* object Additional properties
Atlas Search Field Mappings

searchAnalyzer string

Method applied to identify words when searching this index.

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

storedSource object

Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see documentation.

Stored Source Fields

synonyms array[object]

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

Synonyms used for this full text index.

Synonym Mapping

Hide synonyms attributes Show synonyms attributes object

analyzer string Required

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

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

name string Required

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

source object Required

Data set that stores words and their applicable synonyms.

Hide source attribute Show source attribute object

collection string Required

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

collectionName string Required

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

database string Required

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

name string Required

Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique.

numPartitions integer(int32)

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

Default value is 1.

type string Discriminator

Type of the index. Default type is search.

Value is vectorSearch.

fields array[object]

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

Vector Search Fields

Hide fields attribute Show fields attribute object

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

atlas api createAtlasSearchIndexDeprecated --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.CreateAtlasSearchIndexDeprecatedApiParams{}
	sdkResp, httpResp, err := client.AtlasSearchApi.
		CreateAtlasSearchIndexDeprecatedWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \
  -d '{ <Payload> }'

Request examples

{
  "collectionName": "string",
  "database": "string",
  "name": "string",
  "numPartitions": 1,
  "type": "search",
  "analyzer": "lucene.standard",
  "analyzers": [
    {
      "charFilters": [
        {
          "ignoredTags": [
            "string"
          ],
          "type": "htmlStrip"
        }
      ],
      "name": "string",
      "tokenFilters": [
        {
          "originalTokens": "omit",
          "type": "asciiFolding"
        }
      ],
      "tokenizer": {
        "maxGram": 42,
        "minGram": 42,
        "type": "edgeGram"
      }
    }
  ],
  "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": "search",
  "fields": [
    {
      "additionalProperty1": {},
      "additionalProperty2": {}
    }
  ]
}

Response examples (200)

{
  "collectionName": "string",
  "database": "string",
  "name": "string",
  "numPartitions": 1,
  "type": "search",
  "analyzer": "lucene.standard",
  "analyzers": [
    {
      "charFilters": [
        {
          "ignoredTags": [
            "string"
          ],
          "type": "htmlStrip"
        }
      ],
      "name": "string",
      "tokenFilters": [
        {
          "originalTokens": "omit",
          "type": "asciiFolding"
        }
      ],
      "tokenizer": {
        "maxGram": 42,
        "minGram": 42,
        "type": "edgeGram"
      }
    }
  ],
  "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": "search",
  "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"
}

Restore One Snapshot of One Serverless Instance

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

Service accounts Digest auth

Restores one snapshot of 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 createFlexBackupRestoreJob endpoint instead.

createFlexBackupRestoreJob

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 whose snapshot you want to restore.

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 Required

Restores one snapshot of one serverless instance from the specified project.

deliveryType string Required

Human-readable label that categorizes the restore job to create.

Values are automated, download, or pointInTime.
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})$.

Responses

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

OK
Hide response attributes Show response 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
  
  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.
  
  increment integer(int32)
  
  Order of the database operation that the oplog recorded at specific date and time.
  
  Minimum value is 1199145600.
- 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.
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}/serverless/{clusterName}/backup/restoreJobs

atlas api createServerlessBackupRestoreJob --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.CreateServerlessBackupRestoreJobApiParams{}
	sdkResp, httpResp, err := client.CloudBackupsApi.
		CreateServerlessBackupRestoreJobWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" \
  -d '{ <Payload> }'

Request examples

{
  "deliveryType": "automated",
  "oplogInc": 1,
  "oplogTs": 42,
  "pointInTimeUTCSeconds": 42,
  "snapshotId": "32b6e34b3d91647abb20e7b8",
  "targetClusterName": "string",
  "targetGroupId": "32b6e34b3d91647abb20e7b8"
}

Response examples (200)

{
  "cancelled": true,
  "deliveryType": "automated",
  "deliveryUrl": [
    "string"
  ],
  "desiredTimestamp": {
    "date": "2025-05-04T09:42:00Z",
    "increment": 1199145600
  },
  "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"
}

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 All Authorized Clusters in All Projects

GET /api/atlas/v2/clusters

Service accounts Digest auth

Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting Service Account or API Key can have any cluster-level role.

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
  
  clusters array[object]
  
  Settings that describe the clusters in each project that the API key is authorized to view.
  
  Settings that describe the clusters in each project that the API key is authorized to view.
  
  Hide clusters attributes Show clusters attributes object
  
  alertCount integer(int32)
  
  Whole number that indicates the quantity of alerts open on the cluster.
  
  authEnabled boolean
  
  Flag that indicates whether authentication is required to access the nodes in this cluster.
  
  availability string
  
  Term that expresses how many nodes of the cluster can be accessed when MongoDB Cloud receives this request. This parameter returns available when all nodes are accessible, warning only when some nodes in the cluster can be accessed, unavailable when the cluster can't be accessed, or dead when the cluster has been deactivated.
  
  Values are available, dead, unavailable, or warning.
  
  backupEnabled boolean
  
  Flag that indicates whether the cluster can perform backups. If set to true, the cluster can perform backups. You must set this value to true for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to false, the cluster doesn't use MongoDB Cloud backups.
  
  clusterId string
  
  Unique 24-hexadecimal character string that identifies the cluster. Each clusterId is used only once across all MongoDB Cloud deployments.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  dataSizeBytes integer(int64)
  
  Total size of the data stored on each node in the cluster. The resource expresses this value in bytes.
  
  name string
  
  Human-readable label that identifies the cluster.
  
  Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
  
  nodeCount integer(int32)
  
  Whole number that indicates the quantity of nodes that comprise the cluster.
  
  sslEnabled boolean
  
  Flag that indicates whether TLS authentication is required to access the nodes in this cluster.
  
  type string
  
  Human-readable label that indicates the cluster type.
  
  Values are REPLICA_SET or SHARDED_CLUSTER.
  
  versions array[string]
  
  List that contains the versions of MongoDB that each node in the cluster runs.
  
  groupId string
  
  Unique 24-hexadecimal character string that identifies the project.
  
  groupName string
  
  Human-readable label that identifies the project.
  
  Format should match the following pattern: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$.
  
  orgId string
  
  Unique 24-hexadecimal character string that identifies the organization that contains the project.
  
  orgName string
  
  Human-readable label that identifies the organization that contains the project.
  
  Format should match the following pattern: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$.
  
  planType string
  
  Human-readable label that indicates the plan type.
  
  tags array[string]
  
  List of human-readable labels that categorize the specified project. MongoDB Cloud returns an empty array.
- 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.
401 application/json

Unauthorized.
Hide response attributes Show response attributes object
- badRequestDetail object
  
  Bad request detail.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object
  
  fields array[object]
  
  Describes all violations in a client request.
  
  Hide fields attributes Show fields attributes object
  
  description string Required
  
  A description of why the request element is bad.
  
  field string Required
  
  A path that leads to a field in the request body.
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32) Required
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string Required
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.
403 application/json

Forbidden.
Hide response attributes Show response attributes object
- badRequestDetail object
  
  Bad request detail.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object
  
  fields array[object]
  
  Describes all violations in a client request.
  
  Hide fields attributes Show fields attributes object
  
  description string Required
  
  A description of why the request element is bad.
  
  field string Required
  
  A path that leads to a field in the request body.
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32) Required
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string Required
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.
500 application/json

Internal Server Error.
Hide response attributes Show response attributes object
- badRequestDetail object
  
  Bad request detail.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object
  
  fields array[object]
  
  Describes all violations in a client request.
  
  Hide fields attributes Show fields attributes object
  
  description string Required
  
  A description of why the request element is bad.
  
  field string Required
  
  A path that leads to a field in the request body.
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32) Required
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string Required
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.

GET /api/atlas/v2/clusters

atlas api listClustersForAllProjects --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ListClustersForAllProjectsApiParams{}
	sdkResp, httpResp, err := client.ClustersApi.
		ListClustersForAllProjectsWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true"

Response examples (200)

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "clusters": [
        {
          "alertCount": 42,
          "authEnabled": true,
          "availability": "available",
          "backupEnabled": true,
          "clusterId": "string",
          "dataSizeBytes": 42,
          "name": "string",
          "nodeCount": 42,
          "sslEnabled": true,
          "type": "REPLICA_SET",
          "versions": [
            "string"
          ]
        }
      ],
      "groupId": "string",
      "groupName": "string",
      "orgId": "string",
      "orgName": "string",
      "planType": "string",
      "tags": [
        "string"
      ]
    }
  ],
  "totalCount": 42
}

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 (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 Custom Roles in One Project

GET /api/atlas/v2/groups/{groupId}/customDBRoles/roles

Service accounts Digest auth

Returns all custom roles for 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})$.

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
- actions array[object]
  
  List of the individual privilege actions that the role grants.
  
  Privilege action that the role grants.
  
  Hide actions attributes Show actions attributes object
  
  action string Required
  
  Human-readable label that identifies the privilege action.
  
  Values are FIND, INSERT, REMOVE, UPDATE, BYPASS_DOCUMENT_VALIDATION, USE_UUID, KILL_OP, BYPASS_DEFAULT_MAX_TIME_MS, CREATE_COLLECTION, CREATE_INDEX, DROP_COLLECTION, ENABLE_PROFILER, KILL_ANY_CURSOR, CHANGE_STREAM, COLL_MOD, COMPACT, CONVERT_TO_CAPPED, DROP_DATABASE, DROP_INDEX, RE_INDEX, RENAME_COLLECTION_SAME_DB, SET_USER_WRITE_BLOCK, BYPASS_USER_WRITE_BLOCK, LIST_SESSIONS, KILL_ANY_SESSION, COLL_STATS, CONN_POOL_STATS, DB_HASH, DB_STATS, GET_CMD_LINE_OPTS, GET_LOG, GET_PARAMETER, GET_SHARD_MAP, HOST_INFO, IN_PROG, LIST_DATABASES, LIST_COLLECTIONS, LIST_INDEXES, LIST_SHARDS, NET_STAT, REPL_SET_GET_CONFIG, REPL_SET_GET_STATUS, SERVER_STATUS, VALIDATE, SHARDING_STATE, TOP, SQL_GET_SCHEMA, SQL_SET_SCHEMA, VIEW_ALL_HISTORY, OUT_TO_S3, OUT_TO_AZURE, OUT_TO_GCS, STORAGE_GET_CONFIG, STORAGE_SET_CONFIG, FLUSH_ROUTER_CONFIG, ENABLE_SHARDING, CHECK_METADATA_CONSISTENCY, MOVE_CHUNK, SPLIT_CHUNK, ANALYZE_SHARD_KEY, REFINE_COLLECTION_SHARD_KEY, CLEAR_JUMBO_FLAG, RESHARD_COLLECTION, SHARDED_DATA_DISTRIBUTION, GET_STREAM_PROCESSOR, CREATE_STREAM_PROCESSOR, PROCESS_STREAM_PROCESSOR, START_STREAM_PROCESSOR, STOP_STREAM_PROCESSOR, DROP_STREAM_PROCESSOR, SAMPLE_STREAM_PROCESSOR, LIST_STREAM_PROCESSORS, LIST_CONNECTIONS, or STREAM_PROCESSOR_STATS.
  
  resources array[object]
  
  List of resources on which you grant the action.
  
  Namespace to which this database user has access.
  
  Hide resources attributes Show resources attributes object
  
  cluster boolean Required
  
  Flag that indicates whether to grant the action on the cluster resource. If true, MongoDB Cloud ignores the actions.resources.collection and actions.resources.db parameters.
  
  collection string Required
  
  Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the actions.resources.db parameter. If you set "actions.resources.cluster" : true, MongoDB Cloud ignores this parameter.
  
  db string Required
  
  Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set "actions.resources.cluster" : true, MongoDB Cloud ignores this parameter.
- inheritedRoles array[object]
  
  List of the built-in roles that this custom role inherits.
  
  Role inherited from another context for this database user.
  
  Hide inheritedRoles attributes Show inheritedRoles attributes object
  
  db string Required
  
  Human-readable label that identifies the database on which someone grants the action to one MongoDB user.
  
  role string Required
  
  Human-readable label that identifies the role inherited. Set this value to admin for every role except read or readWrite.
  
  MongoDB Built-In Roles
- 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.
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}/customDBRoles/roles

atlas api listCustomDatabaseRoles --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ListCustomDatabaseRolesApiParams{}
	sdkResp, httpResp, err := client.CustomDatabaseRolesApi.
		ListCustomDatabaseRolesWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true"

Response examples (200)

[
  {
    "actions": [
      {
        "action": "FIND",
        "resources": [
          {
            "cluster": true,
            "collection": "string",
            "db": "string"
          }
        ]
      }
    ],
    "inheritedRoles": [
      {
        "db": "string",
        "role": "string"
      }
    ],
    "roleName": "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"
}

Return One Federated Database Instance Query Limit for One Project

GET /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}

Service accounts Digest auth

Returns the details of one query limit for the specified federated database instance 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})$.
tenantName string Required

Human-readable label that identifies the federated database instance to which the query limit applies.

limitName

string Required

Human-readable label that identifies this data federation instance limit.

Limit Name	Description	Default
bytesProcessed.query	Limit on the number of bytes processed during a single data federation query	N/A
bytesProcessed.daily	Limit on the number of bytes processed for the data federation instance for the current day	N/A
bytesProcessed.weekly	Limit on the number of bytes processed for the data federation instance for the current week	N/A
bytesProcessed.monthly	Limit on the number of bytes processed for the data federation instance for the current month	N/A

Values are bytesProcessed.query, bytesProcessed.daily, bytesProcessed.weekly, or bytesProcessed.monthly.

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
- currentUsage integer(int64)
  
  Amount that indicates the current usage of the limit.
- defaultLimit integer(int64)
  
  Default value of the limit.
- lastModifiedDate string(date-time)
  
  Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.
- maximumLimit integer(int64)
  
  Maximum value of the limit.
- name string Required
  
  Human-readable label that identifies the user-managed limit to modify.
- overrunPolicy string
  
  Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.
  
  Values are BLOCK or BLOCK_AND_KILL.
- tenantName string
  
  Human-readable label that identifies the Federated Database Instance. If specified, the usage limit is for the specified federated database instance only. If omitted, the usage limit is for all federated database instances in the project.
- value integer(int64) Required
  
  Amount to set the limit to.
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}/dataFederation/{tenantName}/limits/{limitName}

atlas api returnFederatedDatabaseQueryLimit --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ReturnFederatedDatabaseQueryLimitApiParams{}
	sdkResp, httpResp, err := client.DataFederationApi.
		ReturnFederatedDatabaseQueryLimitWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true"

Response examples (200)

{
  "currentUsage": 42,
  "defaultLimit": 42,
  "lastModifiedDate": "2025-05-04T09:42:00Z",
  "maximumLimit": 42,
  "name": "string",
  "overrunPolicy": "BLOCK",
  "tenantName": "string",
  "value": 42
}

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 Federated Database Instance and Online Archive Private Endpoints in One Project

GET /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds

Service accounts Digest auth

Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles.

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.
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
  
  azureLinkId string
  
  Link ID that identifies the Azure private endpoint connection.
  
  comment string
  
  Human-readable string to associate with this private endpoint.
  
  customerEndpointDNSName string
  
  Human-readable label to identify customer's VPC endpoint DNS name. If defined, you must also specify a value for region.
  
  customerEndpointIPAddress string
  
  IP address used to connect to the Azure private endpoint.
  
  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}$.
  
  endpointId string Required
  
  Unique 22-character alphanumeric string that identifies the private endpoint.
  
  Format should match the following pattern: ^vpce-[0-9a-f]{17}$.
  
  Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature
  
  errorMessage string
  
  Error message describing a failure approving the private endpoint request.
  
  provider string
  
  Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only.
  
  Value is AWS. Default value is AWS.
  
  region string
  
  Human-readable label to identify the region of customer's VPC endpoint. If defined, you must also specify a value for customerEndpointDNSName.
  
  status string
  
  Status of the private endpoint connection request.
  
  Values are PENDING, OK, FAILED, or DELETING.
  
  type string
  
  Human-readable label that identifies the resource type associated with this private endpoint.
  
  Value is DATA_LAKE. Default value is DATA_LAKE.
- 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}/privateNetworkSettings/endpointIds

atlas api listDataFederationPrivateEndpoints --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ListDataFederationPrivateEndpointsApiParams{}
	sdkResp, httpResp, err := client.DataFederationApi.
		ListDataFederationPrivateEndpointsWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true"

Response examples (200)

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "azureLinkId": "string",
      "comment": "string",
      "customerEndpointDNSName": "string",
      "customerEndpointIPAddress": "string",
      "endpointId": "vpce-3bf78b0ddee411ba1",
      "errorMessage": "string",
      "provider": "AWS",
      "region": "US_EAST_1",
      "status": "PENDING",
      "type": "DATA_LAKE"
    }
  ],
  "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 Federated Database Instance and Online Archive Private Endpoint in One Project

GET /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}

Service accounts Digest auth

Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles.

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

Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.

Format should match the following pattern: ^vpce-[0-9a-f]{17}$.

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
- azureLinkId string
  
  Link ID that identifies the Azure private endpoint connection.
- comment string
  
  Human-readable string to associate with this private endpoint.
- customerEndpointDNSName string
  
  Human-readable label to identify customer's VPC endpoint DNS name. If defined, you must also specify a value for region.
- customerEndpointIPAddress string
  
  IP address used to connect to the Azure private endpoint.
  
  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}$.
- endpointId string Required
  
  Unique 22-character alphanumeric string that identifies the private endpoint.
  
  Format should match the following pattern: ^vpce-[0-9a-f]{17}$.
  
  Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature
- errorMessage string
  
  Error message describing a failure approving the private endpoint request.
- provider string
  
  Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only.
  
  Value is AWS. Default value is AWS.
- region string
  
  Human-readable label to identify the region of customer's VPC endpoint. If defined, you must also specify a value for customerEndpointDNSName.
- status string
  
  Status of the private endpoint connection request.
  
  Values are PENDING, OK, FAILED, or DELETING.
- type string
  
  Human-readable label that identifies the resource type associated with this private endpoint.
  
  Value is DATA_LAKE. Default value is DATA_LAKE.
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}/privateNetworkSettings/endpointIds/{endpointId}

atlas api getDataFederationPrivateEndpoint --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.GetDataFederationPrivateEndpointApiParams{}
	sdkResp, httpResp, err := client.DataFederationApi.
		GetDataFederationPrivateEndpointWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true"

Response examples (200)

{
  "azureLinkId": "string",
  "comment": "string",
  "customerEndpointDNSName": "string",
  "customerEndpointIPAddress": "string",
  "endpointId": "vpce-3bf78b0ddee411ba1",
  "errorMessage": "string",
  "provider": "AWS",
  "region": "US_EAST_1",
  "status": "PENDING",
  "type": "DATA_LAKE"
}

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

Pause One Data Lake Pipeline Deprecated

POST /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause

Service accounts Digest auth

Pauses ingestion for a Data Lake Pipeline within 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})$.
pipelineName string Required

Human-readable label that identifies the Data Lake Pipeline.

Format should match the following pattern: ^[^/\\ "$]{1,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.
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 Data Lake Pipeline.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- createdDate string(date-time)
  
  Timestamp that indicates when the Data Lake Pipeline was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- datasetRetentionPolicy object
  
  Dataset Retention Policy for a Scheduled Data Lake Pipeline.
  
  Hide datasetRetentionPolicy attributes Show datasetRetentionPolicy attributes object
  
  lastModifiedDate string(date-time)
  
  Date when retention policy was last modified. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  units string Required
  
  Quantity of time in which the Data Lake Pipeline measures dataset retention.
  
  Values are DAYS, WEEKS, or MONTHS.
  
  value integer(int32) Required
  
  Number that indicates the amount of days, weeks, or months that the Data Lake Pipeline will retain datasets.
  
  Minimum value is 1.
- groupId string
  
  Unique 24-hexadecimal digit string that identifies the group.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- lastUpdatedDate string(date-time)
  
  Timestamp that indicates the last time that the Data Lake Pipeline was updated. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- name string
  
  Name of this Data Lake Pipeline.
- sink object
  
  Atlas Data Lake Storage as the destination for a Data Lake Pipeline.
  
  Hide sink attributes Show sink attributes object
  
  type string Discriminator
  
  Type of ingestion destination of this Data Lake Pipeline.
  
  Value is DLS.
  
  metadataProvider string
  
  Target cloud provider for this Data Lake Pipeline.
  
  Value is AWS.
  
  metadataRegion string
  
  Target cloud provider region for this Data Lake Pipeline.
  
  Supported cloud provider regions
  
  partitionFields array[object]
  
  Ordered fields used to physically organize data in the destination.
  
  Partition Field in the Data Lake Storage provider for a Data Lake Pipeline.
  
  Hide partitionFields attributes Show partitionFields attributes object
  
  fieldName string Required
  
  Human-readable label that identifies the field name used to partition data.
  
  Maximum length is 700.
  
  order integer(int32) Required
  
  Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero.
  
  Default value is 0.
- source object
  
  One of:
  OnDemandCpsSnapshotSource object PeriodicCpsSnapshotSource object
  
  On-Demand Cloud Provider Snapshots as Source for a Data Lake Pipeline.
  
  Hide attributes Show attributes
  
  type string Discriminator
  
  Type of ingestion source of this Data Lake Pipeline.
  
  Value is ON_DEMAND_CPS.
  
  clusterName string
  
  Human-readable name that identifies the cluster.
  
  collectionName string
  
  Human-readable name that identifies the collection.
  
  databaseName string
  
  Human-readable name that identifies the database.
  
  groupId string
  
  Unique 24-hexadecimal character string that identifies the project.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  Scheduled Cloud Provider Snapshot as Source for a Data Lake Pipeline.
  
  Hide attributes Show attributes
  
  type string Discriminator
  
  Type of ingestion source of this Data Lake Pipeline.
  
  Value is PERIODIC_CPS.
  
  clusterName string
  
  Human-readable name that identifies the cluster.
  
  collectionName string
  
  Human-readable name that identifies the collection.
  
  databaseName string
  
  Human-readable name that identifies the database.
  
  groupId string
  
  Unique 24-hexadecimal character string that identifies the project.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  policyItemId string
  
  Unique 24-hexadecimal character string that identifies a policy item.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- state string
  
  State of this Data Lake Pipeline.
  
  Values are ACTIVE or PAUSED.
- transformations array[object]
  
  Fields to be excluded for this Data Lake Pipeline.
  
  Field Transformations during ingestion of a Data Lake Pipeline.
  
  Hide transformations attributes Show transformations attributes object
  
  field string
  
  Key in the document.
  
  type string
  
  Type of transformation applied during the export of the namespace in a Data Lake Pipeline.
  
  Value is EXCLUDE.
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/groups/{groupId}/pipelines/{pipelineName}/pause

atlas api pausePipeline --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.PausePipelineApiParams{}
	sdkResp, httpResp, err := client.DataLakePipelinesApi.
		PausePipelineWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \
  -d '{ <Payload> }'

Response examples (200)

{
  "_id": "32b6e34b3d91647abb20e7b8",
  "createdDate": "2025-05-04T09:42:00Z",
  "datasetRetentionPolicy": {
    "lastModifiedDate": "2025-05-04T09:42:00Z",
    "units": "DAYS",
    "value": 42
  },
  "groupId": "32b6e34b3d91647abb20e7b8",
  "lastUpdatedDate": "2025-05-04T09:42:00Z",
  "name": "string",
  "sink": {
    "type": "DLS",
    "metadataProvider": "AWS",
    "metadataRegion": "string",
    "partitionFields": [
      {
        "fieldName": "string",
        "order": 0
      }
    ]
  },
  "source": {
    "type": "PERIODIC_CPS",
    "clusterName": "string",
    "collectionName": "string",
    "databaseName": "string",
    "groupId": "32b6e34b3d91647abb20e7b8"
  },
  "state": "ACTIVE",
  "transformations": [
    {
      "field": "string",
      "type": "EXCLUDE"
    }
  ]
}

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

atlas api listConnectedOrgConfigs --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ListConnectedOrgConfigsApiParams{}
	sdkResp, httpResp, err := client.FederatedAuthenticationApi.
		ListConnectedOrgConfigsWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true"

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 All Restore Jobs for One Flex Cluster

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

Service accounts Digest auth

Returns all restore jobs for one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner 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.
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.2024-11-13+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.
  
  Details for one restore job of a flex cluster.
  
  Hide results attributes Show results 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})$.
- 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}/flexClusters/{name}/backup/restoreJobs

atlas api listFlexBackupRestoreJobs --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ListFlexBackupRestoreJobsApiParams{}
	sdkResp, httpResp, err := client.FlexRestoreJobsApi.
		ListFlexBackupRestoreJobsWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs?pretty=true"

Response examples (200)

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "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"
    }
  ],
  "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 Pending Invoices for One Organization

GET /api/atlas/v2/orgs/{orgId}/invoices/pending

Service accounts Digest auth

Returns all invoices accruing charges for the current billing cycle for the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role.

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
- 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
  
  amountBilledCents integer(int64)
  
  Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).
  
  amountPaidCents integer(int64)
  
  Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).
  
  created string(date-time)
  
  Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  creditsCents integer(int64)
  
  Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).
  
  endDate string(date-time)
  
  Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  id string
  
  Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  lineItems array[object]
  
  List that contains individual services included in this invoice.
  
  One service included in this invoice.
  
  Hide lineItems attributes Show lineItems attributes object
  
  clusterName string
  
  Human-readable label that identifies the cluster that incurred the charge.
  
  Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
  
  created string(date-time)
  
  Date and time when MongoDB Cloud created this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  discountCents integer(int64)
  
  Sum by which MongoDB discounted this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar). The resource returns this parameter when a discount applies.
  
  endDate string(date-time)
  
  Date and time when when MongoDB Cloud finished charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  groupId string
  
  Unique 24-hexadecimal digit string that identifies the project associated to this line item.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  groupName string
  
  Human-readable label that identifies the project.
  
  note string
  
  Comment that applies to this line item.
  
  percentDiscount number(float)
  
  Percentage by which MongoDB discounted this line item. The resource returns this parameter when a discount applies.
  
  quantity number(double)
  
  Number of units included for the line item. These can be expressions of storage (GB), time (hours), or other units.
  
  sku string
  
  Human-readable description of the service that this line item provided. This Stock Keeping Unit (SKU) could be the instance type, a support charge, advanced security, or another service.
  
  Values are CLASSIC_BACKUP_OPLOG, CLASSIC_BACKUP_STORAGE, CLASSIC_BACKUP_SNAPSHOT_CREATE, CLASSIC_BACKUP_DAILY_MINIMUM, CLASSIC_BACKUP_FREE_TIER, CLASSIC_COUPON, BACKUP_STORAGE_FREE_TIER, BACKUP_STORAGE, FLEX_CONSULTING, CLOUD_MANAGER_CLASSIC, CLOUD_MANAGER_BASIC_FREE_TIER, CLOUD_MANAGER_BASIC, CLOUD_MANAGER_PREMIUM, CLOUD_MANAGER_FREE_TIER, CLOUD_MANAGER_STANDARD_FREE_TIER, CLOUD_MANAGER_STANDARD_ANNUAL, CLOUD_MANAGER_STANDARD, CLOUD_MANAGER_FREE_TRIAL, ATLAS_INSTANCE_M0, ATLAS_INSTANCE_M2, ATLAS_INSTANCE_M5, ATLAS_AWS_INSTANCE_M10, ATLAS_AWS_INSTANCE_M20, ATLAS_AWS_INSTANCE_M30, ATLAS_AWS_INSTANCE_M40, ATLAS_AWS_INSTANCE_M50, ATLAS_AWS_INSTANCE_M60, ATLAS_AWS_INSTANCE_M80, ATLAS_AWS_INSTANCE_M100, ATLAS_AWS_INSTANCE_M140, ATLAS_AWS_INSTANCE_M200, ATLAS_AWS_INSTANCE_M300, ATLAS_AWS_INSTANCE_M40_LOW_CPU, ATLAS_AWS_INSTANCE_M50_LOW_CPU, ATLAS_AWS_INSTANCE_M60_LOW_CPU, ATLAS_AWS_INSTANCE_M80_LOW_CPU, ATLAS_AWS_INSTANCE_M200_LOW_CPU, ATLAS_AWS_INSTANCE_M300_LOW_CPU, ATLAS_AWS_INSTANCE_M400_LOW_CPU, ATLAS_AWS_INSTANCE_M700_LOW_CPU, ATLAS_AWS_INSTANCE_M40_NVME, ATLAS_AWS_INSTANCE_M50_NVME, ATLAS_AWS_INSTANCE_M60_NVME, ATLAS_AWS_INSTANCE_M80_NVME, ATLAS_AWS_INSTANCE_M200_NVME, ATLAS_AWS_INSTANCE_M400_NVME, ATLAS_AWS_INSTANCE_M10_PAUSED, ATLAS_AWS_INSTANCE_M20_PAUSED, ATLAS_AWS_INSTANCE_M30_PAUSED, ATLAS_AWS_INSTANCE_M40_PAUSED, ATLAS_AWS_INSTANCE_M50_PAUSED, ATLAS_AWS_INSTANCE_M60_PAUSED, ATLAS_AWS_INSTANCE_M80_PAUSED, ATLAS_AWS_INSTANCE_M100_PAUSED, ATLAS_AWS_INSTANCE_M140_PAUSED, ATLAS_AWS_INSTANCE_M200_PAUSED, ATLAS_AWS_INSTANCE_M300_PAUSED, ATLAS_AWS_INSTANCE_M40_LOW_CPU_PAUSED, ATLAS_AWS_INSTANCE_M50_LOW_CPU_PAUSED, ATLAS_AWS_INSTANCE_M60_LOW_CPU_PAUSED, ATLAS_AWS_INSTANCE_M80_LOW_CPU_PAUSED, ATLAS_AWS_INSTANCE_M200_LOW_CPU_PAUSED, ATLAS_AWS_INSTANCE_M300_LOW_CPU_PAUSED, ATLAS_AWS_INSTANCE_M400_LOW_CPU_PAUSED, ATLAS_AWS_INSTANCE_M700_LOW_CPU_PAUSED, ATLAS_AWS_SEARCH_INSTANCE_S20_COMPUTE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S30_COMPUTE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S40_COMPUTE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S50_COMPUTE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S60_COMPUTE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S70_COMPUTE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S80_COMPUTE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S30_MEMORY_NVME, ATLAS_AWS_SEARCH_INSTANCE_S40_MEMORY_NVME, ATLAS_AWS_SEARCH_INSTANCE_S50_MEMORY_NVME, ATLAS_AWS_SEARCH_INSTANCE_S60_MEMORY_NVME, ATLAS_AWS_SEARCH_INSTANCE_S80_MEMORY_NVME, ATLAS_AWS_SEARCH_INSTANCE_S90_MEMORY_NVME, ATLAS_AWS_SEARCH_INSTANCE_S100_MEMORY_NVME, ATLAS_AWS_SEARCH_INSTANCE_S110_MEMORY_NVME, ATLAS_AWS_SEARCH_INSTANCE_S40_STORAGE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S50_STORAGE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S60_STORAGE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S80_STORAGE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S90_STORAGE_NVME, ATLAS_AWS_STORAGE_PROVISIONED, ATLAS_AWS_STORAGE_STANDARD, ATLAS_AWS_STORAGE_STANDARD_GP3, ATLAS_AWS_STORAGE_IOPS, ATLAS_AWS_DATA_TRANSFER_SAME_REGION, ATLAS_AWS_DATA_TRANSFER_DIFFERENT_REGION, ATLAS_AWS_DATA_TRANSFER_INTERNET, ATLAS_AWS_BACKUP_SNAPSHOT_STORAGE, ATLAS_AWS_BACKUP_DOWNLOAD_VM, ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE, ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE_IOPS, ATLAS_AWS_PRIVATE_ENDPOINT, ATLAS_AWS_PRIVATE_ENDPOINT_CAPACITY_UNITS, ATLAS_GCP_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S30_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S70_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S120_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S140_MEMORY_LOCALSSD, ATLAS_GCP_INSTANCE_M10, ATLAS_GCP_INSTANCE_M20, ATLAS_GCP_INSTANCE_M30, ATLAS_GCP_INSTANCE_M40, ATLAS_GCP_INSTANCE_M50, ATLAS_GCP_INSTANCE_M60, ATLAS_GCP_INSTANCE_M80, ATLAS_GCP_INSTANCE_M140, ATLAS_GCP_INSTANCE_M200, ATLAS_GCP_INSTANCE_M250, ATLAS_GCP_INSTANCE_M300, ATLAS_GCP_INSTANCE_M400, ATLAS_GCP_INSTANCE_M40_LOW_CPU, ATLAS_GCP_INSTANCE_M50_LOW_CPU, ATLAS_GCP_INSTANCE_M60_LOW_CPU, ATLAS_GCP_INSTANCE_M80_LOW_CPU, ATLAS_GCP_INSTANCE_M200_LOW_CPU, ATLAS_GCP_INSTANCE_M300_LOW_CPU, ATLAS_GCP_INSTANCE_M400_LOW_CPU, ATLAS_GCP_INSTANCE_M600_LOW_CPU, ATLAS_GCP_INSTANCE_M10_PAUSED, ATLAS_GCP_INSTANCE_M20_PAUSED, ATLAS_GCP_INSTANCE_M30_PAUSED, ATLAS_GCP_INSTANCE_M40_PAUSED, ATLAS_GCP_INSTANCE_M50_PAUSED, ATLAS_GCP_INSTANCE_M60_PAUSED, ATLAS_GCP_INSTANCE_M80_PAUSED, ATLAS_GCP_INSTANCE_M140_PAUSED, ATLAS_GCP_INSTANCE_M200_PAUSED, ATLAS_GCP_INSTANCE_M250_PAUSED, ATLAS_GCP_INSTANCE_M300_PAUSED, ATLAS_GCP_INSTANCE_M400_PAUSED, ATLAS_GCP_INSTANCE_M40_LOW_CPU_PAUSED, ATLAS_GCP_INSTANCE_M50_LOW_CPU_PAUSED, ATLAS_GCP_INSTANCE_M60_LOW_CPU_PAUSED, ATLAS_GCP_INSTANCE_M80_LOW_CPU_PAUSED, ATLAS_GCP_INSTANCE_M200_LOW_CPU_PAUSED, ATLAS_GCP_INSTANCE_M300_LOW_CPU_PAUSED, ATLAS_GCP_INSTANCE_M400_LOW_CPU_PAUSED, ATLAS_GCP_INSTANCE_M600_LOW_CPU_PAUSED, ATLAS_GCP_DATA_TRANSFER_INTERNET, ATLAS_GCP_STORAGE_SSD, ATLAS_GCP_DATA_TRANSFER_INTER_CONNECT, ATLAS_GCP_DATA_TRANSFER_INTER_ZONE, ATLAS_GCP_DATA_TRANSFER_INTER_REGION, ATLAS_GCP_DATA_TRANSFER_GOOGLE, ATLAS_GCP_BACKUP_SNAPSHOT_STORAGE, ATLAS_GCP_BACKUP_DOWNLOAD_VM, ATLAS_GCP_BACKUP_DOWNLOAD_VM_STORAGE, ATLAS_GCP_PRIVATE_ENDPOINT, ATLAS_GCP_PRIVATE_ENDPOINT_CAPACITY_UNITS, ATLAS_GCP_SNAPSHOT_COPY_DATA_TRANSFER, ATLAS_AZURE_INSTANCE_M10, ATLAS_AZURE_INSTANCE_M20, ATLAS_AZURE_INSTANCE_M30, ATLAS_AZURE_INSTANCE_M40, ATLAS_AZURE_INSTANCE_M50, ATLAS_AZURE_INSTANCE_M60, ATLAS_AZURE_INSTANCE_M80, ATLAS_AZURE_INSTANCE_M90, ATLAS_AZURE_INSTANCE_M200, ATLAS_AZURE_INSTANCE_R40, ATLAS_AZURE_INSTANCE_R50, ATLAS_AZURE_INSTANCE_R60, ATLAS_AZURE_INSTANCE_R80, ATLAS_AZURE_INSTANCE_R200, ATLAS_AZURE_INSTANCE_R300, ATLAS_AZURE_INSTANCE_R400, ATLAS_AZURE_INSTANCE_M60_NVME, ATLAS_AZURE_INSTANCE_M80_NVME, ATLAS_AZURE_INSTANCE_M200_NVME, ATLAS_AZURE_INSTANCE_M300_NVME, ATLAS_AZURE_INSTANCE_M400_NVME, ATLAS_AZURE_INSTANCE_M600_NVME, ATLAS_AZURE_INSTANCE_M10_PAUSED, ATLAS_AZURE_INSTANCE_M20_PAUSED, ATLAS_AZURE_INSTANCE_M30_PAUSED, ATLAS_AZURE_INSTANCE_M40_PAUSED, ATLAS_AZURE_INSTANCE_M50_PAUSED, ATLAS_AZURE_INSTANCE_M60_PAUSED, ATLAS_AZURE_INSTANCE_M80_PAUSED, ATLAS_AZURE_INSTANCE_M90_PAUSED, ATLAS_AZURE_INSTANCE_M200_PAUSED, ATLAS_AZURE_INSTANCE_R40_PAUSED, ATLAS_AZURE_INSTANCE_R50_PAUSED, ATLAS_AZURE_INSTANCE_R60_PAUSED, ATLAS_AZURE_INSTANCE_R80_PAUSED, ATLAS_AZURE_INSTANCE_R200_PAUSED, ATLAS_AZURE_INSTANCE_R300_PAUSED, ATLAS_AZURE_INSTANCE_R400_PAUSED, ATLAS_AZURE_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S135_MEMORY_LOCALSSD, ATLAS_AZURE_STORAGE_P2, ATLAS_AZURE_STORAGE_P3, ATLAS_AZURE_STORAGE_P4, ATLAS_AZURE_STORAGE_P6, ATLAS_AZURE_STORAGE_P10, ATLAS_AZURE_STORAGE_P15, ATLAS_AZURE_STORAGE_P20, ATLAS_AZURE_STORAGE_P30, ATLAS_AZURE_STORAGE_P40, ATLAS_AZURE_STORAGE_P50, ATLAS_AZURE_DATA_TRANSFER, ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_IN, ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_OUT, ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_IN, ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_OUT, ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_IN, ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_OUT, ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTRA_CONTINENT, ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTER_CONTINENT, ATLAS_AZURE_BACKUP_SNAPSHOT_STORAGE, ATLAS_AZURE_BACKUP_DOWNLOAD_VM, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P2, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P3, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P4, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P6, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P10, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P15, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P20, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P30, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P40, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P50, ATLAS_AZURE_STANDARD_STORAGE, ATLAS_AZURE_EXTENDED_STANDARD_IOPS, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_EXTENDED_IOPS, ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE, ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_EXTENDED_IOPS, ATLAS_BI_CONNECTOR, ATLAS_ADVANCED_SECURITY, ATLAS_ENTERPRISE_AUDITING, ATLAS_FREE_SUPPORT, ATLAS_SUPPORT, ATLAS_NDS_BACKFILL_SUPPORT, STITCH_DATA_DOWNLOADED_FREE_TIER, STITCH_DATA_DOWNLOADED, STITCH_COMPUTE_FREE_TIER, STITCH_COMPUTE, CREDIT, MINIMUM_CHARGE, CHARTS_DATA_DOWNLOADED_FREE_TIER, CHARTS_DATA_DOWNLOADED, ATLAS_DATA_LAKE_AWS_DATA_RETURNED_SAME_REGION, ATLAS_DATA_LAKE_AWS_DATA_RETURNED_DIFFERENT_REGION, ATLAS_DATA_LAKE_AWS_DATA_RETURNED_INTERNET, ATLAS_DATA_LAKE_AWS_DATA_SCANNED, ATLAS_DATA_LAKE_AWS_DATA_TRANSFERRED_FROM_DIFFERENT_REGION, ATLAS_NDS_AWS_DATA_LAKE_STORAGE_ACCESS, ATLAS_NDS_AWS_DATA_LAKE_STORAGE, ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_REGION, ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_CONTINENT, ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_DIFFERENT_CONTINENT, ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_INTERNET, ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_SAME_REGION, ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_DIFFERENT_REGION, ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_INTERNET, ATLAS_DATA_FEDERATION_AZURE_DATA_SCANNED, ATLAS_NDS_AZURE_DATA_LAKE_STORAGE_ACCESS, ATLAS_NDS_AZURE_DATA_LAKE_STORAGE, ATLAS_DATA_FEDERATION_GCP_DATA_SCANNED, ATLAS_NDS_GCP_DATA_LAKE_STORAGE_ACCESS, ATLAS_NDS_GCP_DATA_LAKE_STORAGE, ATLAS_NDS_AWS_OBJECT_STORAGE_ACCESS, ATLAS_NDS_AWS_COMPRESSED_OBJECT_STORAGE, ATLAS_NDS_AZURE_OBJECT_STORAGE_ACCESS, ATLAS_NDS_AZURE_OBJECT_STORAGE, ATLAS_NDS_AZURE_COMPRESSED_OBJECT_STORAGE, ATLAS_NDS_GCP_OBJECT_STORAGE_ACCESS, ATLAS_NDS_GCP_OBJECT_STORAGE, ATLAS_NDS_GCP_COMPRESSED_OBJECT_STORAGE, ATLAS_ARCHIVE_ACCESS_PARTITION_LOCATE, ATLAS_NDS_AWS_PIT_RESTORE_STORAGE_FREE_TIER, ATLAS_NDS_AWS_PIT_RESTORE_STORAGE, ATLAS_NDS_GCP_PIT_RESTORE_STORAGE_FREE_TIER, ATLAS_NDS_GCP_PIT_RESTORE_STORAGE, ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE_FREE_TIER, ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE, ATLAS_NDS_AZURE_PRIVATE_ENDPOINT_CAPACITY_UNITS, ATLAS_NDS_AZURE_CMK_PRIVATE_NETWORKING, ATLAS_NDS_AWS_CMK_PRIVATE_NETWORKING, ATLAS_NDS_AWS_OBJECT_STORAGE, ATLAS_NDS_AWS_SNAPSHOT_EXPORT_UPLOAD, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_UPLOAD, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M40, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M50, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M60, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P2, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P3, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P4, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P6, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P10, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P15, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P20, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P30, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P40, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P50, ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM, ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M40, ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M50, ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M60, ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE, ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE_IOPS, ATLAS_NDS_GCP_SNAPSHOT_EXPORT_UPLOAD, ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM, ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M40, ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M50, ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M60, ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_STORAGE, ATLAS_NDS_AWS_SERVERLESS_RPU, ATLAS_NDS_AWS_SERVERLESS_WPU, ATLAS_NDS_AWS_SERVERLESS_STORAGE, ATLAS_NDS_AWS_SERVERLESS_CONTINUOUS_BACKUP, ATLAS_NDS_AWS_SERVERLESS_BACKUP_RESTORE_VM, ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_PREVIEW, ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER, ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_REGIONAL, ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_CROSS_REGION, ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_INTERNET, ATLAS_NDS_GCP_SERVERLESS_RPU, ATLAS_NDS_GCP_SERVERLESS_WPU, ATLAS_NDS_GCP_SERVERLESS_STORAGE, ATLAS_NDS_GCP_SERVERLESS_CONTINUOUS_BACKUP, ATLAS_NDS_GCP_SERVERLESS_BACKUP_RESTORE_VM, ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_PREVIEW, ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER, ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_REGIONAL, ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_CROSS_REGION, ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_INTERNET, ATLAS_NDS_AZURE_SERVERLESS_RPU, ATLAS_NDS_AZURE_SERVERLESS_WPU, ATLAS_NDS_AZURE_SERVERLESS_STORAGE, ATLAS_NDS_AZURE_SERVERLESS_CONTINUOUS_BACKUP, ATLAS_NDS_AZURE_SERVERLESS_BACKUP_RESTORE_VM, ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_PREVIEW, ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER, ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_REGIONAL, ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_CROSS_REGION, ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_INTERNET, REALM_APP_REQUESTS_FREE_TIER, REALM_APP_REQUESTS, REALM_APP_COMPUTE_FREE_TIER, REALM_APP_COMPUTE, REALM_APP_SYNC_FREE_TIER, REALM_APP_SYNC, REALM_APP_DATA_TRANSFER_FREE_TIER, REALM_APP_DATA_TRANSFER, GCP_SNAPSHOT_COPY_DISK, ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP10, ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP30, ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP50, ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP10, ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP30, ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP50, ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER, ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER, ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING, ATLAS_AZURE_STREAM_PROCESSING_PRIVATELINK, ATLAS_AWS_STREAM_PROCESSING_PRIVATELINK, ATLAS_FLEX_AWS_100_USAGE_HOURS, ATLAS_FLEX_AWS_200_USAGE_HOURS, ATLAS_FLEX_AWS_300_USAGE_HOURS, ATLAS_FLEX_AWS_400_USAGE_HOURS, ATLAS_FLEX_AWS_500_USAGE_HOURS, ATLAS_FLEX_AZURE_100_USAGE_HOURS, ATLAS_FLEX_AZURE_200_USAGE_HOURS, ATLAS_FLEX_AZURE_300_USAGE_HOURS, ATLAS_FLEX_AZURE_400_USAGE_HOURS, ATLAS_FLEX_AZURE_500_USAGE_HOURS, ATLAS_FLEX_GCP_100_USAGE_HOURS, ATLAS_FLEX_GCP_200_USAGE_HOURS, ATLAS_FLEX_GCP_300_USAGE_HOURS, ATLAS_FLEX_GCP_400_USAGE_HOURS, ATLAS_FLEX_GCP_500_USAGE_HOURS, ATLAS_FLEX_AWS_LEGACY_100_USAGE_HOURS, ATLAS_FLEX_AWS_LEGACY_200_USAGE_HOURS, ATLAS_FLEX_AWS_LEGACY_300_USAGE_HOURS, ATLAS_FLEX_AWS_LEGACY_400_USAGE_HOURS, ATLAS_FLEX_AWS_LEGACY_500_USAGE_HOURS, ATLAS_FLEX_AZURE_LEGACY_100_USAGE_HOURS, ATLAS_FLEX_AZURE_LEGACY_200_USAGE_HOURS, ATLAS_FLEX_AZURE_LEGACY_300_USAGE_HOURS, ATLAS_FLEX_AZURE_LEGACY_400_USAGE_HOURS, ATLAS_FLEX_AZURE_LEGACY_500_USAGE_HOURS, ATLAS_FLEX_GCP_LEGACY_100_USAGE_HOURS, ATLAS_FLEX_GCP_LEGACY_200_USAGE_HOURS, ATLAS_FLEX_GCP_LEGACY_300_USAGE_HOURS, ATLAS_FLEX_GCP_LEGACY_400_USAGE_HOURS, or ATLAS_FLEX_GCP_LEGACY_500_USAGE_HOURS.
  
  startDate string(date-time)
  
  Date and time when MongoDB Cloud began charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  stitchAppName string
  
  Human-readable label that identifies the Atlas App Services application associated with this line item.
  
  Create a new Atlas App Service
  
  tags object
  
  A map of key-value pairs corresponding to the tags associated with the line item resource.
  
  Hide tags attribute Show tags attribute object
  
  * array[string] Additional properties
  
  A map of key-value pairs corresponding to the tags associated with the line item resource.
  
  tierLowerBound number(double)
  
  Lower bound for usage amount range in current SKU tier.
  
  NOTE: lineItems[n].tierLowerBound appears only if your lineItems[n].sku is tiered.
  
  tierUpperBound number(double)
  
  Upper bound for usage amount range in current SKU tier.
  
  NOTE: lineItems[n].tierUpperBound appears only if your lineItems[n].sku is tiered.
  
  totalPriceCents integer(int64)
  
  Sum of the cost set for this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar) and calculates this value as unitPriceDollars × quantity × 100.
  
  unit string
  
  Element used to express what quantity this line item measures. This value can be elements of time, storage capacity, and the like.
  
  unitPriceDollars number(double)
  
  Value per unit for this line item expressed in US Dollars.
  
  linkedInvoices array[object]
  
  List that contains the invoices for organizations linked to the paying organization.
  
  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 charged for services consumed from MongoDB Cloud.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  payments array[object]
  
  List that contains funds transferred to MongoDB to cover the specified service noted in this invoice.
  
  Funds transferred to MongoDB to cover the specified service in this invoice.
  
  Hide payments attributes Show payments attributes object
  
  amountBilledCents integer(int64)
  
  Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).
  
  amountPaidCents integer(int64)
  
  Sum that the specified organization paid toward the associated invoice. This parameter expresses its value in cents (100ths of one US Dollar).
  
  created string(date-time)
  
  Date and time when the customer made this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  currency string
  
  The currency in which payment was paid. This parameter expresses its value in 3-letter ISO 4217 currency code.
  
  id string
  
  Unique 24-hexadecimal digit string that identifies this payment toward the associated invoice.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  salesTaxCents integer(int64)
  
  Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).
  
  statusName string
  
  Phase of payment processing for the associated invoice when you made this request. These phases include:
  
  CANCELLED: Customer or MongoDB cancelled the payment.
  
  ERROR: Issue arose when attempting to complete payment.
  
  FAILED: MongoDB tried to charge the credit card without success.
  
  FAILED_AUTHENTICATION: Strong Customer Authentication has failed. Confirm that your payment method is authenticated.
  
  FORGIVEN: Customer initiated payment which MongoDB later forgave.
  
  INVOICED: MongoDB issued an invoice that included this line item.
  
  NEW: Customer provided a method of payment, but MongoDB hasn't tried to charge the credit card.
  
  PAID: Customer submitted a successful payment.
  
  PARTIAL_PAID: Customer paid for part of this line item.
  
  Values are NEW, FORGIVEN, FAILED, PAID, PARTIAL_PAID, CANCELLED, INVOICED, FAILED_AUTHENTICATION, PROCESSING, PENDING_REVERSAL, or REFUNDED.
  
  subtotalCents integer(int64)
  
  Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).
  
  unitPrice string
  
  The unit price applied to amountBilledCents to compute total payment amount. This value is represented as a decimal string.
  
  updated string(date-time)
  
  Date and time when the customer made an update to this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  refunds array[object]
  
  List that contains payments that MongoDB returned to the organization for this invoice.
  
  One payment that MongoDB returned to the organization for this invoice.
  
  Hide refunds attributes Show refunds attributes object
  
  amountCents integer(int64)
  
  Sum of the funds returned to the specified organization expressed in cents (100th of US Dollar).
  
  created string(date-time)
  
  Date and time when MongoDB Cloud created this refund. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  paymentId string
  
  Unique 24-hexadecimal digit string that identifies the payment that the organization had made.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  reason string
  
  Justification that MongoDB accepted to return funds to the organization.
  
  salesTaxCents integer(int64)
  
  Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).
  
  startDate string(date-time)
  
  Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  startingBalanceCents integer(int64)
  
  Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.
  
  statusName string
  
  Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:
  
  CLOSED: MongoDB finalized all charges in the billing cycle but has yet to charge the customer.
  
  FAILED: MongoDB attempted to charge the provided credit card but charge for that amount failed.
  
  FORGIVEN: Customer initiated payment which MongoDB later forgave.
  
  FREE: All charges totalled zero so the customer won't be charged.
  
  INVOICED: MongoDB handled these charges using elastic invoicing.
  
  PAID: MongoDB succeeded in charging the provided credit card.
  
  PENDING: Invoice includes charges for the current billing cycle.
  
  PREPAID: Customer has a pre-paid plan so they won't be charged.
  
  Values are PENDING, CLOSED, FORGIVEN, FAILED, PAID, FREE, PREPAID, or INVOICED.
  
  subtotalCents integer(int64)
  
  Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).
  
  updated string(date-time)
  
  Date and time when MongoDB Cloud last updated the value of this payment. 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.
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}/invoices/pending

atlas api listPendingInvoices --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ListPendingInvoicesApiParams{}
	sdkResp, httpResp, err := client.InvoicesApi.
		ListPendingInvoicesWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true"

Response examples (200)

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "amountBilledCents": 42,
      "amountPaidCents": 42,
      "created": "2025-05-04T09:42:00Z",
      "creditsCents": 42,
      "endDate": "2025-05-04T09:42:00Z",
      "id": "32b6e34b3d91647abb20e7b8",
      "lineItems": [
        {
          "clusterName": "string",
          "created": "2025-05-04T09:42:00Z",
          "discountCents": 42,
          "endDate": "2025-05-04T09:42:00Z",
          "groupId": "32b6e34b3d91647abb20e7b8",
          "groupName": "string",
          "note": "string",
          "percentDiscount": 42.0,
          "quantity": 42.0,
          "sku": "CLASSIC_BACKUP_OPLOG",
          "startDate": "2025-05-04T09:42:00Z",
          "stitchAppName": "string",
          "tags": {
            "additionalProperty1": [
              "string"
            ],
            "additionalProperty2": [
              "string"
            ]
          },
          "tierLowerBound": 42.0,
          "tierUpperBound": 42.0,
          "totalPriceCents": 42,
          "unit": "string",
          "unitPriceDollars": 42.0
        }
      ],
      "linkedInvoices": [
        {}
      ],
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "orgId": "32b6e34b3d91647abb20e7b8",
      "payments": [
        {
          "amountBilledCents": 42,
          "amountPaidCents": 42,
          "created": "2025-05-04T09:42:00Z",
          "currency": "string",
          "id": "32b6e34b3d91647abb20e7b8",
          "salesTaxCents": 42,
          "statusName": "NEW",
          "subtotalCents": 42,
          "unitPrice": "string",
          "updated": "2025-05-04T09:42:00Z"
        }
      ],
      "refunds": [
        {
          "amountCents": 42,
          "created": "2025-05-04T09:42:00Z",
          "paymentId": "32b6e34b3d91647abb20e7b8",
          "reason": "string"
        }
      ],
      "salesTaxCents": 42,
      "startDate": "2025-05-04T09:42:00Z",
      "startingBalanceCents": 42,
      "statusName": "PENDING",
      "subtotalCents": 42,
      "updated": "2025-05-04T09:42:00Z"
    }
  ],
  "totalCount": 42
}

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 LDAP or X.509 Configuration

PATCH /api/atlas/v2/groups/{groupId}/userSecurity

Service accounts Digest auth

Edits the LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role.

Updating this configuration triggers a rolling restart of the database.

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 Required

Updates the LDAP configuration for the specified project.

customerX509 object

Settings to configure TLS Certificates for database users.
Hide customerX509 attribute Show customerX509 attribute object
- cas string
  
  Concatenated list of customer certificate authority (CA) certificates needed to authenticate database users. MongoDB Cloud expects this as a PEM-formatted certificate.
ldap object

Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details that apply to the specified project.
Hide ldap attributes Show ldap attributes object
- authenticationEnabled boolean
  
  Flag that indicates whether users can authenticate using an Lightweight Directory Access Protocol (LDAP) host.
- authorizationEnabled boolean
  
  Flag that indicates whether users can authorize access to MongoDB Cloud resources using an Lightweight Directory Access Protocol (LDAP) host.
- authzQueryTemplate string
  
  Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user. MongoDB Cloud uses this parameter only for user authorization. Use the {USER} placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query according to RFC 4515 and RFC 4516.
  
  Default value is {USER}?memberOf?base.
- bindPassword string
  
  Password that MongoDB Cloud uses to authenticate the bindUsername.
- bindUsername string
  
  Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.
  
  Format should match the following pattern: ^(?:(?<cn>CN=(?<name>[^,]*)),)?(?:(?<path>(?:(?:CN|OU)=[^,]+,?)+),)?(?<domain>(?:DC=[^,]+,?)+)$.
  
  RFC 2253
- caCertificate string
  
  Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: "caCertificate": "".
- hostname string
  
  Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.
  
  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]+)?$.
- port integer(int32)
  
  Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections.
  
  Default value is 636.
- userToDNMapping array[object]
  
  User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.
  
  User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.
  Hide userToDNMapping attributes Show userToDNMapping attributes object
  
  ldapQuery string
  
  Lightweight Directory Access Protocol (LDAP) query template that inserts the LDAP name that the regular expression matches into an LDAP query Uniform Resource Identifier (URI). The formatting for the query must conform to RFC 4515 and RFC 4516.
  
  match string Required
  
  Regular expression that MongoDB Cloud uses to match against the provided Lightweight Directory Access Protocol (LDAP) username. Each parenthesis-enclosed section represents a regular expression capture group that the substitution or ldapQuery template uses.
  
  substitution string
  
  Lightweight Directory Access Protocol (LDAP) Distinguished Name (DN) template that converts the LDAP username that matches regular expression in the match parameter into an LDAP Distinguished Name (DN).

Responses

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

Accepted
Hide response attributes Show response attributes object
- customerX509 object
  
  Settings to configure TLS Certificates for database users.
  
  Hide customerX509 attributes Show customerX509 attributes object
  
  cas string
  
  Concatenated list of customer certificate authority (CA) certificates needed to authenticate database users. MongoDB Cloud expects this as a PEM-formatted certificate.
  
  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.
- ldap object
  
  Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details that apply to the specified project.
  
  Hide ldap attributes Show ldap attributes object
  
  authenticationEnabled boolean
  
  Flag that indicates whether users can authenticate using an Lightweight Directory Access Protocol (LDAP) host.
  
  authorizationEnabled boolean
  
  Flag that indicates whether users can authorize access to MongoDB Cloud resources using an Lightweight Directory Access Protocol (LDAP) host.
  
  authzQueryTemplate string
  
  Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user. MongoDB Cloud uses this parameter only for user authorization. Use the {USER} placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query according to RFC 4515 and RFC 4516.
  
  Default value is {USER}?memberOf?base.
  
  bindUsername string
  
  Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.
  
  Format should match the following pattern: ^(?:(?<cn>CN=(?<name>[^,]*)),)?(?:(?<path>(?:(?:CN|OU)=[^,]+,?)+),)?(?<domain>(?:DC=[^,]+,?)+)$.
  
  RFC 2253
  
  caCertificate string
  
  Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: "caCertificate": "".
  
  hostname string
  
  Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.
  
  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]+)?$.
  
  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.
  
  port integer(int32)
  
  Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections.
  
  Default value is 636.
  
  userToDNMapping array[object]
  
  User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.
  
  User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.
  
  Hide userToDNMapping attributes Show userToDNMapping attributes object
  
  ldapQuery string
  
  Lightweight Directory Access Protocol (LDAP) query template that inserts the LDAP name that the regular expression matches into an LDAP query Uniform Resource Identifier (URI). The formatting for the query must conform to RFC 4515 and RFC 4516.
  
  match string Required
  
  Regular expression that MongoDB Cloud uses to match against the provided Lightweight Directory Access Protocol (LDAP) username. Each parenthesis-enclosed section represents a regular expression capture group that the substitution or ldapQuery template uses.
  
  substitution string
  
  Lightweight Directory Access Protocol (LDAP) Distinguished Name (DN) template that converts the LDAP username that matches regular expression in the match parameter into an LDAP Distinguished Name (DN).
- 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.
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}/userSecurity

atlas api saveLdapConfiguration --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.SaveLdapConfigurationApiParams{}
	sdkResp, httpResp, err := client.LDAPConfigurationApi.
		SaveLdapConfigurationWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity" \
  -d '{ <Payload> }'

Request examples

{
  "customerX509": {
    "cas": "string"
  },
  "ldap": {
    "authenticationEnabled": true,
    "authorizationEnabled": true,
    "authzQueryTemplate": "{USER}?memberOf?base",
    "bindPassword": "string",
    "bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
    "caCertificate": "string",
    "hostname": "string",
    "port": 636,
    "userToDNMapping": [
      {
        "ldapQuery": "string",
        "match": "(.*)",
        "substitution": "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com"
      }
    ]
  }
}

Response examples (202)

{
  "customerX509": {
    "cas": "string",
    "links": [
      {
        "href": "https://cloud.mongodb.com/api/atlas",
        "rel": "self"
      }
    ]
  },
  "ldap": {
    "authenticationEnabled": true,
    "authorizationEnabled": true,
    "authzQueryTemplate": "{USER}?memberOf?base",
    "bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
    "caCertificate": "string",
    "hostname": "string",
    "links": [
      {
        "href": "https://cloud.mongodb.com/api/atlas",
        "rel": "self"
      }
    ],
    "port": 636,
    "userToDNMapping": [
      {
        "ldapQuery": "string",
        "match": "(.*)",
        "substitution": "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com"
      }
    ]
  },
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ]
}

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

Verify LDAP Configuration in One Project

POST /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify

Service accounts Digest auth

Verifies the LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner 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})$.

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 Required

The LDAP configuration for the specified project that you want to verify.

authzQueryTemplate string

Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud applies to create an LDAP query to return the LDAP groups associated with the authenticated MongoDB user. MongoDB Cloud uses this parameter only for user authorization.

Use the {USER} placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query per RFC 4515 and RFC 4516.

Default value is {USER}?memberOf?base.
bindPassword string Required

Password that MongoDB Cloud uses to authenticate the bindUsername.
bindUsername string Required

Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.

Format should match the following pattern: ^(?:(?<cn>CN=(?<name>[^,]*)),)?(?:(?<path>(?:(?:CN|OU)=[^,]+,?)+),)?(?<domain>(?:DC=[^,]+,?)+)$.

RFC 2253
caCertificate string

Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: "caCertificate": "".
hostname string Required

Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.

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]+)?$.
port integer(int32) Required

IANA port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections.

Default value is 636.

Responses

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

OK
Hide response attributes Show response attributes object
- groupId string
  
  Unique 24-hexadecimal digit string that identifies the project associated with this Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.
  
  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.
- request object
  
  Request information needed to verify an Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration. The response does not return the bindPassword.
  
  Hide request attributes Show request attributes object
  
  bindUsername string Required
  
  Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.
  
  Format should match the following pattern: ^(?:(?<cn>CN=(?<name>[^,]*)),)?(?:(?<path>(?:(?:CN|OU)=[^,]+,?)+),)?(?<domain>(?:DC=[^,]+,?)+)$.
  
  RFC 2253
  
  caCertificate string
  
  Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: "caCertificate": "".
  
  hostname string Required
  
  Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.
  
  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]+)?$.
  
  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.
  
  port integer(int32) Required
  
  IANA port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections.
  
  Default value is 636.
- requestId string
  
  Unique 24-hexadecimal digit string that identifies this request to verify an Lightweight Directory Access Protocol (LDAP) configuration.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- status string
  
  Human-readable string that indicates the status of the Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.
  
  Values are FAIL, PENDING, or SUCCESS.
- validations array[object]
  
  List that contains the validation messages related to the verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details. The list contains a document for each test that MongoDB Cloud runs. MongoDB Cloud stops running tests after the first failure.
  
  One test that MongoDB Cloud runs to test verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details.
  
  Hide validations attributes Show validations attributes object
  
  status string
  
  Human-readable string that indicates the result of this verification test.
  
  Values are FAIL or OK.
  
  validationType string
  
  Human-readable label that identifies this verification test that MongoDB Cloud runs.
  
  Values are AUTHENTICATE, AUTHORIZATION_ENABLED, CONNECT, PARSE_AUTHZ_QUERY, QUERY_SERVER, SERVER_SPECIFIED, or TEMPLATE.
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/groups/{groupId}/userSecurity/ldap/verify

atlas api verifyLdapConfiguration --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.VerifyLdapConfigurationApiParams{}
	sdkResp, httpResp, err := client.LDAPConfigurationApi.
		VerifyLdapConfigurationWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \
  -d '{ <Payload> }'

Request examples

{
  "authzQueryTemplate": "{USER}?memberOf?base",
  "bindPassword": "string",
  "bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
  "caCertificate": "string",
  "hostname": "string",
  "port": 636
}

Response examples (200)

{
  "groupId": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "request": {
    "bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
    "caCertificate": "string",
    "hostname": "string",
    "links": [
      {
        "href": "https://cloud.mongodb.com/api/atlas",
        "rel": "self"
      }
    ],
    "port": 636
  },
  "requestId": "32b6e34b3d91647abb20e7b8",
  "status": "FAIL",
  "validations": [
    {
      "status": "FAIL",
      "validationType": "AUTHENTICATE"
    }
  ]
}

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 Legacy Backup Snapshot Deprecated

GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}

Service accounts Digest auth

Returns one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation.

Cloud Backup Documentation

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

Unique 24-hexadecimal digit string that identifies the desired snapshot.

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
- clusterId string
  
  Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- clusterName string
  
  Human-readable label that identifies the cluster.
- complete boolean
  
  Flag that indicates whether the snapshot exists. This flag returns false while MongoDB Cloud creates the snapshot.
- created object
  
  BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.
  
  Hide created attributes Show created attributes object
  
  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.
  
  increment integer(int32)
  
  Order of the database operation that the oplog recorded at specific date and time.
  
  Minimum value is 1199145600.
- doNotDelete boolean
  
  Flag that indicates whether someone can delete this snapshot. You can't set "doNotDelete" : true and set a timestamp for expires in the same request.
- expires string(date-time)
  
  Date and time when MongoDB Cloud deletes the snapshot. If "doNotDelete" : true, MongoDB Cloud removes any value set for this parameter. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- groupId string
  
  Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- id string
  
  Unique 24-hexadecimal digit string that identifies the snapshot.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- incremental boolean
  
  Flag indicating if this is an incremental or a full snapshot.
- lastOplogAppliedTimestamp object
  
  BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.
  
  Hide lastOplogAppliedTimestamp attributes Show lastOplogAppliedTimestamp attributes object
  
  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.
  
  increment integer(int32)
  
  Order of the database operation that the oplog recorded at specific date and time.
  
  Minimum value is 1199145600.
- 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.
- parts array[object]
  
  Metadata that describes the complete snapshot.
  
  For a replica set, this array contains a single document.
  
  For a sharded cluster, this array contains one document for each shard plus one document for the config host.
  
  Characteristics that identify this snapshot.
  
  Hide parts attributes Show parts attributes object
  
  clusterId string
  
  Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  completedTime string(date-time)
  
  Date and time when the snapshot completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  compressionSetting string
  
  Human-readable label that identifies the method of compression for the snapshot.
  
  Values are NONE or GZIP.
  
  dataSizeBytes integer(int64)
  
  Total size of the data stored on each node in the cluster. This parameter expresses its value in bytes.
  
  encryptionEnabled boolean
  
  Flag that indicates whether someone encrypted this snapshot.
  
  fcv string
  
  Number that indicates the feature compatibility version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot.
  
  fileSizeBytes integer(int64)
  
  Number that indicates the total size of the data files in bytes.
  
  machineId string
  
  Hostname and port that indicate the node on which MongoDB Cloud created the snapshot.
  
  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})$.
  
  masterKeyUUID string(uuid)
  
  Unique string that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. The resource returns this parameter when "parts.encryptionEnabled" : true.
  
  mongodVersion string
  
  Number that indicates the version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot.
  
  Format should match the following pattern: ([\d]+\.[\d]+\.[\d]+).
  
  replicaSetName string
  
  Human-readable label that identifies the replica set.
  
  replicaState string
  
  The node's role at the time when snapshot process began.
  
  storageSizeBytes integer(int64)
  
  Number that indicates the total size of space allocated for document storage.
  
  typeName string
  
  Human-readable label that identifies the type of server from which MongoDB Cloud took this snapshot.
  
  Values are REPLICA_SET, CONFIG_SERVER, CONFIG_SERVER_REPLICA_SET, or CONFIG_SHARD_REPLICA_SET.
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}/clusters/{clusterName}/snapshots/{snapshotId}

atlas api getLegacySnapshot --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.GetLegacySnapshotApiParams{}
	sdkResp, httpResp, err := client.LegacyBackupApi.
		GetLegacySnapshotWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true"

Response examples (200)

{
  "clusterId": "32b6e34b3d91647abb20e7b8",
  "clusterName": "string",
  "complete": true,
  "created": {
    "date": "2025-05-04T09:42:00Z",
    "increment": 1199145600
  },
  "doNotDelete": true,
  "expires": "2025-05-04T09:42:00Z",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "incremental": true,
  "lastOplogAppliedTimestamp": {
    "date": "2025-05-04T09:42:00Z",
    "increment": 1199145600
  },
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "parts": [
    {
      "clusterId": "32b6e34b3d91647abb20e7b8",
      "completedTime": "2025-05-04T09:42:00Z",
      "compressionSetting": "NONE",
      "dataSizeBytes": 42,
      "encryptionEnabled": true,
      "fcv": "string",
      "fileSizeBytes": 42,
      "machineId": "string",
      "masterKeyUUID": "string",
      "mongodVersion": "string",
      "replicaSetName": "string",
      "replicaState": "string",
      "storageSizeBytes": 42,
      "typeName": "REPLICA_SET"
    }
  ]
}

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 Expiration Date for One Legacy Backup Snapshot Deprecated

PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}

Service accounts Digest auth

Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation.

Cloud Backup Documentation

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

Unique 24-hexadecimal digit string that identifies the desired snapshot.

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 Required

Changes One Legacy Backup Snapshot Expiration.

doNotDelete boolean

Flag that indicates whether someone can delete this snapshot. You can't set "doNotDelete" : true and set a timestamp for expires in the same request.
expires string(date-time)

Date and time when MongoDB Cloud deletes the snapshot. If "doNotDelete" : true, MongoDB Cloud removes any value set for this parameter. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

Responses

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

OK
Hide response attributes Show response attributes object
- clusterId string
  
  Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- clusterName string
  
  Human-readable label that identifies the cluster.
- complete boolean
  
  Flag that indicates whether the snapshot exists. This flag returns false while MongoDB Cloud creates the snapshot.
- created object
  
  BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.
  
  Hide created attributes Show created attributes object
  
  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.
  
  increment integer(int32)
  
  Order of the database operation that the oplog recorded at specific date and time.
  
  Minimum value is 1199145600.
- doNotDelete boolean
  
  Flag that indicates whether someone can delete this snapshot. You can't set "doNotDelete" : true and set a timestamp for expires in the same request.
- expires string(date-time)
  
  Date and time when MongoDB Cloud deletes the snapshot. If "doNotDelete" : true, MongoDB Cloud removes any value set for this parameter. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- groupId string
  
  Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- id string
  
  Unique 24-hexadecimal digit string that identifies the snapshot.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- incremental boolean
  
  Flag indicating if this is an incremental or a full snapshot.
- lastOplogAppliedTimestamp object
  
  BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.
  
  Hide lastOplogAppliedTimestamp attributes Show lastOplogAppliedTimestamp attributes object
  
  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.
  
  increment integer(int32)
  
  Order of the database operation that the oplog recorded at specific date and time.
  
  Minimum value is 1199145600.
- 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.
- parts array[object]
  
  Metadata that describes the complete snapshot.
  
  For a replica set, this array contains a single document.
  
  For a sharded cluster, this array contains one document for each shard plus one document for the config host.
  
  Characteristics that identify this snapshot.
  
  Hide parts attributes Show parts attributes object
  
  clusterId string
  
  Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  completedTime string(date-time)
  
  Date and time when the snapshot completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  compressionSetting string
  
  Human-readable label that identifies the method of compression for the snapshot.
  
  Values are NONE or GZIP.
  
  dataSizeBytes integer(int64)
  
  Total size of the data stored on each node in the cluster. This parameter expresses its value in bytes.
  
  encryptionEnabled boolean
  
  Flag that indicates whether someone encrypted this snapshot.
  
  fcv string
  
  Number that indicates the feature compatibility version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot.
  
  fileSizeBytes integer(int64)
  
  Number that indicates the total size of the data files in bytes.
  
  machineId string
  
  Hostname and port that indicate the node on which MongoDB Cloud created the snapshot.
  
  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})$.
  
  masterKeyUUID string(uuid)
  
  Unique string that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. The resource returns this parameter when "parts.encryptionEnabled" : true.
  
  mongodVersion string
  
  Number that indicates the version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot.
  
  Format should match the following pattern: ([\d]+\.[\d]+\.[\d]+).
  
  replicaSetName string
  
  Human-readable label that identifies the replica set.
  
  replicaState string
  
  The node's role at the time when snapshot process began.
  
  storageSizeBytes integer(int64)
  
  Number that indicates the total size of space allocated for document storage.
  
  typeName string
  
  Human-readable label that identifies the type of server from which MongoDB Cloud took this snapshot.
  
  Values are REPLICA_SET, CONFIG_SERVER, CONFIG_SERVER_REPLICA_SET, or CONFIG_SHARD_REPLICA_SET.
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}/snapshots/{snapshotId}

atlas api updateLegacySnapshotRetention --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.UpdateLegacySnapshotRetentionApiParams{}
	sdkResp, httpResp, err := client.LegacyBackupApi.
		UpdateLegacySnapshotRetentionWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \
  -d '{ <Payload> }'

Request examples

{
  "doNotDelete": true,
  "expires": "2025-05-04T09:42:00Z"
}

Response examples (200)

{
  "clusterId": "32b6e34b3d91647abb20e7b8",
  "clusterName": "string",
  "complete": true,
  "created": {
    "date": "2025-05-04T09:42:00Z",
    "increment": 1199145600
  },
  "doNotDelete": true,
  "expires": "2025-05-04T09:42:00Z",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "incremental": true,
  "lastOplogAppliedTimestamp": {
    "date": "2025-05-04T09:42:00Z",
    "increment": 1199145600
  },
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "parts": [
    {
      "clusterId": "32b6e34b3d91647abb20e7b8",
      "completedTime": "2025-05-04T09:42:00Z",
      "compressionSetting": "NONE",
      "dataSizeBytes": 42,
      "encryptionEnabled": true,
      "fcv": "string",
      "fileSizeBytes": 42,
      "machineId": "string",
      "masterKeyUUID": "string",
      "mongodVersion": "string",
      "replicaSetName": "string",
      "replicaState": "string",
      "storageSizeBytes": 42,
      "typeName": "REPLICA_SET"
    }
  ]
}

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 MongoDB Cloud Users Assigned to One Team

GET /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users

Service accounts Digest auth

Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role.

Note: This resource cannot be used to view details about users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint.

Note: To return both pending and active users, use v2-{2025-02-19} or later. If using a deprecated version, only active users will be returned. Deprecated versions: v2-{2023-01-01}

Manage Organization Teams

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 whose application users 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.
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
username string(email)

Email address to filter users by. Not supported in deprecated versions.
orgMembershipStatus string

Organization membership status to filter users by. If you exclude this parameter, this resource returns both pending and active users. Not supported in deprecated versions.

Responses

200 application/vnd.atlas.2025-02-19+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.
  
  One of:
  OrgPendingUserResponse object OrgActiveUserResponse 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})$.
- 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.
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/orgs/{orgId}/teams/{teamId}/users

atlas api listTeamUsers --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ListTeamUsersApiParams{}
	sdkResp, httpResp, err := client.MongoDBCloudUsersApi.
		ListTeamUsersWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true"

Response examples (200)

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "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"
    }
  ],
  "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 (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 Database for One MongoDB Process

GET /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}

Service accounts Digest auth

Returns one database running on 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

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

Human-readable label that identifies the database that the specified MongoDB process serves.
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.
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
- databaseName string
  
  Human-readable label that identifies the database that the specified MongoDB process serves.
- 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.
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}/databases/{databaseName}

atlas api getDatabase --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.GetDatabaseApiParams{}
	sdkResp, httpResp, err := client.MonitoringandLogsApi.
		GetDatabaseWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true"

Response examples (200)

{
  "databaseName": "string",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ]
}

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 Container

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

Service accounts Digest auth

Creates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting Service Account or API Key must have the Project Owner 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})$.

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 new network peering container in the specified project.

Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.

providerName string Discriminator

Cloud service provider that serves the requested network peering containers.

Value is AZURE.
atlasCidrBlock string Required
IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.

These CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the /24 and /21 ranges.

To modify the CIDR block, the target project cannot have:
- Any M10 or greater clusters
- Any other VPC peering connections
You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.

Example: A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of /24 equals 27 three-node replica sets.
Format should match the following pattern: ^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$.
region string Required

Azure region to which MongoDB Cloud deployed this network peering container.

Values are US_CENTRAL, US_EAST, US_EAST_2, US_EAST_2_EUAP, US_NORTH_CENTRAL, US_WEST, US_SOUTH_CENTRAL, EUROPE_NORTH, EUROPE_WEST, US_WEST_CENTRAL, US_WEST_2, US_WEST_3, CANADA_EAST, CANADA_CENTRAL, BRAZIL_SOUTH, BRAZIL_SOUTHEAST, AUSTRALIA_EAST, AUSTRALIA_SOUTH_EAST, AUSTRALIA_CENTRAL, AUSTRALIA_CENTRAL_2, UAE_NORTH, GERMANY_WEST_CENTRAL, GERMANY_NORTH, SWITZERLAND_NORTH, SWITZERLAND_WEST, SWEDEN_CENTRAL, SWEDEN_SOUTH, UK_SOUTH, UK_WEST, INDIA_CENTRAL, INDIA_WEST, INDIA_SOUTH, CHINA_EAST, CHINA_NORTH, ASIA_EAST, JAPAN_EAST, JAPAN_WEST, ASIA_SOUTH_EAST, KOREA_CENTRAL, KOREA_SOUTH, FRANCE_CENTRAL, FRANCE_SOUTH, SOUTH_AFRICA_NORTH, SOUTH_AFRICA_WEST, NORWAY_EAST, NORWAY_WEST, UAE_CENTRAL, QATAR_CENTRAL, POLAND_CENTRAL, ISRAEL_CENTRAL, ITALY_NORTH, SPAIN_CENTRAL, MEXICO_CENTRAL, or NEW_ZEALAND_NORTH.

Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.

providerName string Discriminator

Cloud service provider that serves the requested network peering containers.

Value is GCP.
atlasCidrBlock string Required
IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.

These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the /18 range.

To modify the CIDR block, the target project cannot have:
- Any M10 or greater clusters
- Any other VPC peering connections
You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.

Example: A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of /24 equals 27 three-node replica sets.
Format should match the following pattern: ^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$.
regions array[string]

List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.

Values are AFRICA_SOUTH_1, ASIA_EAST_2, ASIA_NORTHEAST_2, ASIA_NORTHEAST_3, ASIA_SOUTH_1, ASIA_SOUTH_2, ASIA_SOUTHEAST_2, AUSTRALIA_SOUTHEAST_1, AUSTRALIA_SOUTHEAST_2, CENTRAL_US, EASTERN_ASIA_PACIFIC, EASTERN_US, EUROPE_CENTRAL_2, EUROPE_NORTH_1, EUROPE_WEST_2, EUROPE_WEST_3, EUROPE_WEST_4, EUROPE_WEST_6, EUROPE_WEST_10, EUROPE_WEST_12, MIDDLE_EAST_CENTRAL_1, MIDDLE_EAST_CENTRAL_2, MIDDLE_EAST_WEST_1, NORTH_AMERICA_NORTHEAST_1, NORTH_AMERICA_NORTHEAST_2, NORTH_AMERICA_SOUTH_1, NORTHEASTERN_ASIA_PACIFIC, SOUTH_AMERICA_EAST_1, SOUTH_AMERICA_WEST_1, SOUTHEASTERN_ASIA_PACIFIC, US_EAST_4, US_EAST_5, US_WEST_2, US_WEST_3, US_WEST_4, US_SOUTH_1, WESTERN_EUROPE, or WESTERN_US.

Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.

providerName string Discriminator

Cloud service provider that serves the requested network peering containers.

Value is AWS.
atlasCidrBlock string
IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.

These CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the /24 and /21 ranges.

To modify the CIDR block, the target project cannot have:
- Any M10 or greater clusters
- Any other VPC peering connections
You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.

Example: A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of /24 equals 27 three-node replica sets.
Format should match the following pattern: ^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$.
regionName string Required

Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container.

Values are US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, CA_CENTRAL_1, EU_NORTH_1, EU_WEST_1, EU_WEST_2, EU_WEST_3, EU_CENTRAL_1, EU_CENTRAL_2, SA_EAST_1, AP_EAST_1, AP_SOUTHEAST_2, AP_SOUTHEAST_3, AP_SOUTHEAST_4, AP_NORTHEAST_1, AP_NORTHEAST_2, AP_NORTHEAST_3, AP_SOUTHEAST_1, AP_SOUTH_1, AP_SOUTH_2, CN_NORTH_1, CN_NORTHWEST_1, ME_CENTRAL_1, ME_SOUTH_1, AF_SOUTH_1, EU_SOUTH_1, EU_SOUTH_2, IL_CENTRAL_1, CA_WEST_1, AP_SOUTHEAST_5, AP_SOUTHEAST_7, MX_CENTRAL_1, GLOBAL, US_GOV_WEST_1, or US_GOV_EAST_1.

Responses

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

OK
One of:
AzureCloudProviderContainer object GCPCloudProviderContainer object AWSCloudProviderContainer object
Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.

Hide attributes Show attributes

id string

Unique 24-hexadecimal digit string that identifies the network peering container.

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

providerName string Discriminator

Cloud service provider that serves the requested network peering containers.

Value is AZURE.

provisioned boolean

Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container.

atlasCidrBlock string Required

IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.

These CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the /24 and /21 ranges.

To modify the CIDR block, the target project cannot have:

Any M10 or greater clusters

Any other VPC peering connections

You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.

Example: A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of /24 equals 27 three-node replica sets.

Format should match the following pattern: ^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$.

azureSubscriptionId string

Unique string that identifies the Azure subscription in which the MongoDB Cloud VNet resides.

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

region string Required

Azure region to which MongoDB Cloud deployed this network peering container.

Values are US_CENTRAL, US_EAST, US_EAST_2, US_EAST_2_EUAP, US_NORTH_CENTRAL, US_WEST, US_SOUTH_CENTRAL, EUROPE_NORTH, EUROPE_WEST, US_WEST_CENTRAL, US_WEST_2, US_WEST_3, CANADA_EAST, CANADA_CENTRAL, BRAZIL_SOUTH, BRAZIL_SOUTHEAST, AUSTRALIA_EAST, AUSTRALIA_SOUTH_EAST, AUSTRALIA_CENTRAL, AUSTRALIA_CENTRAL_2, UAE_NORTH, GERMANY_WEST_CENTRAL, GERMANY_NORTH, SWITZERLAND_NORTH, SWITZERLAND_WEST, SWEDEN_CENTRAL, SWEDEN_SOUTH, UK_SOUTH, UK_WEST, INDIA_CENTRAL, INDIA_WEST, INDIA_SOUTH, CHINA_EAST, CHINA_NORTH, ASIA_EAST, JAPAN_EAST, JAPAN_WEST, ASIA_SOUTH_EAST, KOREA_CENTRAL, KOREA_SOUTH, FRANCE_CENTRAL, FRANCE_SOUTH, SOUTH_AFRICA_NORTH, SOUTH_AFRICA_WEST, NORWAY_EAST, NORWAY_WEST, UAE_CENTRAL, QATAR_CENTRAL, POLAND_CENTRAL, ISRAEL_CENTRAL, ITALY_NORTH, SPAIN_CENTRAL, MEXICO_CENTRAL, or NEW_ZEALAND_NORTH.

vnetName string

Unique string that identifies the Azure VNet in which MongoDB Cloud clusters in this network peering container exist. The response returns null if no clusters exist in this network peering container.

Format should match the following pattern: ^([-\w._()])$.
Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.

Hide attributes Show attributes

id string

Unique 24-hexadecimal digit string that identifies the network peering container.

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

providerName string Discriminator

Cloud service provider that serves the requested network peering containers.

Value is GCP.

provisioned boolean

Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container.

atlasCidrBlock string Required

IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.

These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the /18 range.

To modify the CIDR block, the target project cannot have:

Any M10 or greater clusters

Any other VPC peering connections

You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.

Example: A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of /24 equals 27 three-node replica sets.

Format should match the following pattern: ^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$.

gcpProjectId string

Unique string that identifies the GCP project in which MongoDB Cloud clusters in this network peering container exist. The response returns null if no clusters exist in this network peering container.

Format should match the following pattern: ^p-[0-9a-z]{24}$.

networkName string

Human-readable label that identifies the network in which MongoDB Cloud clusters in this network peering container exist. MongoDB Cloud returns null if no clusters exist in this network peering container.

Format should match the following pattern: ^nt-[0-9a-f]{24}-[0-9a-z]{8}$.

regions array[string]

List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.

Values are AFRICA_SOUTH_1, ASIA_EAST_2, ASIA_NORTHEAST_2, ASIA_NORTHEAST_3, ASIA_SOUTH_1, ASIA_SOUTH_2, ASIA_SOUTHEAST_2, AUSTRALIA_SOUTHEAST_1, AUSTRALIA_SOUTHEAST_2, CENTRAL_US, EASTERN_ASIA_PACIFIC, EASTERN_US, EUROPE_CENTRAL_2, EUROPE_NORTH_1, EUROPE_WEST_2, EUROPE_WEST_3, EUROPE_WEST_4, EUROPE_WEST_6, EUROPE_WEST_10, EUROPE_WEST_12, MIDDLE_EAST_CENTRAL_1, MIDDLE_EAST_CENTRAL_2, MIDDLE_EAST_WEST_1, NORTH_AMERICA_NORTHEAST_1, NORTH_AMERICA_NORTHEAST_2, NORTH_AMERICA_SOUTH_1, NORTHEASTERN_ASIA_PACIFIC, SOUTH_AMERICA_EAST_1, SOUTH_AMERICA_WEST_1, SOUTHEASTERN_ASIA_PACIFIC, US_EAST_4, US_EAST_5, US_WEST_2, US_WEST_3, US_WEST_4, US_SOUTH_1, WESTERN_EUROPE, or WESTERN_US.
Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.

Hide attributes Show attributes

id string

Unique 24-hexadecimal digit string that identifies the network peering container.

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

providerName string Discriminator

Cloud service provider that serves the requested network peering containers.

Value is AWS.

provisioned boolean

Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container.

atlasCidrBlock string

IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.

These CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the /24 and /21 ranges.

To modify the CIDR block, the target project cannot have:

Any M10 or greater clusters

Any other VPC peering connections

You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.

Example: A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of /24 equals 27 three-node replica sets.

Format should match the following pattern: ^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$.

regionName string Required

Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container.

Values are US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, CA_CENTRAL_1, EU_NORTH_1, EU_WEST_1, EU_WEST_2, EU_WEST_3, EU_CENTRAL_1, EU_CENTRAL_2, SA_EAST_1, AP_EAST_1, AP_SOUTHEAST_2, AP_SOUTHEAST_3, AP_SOUTHEAST_4, AP_NORTHEAST_1, AP_NORTHEAST_2, AP_NORTHEAST_3, AP_SOUTHEAST_1, AP_SOUTH_1, AP_SOUTH_2, CN_NORTH_1, CN_NORTHWEST_1, ME_CENTRAL_1, ME_SOUTH_1, AF_SOUTH_1, EU_SOUTH_1, EU_SOUTH_2, IL_CENTRAL_1, CA_WEST_1, AP_SOUTHEAST_5, AP_SOUTHEAST_7, MX_CENTRAL_1, GLOBAL, US_GOV_WEST_1, or US_GOV_EAST_1.

vpcId string

Unique string that identifies the MongoDB Cloud VPC on AWS.

Format should match the following pattern: ^vpc-[0-9a-f]{17}$.
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}/containers

atlas api createPeeringContainer --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.CreatePeeringContainerApiParams{}
	sdkResp, httpResp, err := client.NetworkPeeringApi.
		CreatePeeringContainerWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers" \
  -d '{ <Payload> }'

Request examples

{
  "providerName": "AWS",
  "atlasCidrBlock": "string",
  "region": "US_CENTRAL"
}

{
  "providerName": "AWS",
  "atlasCidrBlock": "string",
  "regions": [
    "AFRICA_SOUTH_1"
  ]
}

{
  "providerName": "AWS",
  "atlasCidrBlock": "string",
  "regionName": "US_EAST_1"
}

Response examples (200)

{
  "id": "32b6e34b3d91647abb20e7b8",
  "providerName": "AWS",
  "provisioned": true,
  "atlasCidrBlock": "string",
  "azureSubscriptionId": "32b6e34b3d91647abb20e7b8",
  "region": "US_CENTRAL",
  "vnetName": "string"
}

{
  "id": "32b6e34b3d91647abb20e7b8",
  "providerName": "AWS",
  "provisioned": true,
  "atlasCidrBlock": "string",
  "gcpProjectId": "string",
  "networkName": "string",
  "regions": [
    "AFRICA_SOUTH_1"
  ]
}

{
  "id": "32b6e34b3d91647abb20e7b8",
  "providerName": "AWS",
  "provisioned": true,
  "atlasCidrBlock": "string",
  "regionName": "US_EAST_1",
  "vpcId": "vpc-b555d3b0d9cb783b0"
}

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

Update One Network Peering Container

PATCH /api/atlas/v2/groups/{groupId}/containers/{containerId}

Service accounts Digest auth

Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner 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})$.
containerId string Required

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.

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

Updates the network details and labels of one specified network peering container in the specified project.

Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.

providerName string Discriminator

Cloud service provider that serves the requested network peering containers.

Value is AZURE.
atlasCidrBlock string Required
IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.

These CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the /24 and /21 ranges.

To modify the CIDR block, the target project cannot have:
- Any M10 or greater clusters
- Any other VPC peering connections
You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.

Example: A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of /24 equals 27 three-node replica sets.
Format should match the following pattern: ^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$.
region string Required

Azure region to which MongoDB Cloud deployed this network peering container.

Values are US_CENTRAL, US_EAST, US_EAST_2, US_EAST_2_EUAP, US_NORTH_CENTRAL, US_WEST, US_SOUTH_CENTRAL, EUROPE_NORTH, EUROPE_WEST, US_WEST_CENTRAL, US_WEST_2, US_WEST_3, CANADA_EAST, CANADA_CENTRAL, BRAZIL_SOUTH, BRAZIL_SOUTHEAST, AUSTRALIA_EAST, AUSTRALIA_SOUTH_EAST, AUSTRALIA_CENTRAL, AUSTRALIA_CENTRAL_2, UAE_NORTH, GERMANY_WEST_CENTRAL, GERMANY_NORTH, SWITZERLAND_NORTH, SWITZERLAND_WEST, SWEDEN_CENTRAL, SWEDEN_SOUTH, UK_SOUTH, UK_WEST, INDIA_CENTRAL, INDIA_WEST, INDIA_SOUTH, CHINA_EAST, CHINA_NORTH, ASIA_EAST, JAPAN_EAST, JAPAN_WEST, ASIA_SOUTH_EAST, KOREA_CENTRAL, KOREA_SOUTH, FRANCE_CENTRAL, FRANCE_SOUTH, SOUTH_AFRICA_NORTH, SOUTH_AFRICA_WEST, NORWAY_EAST, NORWAY_WEST, UAE_CENTRAL, QATAR_CENTRAL, POLAND_CENTRAL, ISRAEL_CENTRAL, ITALY_NORTH, SPAIN_CENTRAL, MEXICO_CENTRAL, or NEW_ZEALAND_NORTH.

Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.

providerName string Discriminator

Cloud service provider that serves the requested network peering containers.

Value is GCP.
atlasCidrBlock string Required
IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.

These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the /18 range.

To modify the CIDR block, the target project cannot have:
- Any M10 or greater clusters
- Any other VPC peering connections
You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.

Example: A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of /24 equals 27 three-node replica sets.
Format should match the following pattern: ^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$.
regions array[string]

List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.

Values are AFRICA_SOUTH_1, ASIA_EAST_2, ASIA_NORTHEAST_2, ASIA_NORTHEAST_3, ASIA_SOUTH_1, ASIA_SOUTH_2, ASIA_SOUTHEAST_2, AUSTRALIA_SOUTHEAST_1, AUSTRALIA_SOUTHEAST_2, CENTRAL_US, EASTERN_ASIA_PACIFIC, EASTERN_US, EUROPE_CENTRAL_2, EUROPE_NORTH_1, EUROPE_WEST_2, EUROPE_WEST_3, EUROPE_WEST_4, EUROPE_WEST_6, EUROPE_WEST_10, EUROPE_WEST_12, MIDDLE_EAST_CENTRAL_1, MIDDLE_EAST_CENTRAL_2, MIDDLE_EAST_WEST_1, NORTH_AMERICA_NORTHEAST_1, NORTH_AMERICA_NORTHEAST_2, NORTH_AMERICA_SOUTH_1, NORTHEASTERN_ASIA_PACIFIC, SOUTH_AMERICA_EAST_1, SOUTH_AMERICA_WEST_1, SOUTHEASTERN_ASIA_PACIFIC, US_EAST_4, US_EAST_5, US_WEST_2, US_WEST_3, US_WEST_4, US_SOUTH_1, WESTERN_EUROPE, or WESTERN_US.

Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.

providerName string Discriminator

Cloud service provider that serves the requested network peering containers.

Value is AWS.
atlasCidrBlock string
IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.

These CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the /24 and /21 ranges.

To modify the CIDR block, the target project cannot have:
- Any M10 or greater clusters
- Any other VPC peering connections
You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.

Example: A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of /24 equals 27 three-node replica sets.
Format should match the following pattern: ^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$.
regionName string Required

Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container.

Values are US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, CA_CENTRAL_1, EU_NORTH_1, EU_WEST_1, EU_WEST_2, EU_WEST_3, EU_CENTRAL_1, EU_CENTRAL_2, SA_EAST_1, AP_EAST_1, AP_SOUTHEAST_2, AP_SOUTHEAST_3, AP_SOUTHEAST_4, AP_NORTHEAST_1, AP_NORTHEAST_2, AP_NORTHEAST_3, AP_SOUTHEAST_1, AP_SOUTH_1, AP_SOUTH_2, CN_NORTH_1, CN_NORTHWEST_1, ME_CENTRAL_1, ME_SOUTH_1, AF_SOUTH_1, EU_SOUTH_1, EU_SOUTH_2, IL_CENTRAL_1, CA_WEST_1, AP_SOUTHEAST_5, AP_SOUTHEAST_7, MX_CENTRAL_1, GLOBAL, US_GOV_WEST_1, or US_GOV_EAST_1.

Responses

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

OK
One of:
AzureCloudProviderContainer object GCPCloudProviderContainer object AWSCloudProviderContainer object
Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.

Hide attributes Show attributes

id string

Unique 24-hexadecimal digit string that identifies the network peering container.

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

providerName string Discriminator

Cloud service provider that serves the requested network peering containers.

Value is AZURE.

provisioned boolean

Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container.

atlasCidrBlock string Required

IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.

These CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the /24 and /21 ranges.

To modify the CIDR block, the target project cannot have:

Any M10 or greater clusters

Any other VPC peering connections

You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.

Example: A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of /24 equals 27 three-node replica sets.

Format should match the following pattern: ^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$.

azureSubscriptionId string

Unique string that identifies the Azure subscription in which the MongoDB Cloud VNet resides.

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

region string Required

Azure region to which MongoDB Cloud deployed this network peering container.

Values are US_CENTRAL, US_EAST, US_EAST_2, US_EAST_2_EUAP, US_NORTH_CENTRAL, US_WEST, US_SOUTH_CENTRAL, EUROPE_NORTH, EUROPE_WEST, US_WEST_CENTRAL, US_WEST_2, US_WEST_3, CANADA_EAST, CANADA_CENTRAL, BRAZIL_SOUTH, BRAZIL_SOUTHEAST, AUSTRALIA_EAST, AUSTRALIA_SOUTH_EAST, AUSTRALIA_CENTRAL, AUSTRALIA_CENTRAL_2, UAE_NORTH, GERMANY_WEST_CENTRAL, GERMANY_NORTH, SWITZERLAND_NORTH, SWITZERLAND_WEST, SWEDEN_CENTRAL, SWEDEN_SOUTH, UK_SOUTH, UK_WEST, INDIA_CENTRAL, INDIA_WEST, INDIA_SOUTH, CHINA_EAST, CHINA_NORTH, ASIA_EAST, JAPAN_EAST, JAPAN_WEST, ASIA_SOUTH_EAST, KOREA_CENTRAL, KOREA_SOUTH, FRANCE_CENTRAL, FRANCE_SOUTH, SOUTH_AFRICA_NORTH, SOUTH_AFRICA_WEST, NORWAY_EAST, NORWAY_WEST, UAE_CENTRAL, QATAR_CENTRAL, POLAND_CENTRAL, ISRAEL_CENTRAL, ITALY_NORTH, SPAIN_CENTRAL, MEXICO_CENTRAL, or NEW_ZEALAND_NORTH.

vnetName string

Unique string that identifies the Azure VNet in which MongoDB Cloud clusters in this network peering container exist. The response returns null if no clusters exist in this network peering container.

Format should match the following pattern: ^([-\w._()])$.
Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.

Hide attributes Show attributes

id string

Unique 24-hexadecimal digit string that identifies the network peering container.

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

providerName string Discriminator

Cloud service provider that serves the requested network peering containers.

Value is GCP.

provisioned boolean

Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container.

atlasCidrBlock string Required

IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.

These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the /18 range.

To modify the CIDR block, the target project cannot have:

Any M10 or greater clusters

Any other VPC peering connections

You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.

Example: A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of /24 equals 27 three-node replica sets.

Format should match the following pattern: ^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$.

gcpProjectId string

Unique string that identifies the GCP project in which MongoDB Cloud clusters in this network peering container exist. The response returns null if no clusters exist in this network peering container.

Format should match the following pattern: ^p-[0-9a-z]{24}$.

networkName string

Human-readable label that identifies the network in which MongoDB Cloud clusters in this network peering container exist. MongoDB Cloud returns null if no clusters exist in this network peering container.

Format should match the following pattern: ^nt-[0-9a-f]{24}-[0-9a-z]{8}$.

regions array[string]

List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.

Values are AFRICA_SOUTH_1, ASIA_EAST_2, ASIA_NORTHEAST_2, ASIA_NORTHEAST_3, ASIA_SOUTH_1, ASIA_SOUTH_2, ASIA_SOUTHEAST_2, AUSTRALIA_SOUTHEAST_1, AUSTRALIA_SOUTHEAST_2, CENTRAL_US, EASTERN_ASIA_PACIFIC, EASTERN_US, EUROPE_CENTRAL_2, EUROPE_NORTH_1, EUROPE_WEST_2, EUROPE_WEST_3, EUROPE_WEST_4, EUROPE_WEST_6, EUROPE_WEST_10, EUROPE_WEST_12, MIDDLE_EAST_CENTRAL_1, MIDDLE_EAST_CENTRAL_2, MIDDLE_EAST_WEST_1, NORTH_AMERICA_NORTHEAST_1, NORTH_AMERICA_NORTHEAST_2, NORTH_AMERICA_SOUTH_1, NORTHEASTERN_ASIA_PACIFIC, SOUTH_AMERICA_EAST_1, SOUTH_AMERICA_WEST_1, SOUTHEASTERN_ASIA_PACIFIC, US_EAST_4, US_EAST_5, US_WEST_2, US_WEST_3, US_WEST_4, US_SOUTH_1, WESTERN_EUROPE, or WESTERN_US.
Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.

Hide attributes Show attributes

id string

Unique 24-hexadecimal digit string that identifies the network peering container.

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

providerName string Discriminator

Cloud service provider that serves the requested network peering containers.

Value is AWS.

provisioned boolean

Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container.

atlasCidrBlock string

IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.

These CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the /24 and /21 ranges.

To modify the CIDR block, the target project cannot have:

Any M10 or greater clusters

Any other VPC peering connections

You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.

Example: A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of /24 equals 27 three-node replica sets.

Format should match the following pattern: ^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$.

regionName string Required

Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container.

Values are US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, CA_CENTRAL_1, EU_NORTH_1, EU_WEST_1, EU_WEST_2, EU_WEST_3, EU_CENTRAL_1, EU_CENTRAL_2, SA_EAST_1, AP_EAST_1, AP_SOUTHEAST_2, AP_SOUTHEAST_3, AP_SOUTHEAST_4, AP_NORTHEAST_1, AP_NORTHEAST_2, AP_NORTHEAST_3, AP_SOUTHEAST_1, AP_SOUTH_1, AP_SOUTH_2, CN_NORTH_1, CN_NORTHWEST_1, ME_CENTRAL_1, ME_SOUTH_1, AF_SOUTH_1, EU_SOUTH_1, EU_SOUTH_2, IL_CENTRAL_1, CA_WEST_1, AP_SOUTHEAST_5, AP_SOUTHEAST_7, MX_CENTRAL_1, GLOBAL, US_GOV_WEST_1, or US_GOV_EAST_1.

vpcId string

Unique string that identifies the MongoDB Cloud VPC on AWS.

Format should match the following pattern: ^vpc-[0-9a-f]{17}$.
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.

PATCH /api/atlas/v2/groups/{groupId}/containers/{containerId}

atlas api updatePeeringContainer --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.UpdatePeeringContainerApiParams{}
	sdkResp, httpResp, err := client.NetworkPeeringApi.
		UpdatePeeringContainerWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" \
  -d '{ <Payload> }'

Request examples

{
  "providerName": "AWS",
  "atlasCidrBlock": "string",
  "region": "US_CENTRAL"
}

{
  "providerName": "AWS",
  "atlasCidrBlock": "string",
  "regions": [
    "AFRICA_SOUTH_1"
  ]
}

{
  "providerName": "AWS",
  "atlasCidrBlock": "string",
  "regionName": "US_EAST_1"
}

Response examples (200)

{
  "id": "32b6e34b3d91647abb20e7b8",
  "providerName": "AWS",
  "provisioned": true,
  "atlasCidrBlock": "string",
  "azureSubscriptionId": "32b6e34b3d91647abb20e7b8",
  "region": "US_CENTRAL",
  "vnetName": "string"
}

{
  "id": "32b6e34b3d91647abb20e7b8",
  "providerName": "AWS",
  "provisioned": true,
  "atlasCidrBlock": "string",
  "gcpProjectId": "string",
  "networkName": "string",
  "regions": [
    "AFRICA_SOUTH_1"
  ]
}

{
  "id": "32b6e34b3d91647abb20e7b8",
  "providerName": "AWS",
  "provisioned": true,
  "atlasCidrBlock": "string",
  "regionName": "US_EAST_1",
  "vpcId": "vpc-b555d3b0d9cb783b0"
}

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 Network Peering Connection

DELETE /api/atlas/v2/groups/{groupId}/peers/{peerId}

Service accounts Digest auth

Removes one network peering connection in the specified project. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner 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})$.
peerId string Required

Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete.

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

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

Accepted

Accepted
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}/peers/{peerId}

atlas api deletePeeringConnection --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.DeletePeeringConnectionApiParams{}
	httpResp, err := client.NetworkPeeringApi.
		DeletePeeringConnectionWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}"

Response examples (202)

{}

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 Online Archive

DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}

Service accounts Digest auth

Removes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role.

Online Archive

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

Unique 24-hexadecimal digit string that identifies the online archive to delete.

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

Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive.

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

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

This endpoint does not return a response body.
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}/onlineArchives/{archiveId}

atlas api deleteOnlineArchive --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.DeleteOnlineArchiveApiParams{}
	httpResp, err := client.OnlineArchiveApi.
		DeleteOnlineArchiveWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}"

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 Organization

DELETE /api/atlas/v2/orgs/{orgId}

Service accounts Digest auth

Removes one specified organization. MongoDB Cloud imposes the following limits on this resource:

Organizations with active projects cannot be removed.
All projects in the organization must be removed before you can remove the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role.

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.

Responses

204 application/vnd.atlas.2023-01-01+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.
402 application/json

Payment Required.
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/orgs/{orgId}

atlas api deleteOrganization --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.DeleteOrganizationApiParams{}
	httpResp, err := client.OrganizationsApi.
		DeleteOrganizationWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}"

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

{
  "error": 402,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Payment Required",
  "errorCode": "NO_PAYMENT_INFORMATION_FOUND"
}

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 All Suggested Indexes

GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes

Service accounts Digest auth

Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. 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})$.
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

processIds array[string]

ProcessIds from which to retrieve suggested indexes. A processId is a combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address 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. To include multiple processIds, pass the parameter multiple times delimited with an ampersand (&) between each processId.

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]+)?(\:[0-9]{4,5})$.
namespaces array[string]

Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as .: <database>.<collection>. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (&) between each namespace. Omit this parameter to return results for all namespaces.
since integer(int64)
Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the UNIX epoch.
- If you don't specify the until parameter, the endpoint returns data covering from the since value and the current time.
- If you specify neither the since nor the until parameters, the endpoint returns data from the previous 24 hours.
Minimum value is 1199145600000.
until integer(int64)
Date and time up until which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the UNIX epoch.
- If you specify the until parameter, you must specify the since parameter.
- If you specify neither the since nor the until parameters, the endpoint returns data from the previous 24 hours.
Minimum value is 1199145600000.

Responses

200 application/vnd.atlas.2024-08-05+json

OK
Hide response attributes Show response attributes object
- shapes array[object]
  
  List of query predicates, sorts, and projections that the Performance Advisor suggests.
  
  Hide shapes attributes Show shapes attributes object
  
  avgMs integer(int64)
  
  Average duration in milliseconds for the queries examined that match this shape.
  
  count integer(int64)
  
  Number of queries examined that match this shape.
  
  id string
  
  Unique 24-hexadecimal digit string that identifies this shape. This string exists only for the duration of this API request.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  inefficiencyScore integer(int64)
  
  Average number of documents read for every document that the query returns.
  
  Understanding the Query Inefficiency Score
  
  namespace string
  
  Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as <database>.<collection>.
  
  operations array[object]
  
  List that contains specific about individual queries.
  
  Hide operations attributes Show operations attributes object
  
  predicates array[object]
  
  List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires Project Data Access Read Only permissions or greater. Otherwise, MongoDB Cloud redacts these values.
  
  List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires Project Data Access Read Only permissions or greater. Otherwise, MongoDB Cloud redacts these values.
  
  List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires Project Data Access Read Only permissions or greater. Otherwise, MongoDB Cloud redacts these values.
  
  stats object
  
  Details that this resource returned about the specified query.
  
  Hide stats attributes Show stats attributes object
  
  ms integer(int64)
  
  Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. This parameter relates to the duration query parameter.
  
  nReturned integer(int64)
  
  Number of results that the query returns.
  
  nScanned integer(int64)
  
  Number of documents that the query read.
  
  ts integer(int64)
  
  Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch. This parameter relates to the since query parameter.
  
  UNIX Epoch
- suggestedIndexes array[object]
  
  List that contains the documents with information about the indexes that the Performance Advisor suggests.
  
  Hide suggestedIndexes attributes Show suggestedIndexes attributes object
  
  avgObjSize number(double)
  
  The average size of an object in the collection of this index.
  
  id string
  
  Unique 24-hexadecimal digit string that identifies this index.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  impact array[string]
  
  List that contains unique 24-hexadecimal character string that identifies the query shapes in this response that the Performance Advisor suggests.
  
  index array[object]
  
  List that contains documents that specify a key in the index and its sort order.
  
  One index key paired with its sort order. A value of 1 indicates an ascending sort order. A value of -1 indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index.
  
  Hide index attribute Show index attribute object
  
  * integer(int32) Additional properties
  
  One index key paired with its sort order. A value of 1 indicates an ascending sort order. A value of -1 indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index.
  
  Values are 1 or -1.
  
  namespace string
  
  Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as <database>.<collection>.
  
  weight number(double)
  
  Estimated performance improvement that the suggested index provides. This value corresponds to Impact in the Performance Advisor user interface.
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.
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.
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}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes

atlas api listClusterSuggestedIndexes --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ListClusterSuggestedIndexesApiParams{}
	sdkResp, httpResp, err := client.PerformanceAdvisorApi.
		ListClusterSuggestedIndexesWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes?pretty=true"

Response examples (200)

{
  "shapes": [
    {
      "avgMs": 42,
      "count": 42,
      "id": "32b6e34b3d91647abb20e7b8",
      "inefficiencyScore": 42,
      "namespace": "string",
      "operations": [
        {
          "predicates": [
            {}
          ],
          "stats": {
            "ms": 42,
            "nReturned": 42,
            "nScanned": 42,
            "ts": 42
          }
        }
      ]
    }
  ],
  "suggestedIndexes": [
    {
      "avgObjSize": 42.0,
      "id": "32b6e34b3d91647abb20e7b8",
      "impact": [
        "string"
      ],
      "index": [
        {
          "additionalProperty1": 1,
          "additionalProperty2": 1
        }
      ],
      "namespace": "string",
      "weight": 42.0
    }
  ]
}

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

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

Toggle Regionalized Private Endpoint Status

PATCH /api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode

Service accounts Digest auth

Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. The cloud service provider manages the private endpoints for the project. Connection strings to existing multi-region and global sharded clusters change when you enable this setting. You must update your applications to use the new connection strings. This might cause downtime. To use this resource, the requesting Service Account or API Key must have the Project Owner role and all clusters in the deployment must be sharded clusters. Once enabled, you cannot create replica sets.

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 Required

Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project.

enabled boolean Required
Flag that indicates whether someone enabled the regionalized private endpoint setting for the specified project.
- Set this value to true to enable regionalized private endpoints. This allows you to create more than one private endpoint in a cloud provider region. You need to enable this setting to connect to multi-region and global MongoDB Cloud sharded clusters. Enabling regionalized private endpoints introduces the following limitations:
  - Your applications must use the new connection strings for existing multi-region and global sharded clusters. This might cause downtime.
  - Your MongoDB Cloud project can't contain replica sets nor can you create new replica sets in this project.
  - You can't disable this setting if you have:
  - more than one private endpoint in more than one region
  - more than one private endpoint in one region and one private endpoint in one or more regions.
- Set this value to false to disable regionalized private endpoints.

Responses

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

OK
Hide response attribute Show response attribute object
- enabled boolean Required
  
  Flag that indicates whether someone enabled the regionalized private endpoint setting for the specified project.
  
  Set this value to true to enable regionalized private endpoints. This allows you to create more than one private endpoint in a cloud provider region. You need to enable this setting to connect to multi-region and global MongoDB Cloud sharded clusters. Enabling regionalized private endpoints introduces the following limitations:
  
  Your applications must use the new connection strings for existing multi-region and global sharded clusters. This might cause downtime.
  
  Your MongoDB Cloud project can't contain replica sets nor can you create new replica sets in this project.
  
  You can't disable this setting if you have:
  
  more than one private endpoint in more than one region
  
  more than one private endpoint in one region and one private endpoint in one or more regions.
  
  Set this value to false to disable regionalized private endpoints.
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.

PATCH /api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode

atlas api toggleRegionalizedPrivateEndpointSetting --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ToggleRegionalizedPrivateEndpointSettingApiParams{}
	sdkResp, httpResp, err := client.PrivateEndpointServicesApi.
		ToggleRegionalizedPrivateEndpointSettingWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \
  -d '{ <Payload> }'

Request examples

{
  "enabled": true
}

Response examples (200)

{
  "enabled": true
}

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 Private Endpoint Service for One Provider

GET /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}

Service accounts Digest auth

Returns the name, interfaces, and state of the specified private endpoint service from one project. The cloud service provider hosted this private endpoint service that belongs to the 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})$.
cloudProvider string Required

Cloud service provider that manages this private endpoint service.

Values are AWS, AZURE, or GCP. Default value is AWS.
endpointServiceId string Required

Unique 24-hexadecimal digit string that identifies the private endpoint service 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

Responses

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

OK
One of:
AWSPrivateLinkConnection object AzurePrivateLinkConnection object GCPEndpointService object
Group of Private Endpoint Service settings.

Hide attributes Show attributes

cloudProvider string Required Discriminator

Cloud service provider that serves the requested endpoint service.

Value is AWS.

errorMessage string

Error message returned when requesting private connection resource. The resource returns null if the request succeeded.

id string

Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.

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

regionName string

Cloud provider region that manages this Private Endpoint Service.

status string

State of the Private Endpoint Service connection when MongoDB Cloud received this request.

Values are INITIATING, AVAILABLE, WAITING_FOR_USER, FAILED, or DELETING.

endpointServiceName string

Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.

Format should match the following pattern: ^com\.amazonaws\.vpce\.[a-z-0-9]+\.vpce-svc-[0-9a-f]{17}.

interfaceEndpoints array[string]

List of strings that identify private endpoint interfaces applied to the specified project.

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

Hide attributes Show attributes

cloudProvider string Required Discriminator

Cloud service provider that serves the requested endpoint service.

Value is AZURE.

errorMessage string

Error message returned when requesting private connection resource. The resource returns null if the request succeeded.

id string

Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.

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

regionName string

Cloud provider region that manages this Private Endpoint Service.

status string

State of the Private Endpoint Service connection when MongoDB Cloud received this request.

Values are INITIATING, AVAILABLE, WAITING_FOR_USER, FAILED, or DELETING.

privateEndpoints array[string]

List of private endpoints assigned to this Azure Private Link Service.

Format of each should match the following pattern: ^\/subscriptions\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\/resource[gG]roups\/([-\w._()]+)\/providers\/Microsoft\.Network\/privateEndpoints\/([-\w._()]+).

privateLinkServiceName string

Unique string that identifies the Azure Private Link Service that MongoDB Cloud manages.

Format should match the following pattern: ^pls_[0-9a-f]{24}$.

privateLinkServiceResourceId string

Root-relative path that identifies of the Azure Private Link Service that MongoDB Cloud manages. Use this value to create a private endpoint connection to an Azure VNet.
Group of Private Endpoint Service settings.

Hide attributes Show attributes

cloudProvider string Required Discriminator

Cloud service provider that serves the requested endpoint service.

Value is GCP.

errorMessage string

Error message returned when requesting private connection resource. The resource returns null if the request succeeded.

id string

Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.

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

regionName string

Cloud provider region that manages this Private Endpoint Service.

status string

State of the Private Endpoint Service connection when MongoDB Cloud received this request.

Values are INITIATING, AVAILABLE, WAITING_FOR_USER, FAILED, or DELETING.

endpointGroupNames array[string]

List of Google Cloud network endpoint groups that corresponds to the Private Service Connect endpoint service.

serviceAttachmentNames array[string]

List of Uniform Resource Locators (URLs) that identifies endpoints that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.

Format of each should match the following pattern: https:\/\/([a-z0-9\.]+)+\.[a-z]{2,}(\/[a-z0-9\-]+)+\/projects\/p-[a-z0-9]+\/regions\/[a-z\-0-9]+\/serviceAttachments\/[a-z0-9\-]+.
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}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}

atlas api getPrivateEndpointService --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.GetPrivateEndpointServiceApiParams{}
	sdkResp, httpResp, err := client.PrivateEndpointServicesApi.
		GetPrivateEndpointServiceWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true"

Response examples (200)

{
  "cloudProvider": "AWS",
  "errorMessage": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "regionName": "string",
  "status": "INITIATING",
  "endpointServiceName": "string",
  "interfaceEndpoints": [
    "32b6e34b3d91647abb20e7b8"
  ]
}

{
  "cloudProvider": "AWS",
  "errorMessage": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "regionName": "string",
  "status": "INITIATING",
  "privateEndpoints": [
    "string"
  ],
  "privateLinkServiceName": "string",
  "privateLinkServiceResourceId": "/subscriptions/ae349d51-d12b-ee3d-2a27-7d53f6479cf0/resourcegroups/KObGGz/providers/Microsoft.Network/privateLinkServices/pls_d1820713f8153388d533e9de"
}

{
  "cloudProvider": "AWS",
  "errorMessage": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "regionName": "string",
  "status": "INITIATING",
  "endpointGroupNames": [
    "string"
  ],
  "serviceAttachmentNames": [
    "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"
}

Create One Private Endpoint for One Provider

POST /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint

Service accounts Digest auth

Creates one private endpoint for the specified cloud service provider. This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private 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})$.
cloudProvider string Required

Cloud service provider that manages this private endpoint.

Values are AWS, AZURE, or GCP. Default value is AWS.
endpointServiceId string Required

Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint.

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 Required

Creates one private endpoint for the specified cloud service provider.

Responses

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

OK
One of:
AWSInterfaceEndpoint object AzurePrivateEndpoint object PrivateGCPEndpointGroup object
Group of Private Endpoint settings.

Hide attributes Show attributes

cloudProvider string Required Discriminator

Cloud service provider that serves the requested endpoint.

Value is AWS.

deleteRequested boolean

Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.

errorMessage string

Error message returned when requesting private connection resource. The resource returns null if the request succeeded.

connectionStatus string

State of the Amazon Web Service PrivateLink connection when MongoDB Cloud received this request.

Values are PENDING_ACCEPTANCE, PENDING, AVAILABLE, REJECTED, or DELETING.

interfaceEndpointId string

Unique 24-hexadecimal digit string that identifies the interface endpoint.
Group of Private Endpoint settings.

Hide attributes Show attributes

cloudProvider string Required Discriminator

Cloud service provider that serves the requested endpoint.

Value is AZURE.

deleteRequested boolean

Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.

errorMessage string

Error message returned when requesting private connection resource. The resource returns null if the request succeeded.

privateEndpointConnectionName string

Human-readable label that MongoDB Cloud generates that identifies the private endpoint connection.

Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]([-\w._()]+)%2[fF]([-\w._()]+).

privateEndpointIPAddress string

IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.

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

privateEndpointResourceId string

Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.

status string

State of the Azure Private Link Service connection when MongoDB Cloud received this request.

Values are INITIATING, AVAILABLE, FAILED, or DELETING.
Group of Private Endpoint settings.

Hide attributes Show attributes

cloudProvider string Required Discriminator

Cloud service provider that serves the requested endpoint.

Value is GCP.

deleteRequested boolean

Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.

errorMessage string

Error message returned when requesting private connection resource. The resource returns null if the request succeeded.

endpointGroupName string

Human-readable label that identifies a set of endpoints.

Google Cloud Forwarding Rule Concepts

endpoints array[object]

List of individual private endpoints that comprise this endpoint group.

Google Cloud Forwarding Rule Concepts

Hide endpoints attributes Show endpoints attributes object

endpointName string

Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.

Google Cloud Forwarding Rule Concepts

ipAddress string

One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.

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

status string

State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.

Values are INITIATING, AVAILABLE, FAILED, or DELETING.

status string

State of the Google Cloud network endpoint group when MongoDB Cloud received this request.

Values are INITIATING, VERIFIED, 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.
402 application/json

Payment Required.
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}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint

atlas api createPrivateEndpoint --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.CreatePrivateEndpointApiParams{}
	sdkResp, httpResp, err := client.PrivateEndpointServicesApi.
		CreatePrivateEndpointWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" \
  -d '{ <Payload> }'

Response examples (200)

{
  "cloudProvider": "AWS",
  "deleteRequested": true,
  "errorMessage": "string",
  "connectionStatus": "PENDING_ACCEPTANCE",
  "interfaceEndpointId": "string"
}

{
  "cloudProvider": "AWS",
  "deleteRequested": true,
  "errorMessage": "string",
  "privateEndpointConnectionName": "string",
  "privateEndpointIPAddress": "string",
  "privateEndpointResourceId": "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln",
  "status": "INITIATING"
}

{
  "cloudProvider": "AWS",
  "deleteRequested": true,
  "errorMessage": "string",
  "endpointGroupName": "string",
  "endpoints": [
    {
      "endpointName": "string",
      "ipAddress": "string",
      "status": "INITIATING"
    }
  ],
  "status": "INITIATING"
}

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

{
  "error": 402,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Payment Required",
  "errorCode": "NO_PAYMENT_INFORMATION_FOUND"
}

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 Organization API Key

GET /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}

Service accounts Digest auth

Returns one organization API key. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting Service Account or API Key must have the Organization Member role.

Programmatic API Keys

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

Unique 24-hexadecimal digit string that identifies this organization API key that you want to update.

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
- desc string
  
  Purpose or explanation provided when someone created this organization API key.
  
  Minimum length is 1, maximum length is 250.
- id string
  
  Unique 24-hexadecimal digit string that identifies this organization API key assigned to this project.
  
  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.
- privateKey string
  
  Redacted private key returned for this organization API key. This key displays unredacted when first created.
- publicKey string
  
  Public API key value set for the specified organization API key.
  
  Minimum length is 8, maximum length is 8.
- roles array[object]
  
  List that contains the roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the API key.
  
  MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. Each role can apply to one organization or one project but not both.
  
  Hide roles attributes Show roles attributes object
  
  groupId string
  
  Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or orgId but not both in the same request.
  
  Minimum length is 24, maximum length is 24. 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. You can set a value for this parameter or groupId but not both in the same request.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  roleName 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_MEMBER, ORG_READ_ONLY, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_GROUP_CREATOR, ORG_OWNER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_CLUSTER_MANAGER, GROUP_SEARCH_INDEX_EDITOR, GROUP_STREAM_PROCESSING_OWNER, GROUP_BACKUP_MANAGER, GROUP_OBSERVABILITY_VIEWER, or GROUP_DATABASE_ACCESS_ADMIN.
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}/apiKeys/{apiUserId}

atlas api getApiKey --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.GetApiKeyApiParams{}
	sdkResp, httpResp, err := client.ProgrammaticAPIKeysApi.
		GetApiKeyWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true"

Response examples (200)

{
  "desc": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  "publicKey": "zmmrboas",
  "roles": [
    {
      "groupId": "32b6e34b3d91647abb20e7b8",
      "orgId": "32b6e34b3d91647abb20e7b8",
      "roleName": "ORG_MEMBER"
    }
  ]
}

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

Project IP Access List

Returns, adds, edits, and removes network access limits to database deployments in Atlas. This resource replaces the whitelist resource. Atlas removed whitelists in July 2021. Update your applications to use this new resource. This resource manages a project's IP Access List and supports creating temporary Access List entries that automatically expire within a user-configurable 7-day period.

Return All Projects

GET /api/atlas/v2/groups

Service accounts Digest auth

Returns details about all projects. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Organization Read Only role or higher.

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
  
  clusterCount integer(int64) Required
  
  Quantity of MongoDB Cloud clusters deployed in this project.
  
  created string(date-time) Required
  
  Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  id string
  
  Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.
  
  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.
  
  name string Required
  
  Human-readable label that identifies the project included in the MongoDB Cloud organization.
  
  Format should match the following pattern: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$.
  
  orgId string Required
  
  Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  regionUsageRestrictions string
  
  Applies to Atlas for Government only.
  
  In Commercial Atlas, this field will be rejected in requests and missing in responses.
  
  This field sets restrictions on available regions in the project.
  
  COMMERCIAL_FEDRAMP_REGIONS_ONLY: Only allows deployments in FedRAMP Moderate regions.
  
  GOV_REGIONS_ONLY: Only allows deployments in GovCloud regions.
  
  Values are COMMERCIAL_FEDRAMP_REGIONS_ONLY or GOV_REGIONS_ONLY. Default value is COMMERCIAL_FEDRAMP_REGIONS_ONLY.
  
  External documentation
  
  tags array[object]
  
  List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.
  
  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.
- 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

atlas api listProjects --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ListProjectsApiParams{}
	sdkResp, httpResp, err := client.ProjectsApi.
		ListProjectsWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true"

Response examples (200)

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "clusterCount": 42,
      "created": "2025-05-04T09:42:00Z",
      "id": "32b6e34b3d91647abb20e7b8",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "name": "string",
      "orgId": "32b6e34b3d91647abb20e7b8",
      "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "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"
}

Remove One Project

DELETE /api/atlas/v2/groups/{groupId}

Service accounts Digest auth

Removes the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting Service Account or API Key must have the Project Owner 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})$.

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

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

atlas api deleteProject --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.DeleteProjectApiParams{}
	httpResp, err := client.ProjectsApi.
		DeleteProjectWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}"

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

Create One Atlas Search Index Deprecated

Path parameters

Query parameters

Body object Required

tokenizer object Required

Responses

tokenizer object Required

Restore One Snapshot of One Serverless Instance

Path parameters

Query parameters

Body Required

Responses

Cluster Outage Simulation

Return All Authorized Clusters in All Projects

Query parameters

Responses

Collection Level Metrics

Return All Custom Roles in One Project

Path parameters

Query parameters

Responses

Data Federation

Return One Federated Database Instance Query Limit for One Project

Path parameters

Query parameters

Responses

Return All Federated Database Instance and Online Archive Private Endpoints in One Project

Path parameters

Query parameters

Responses

Return One Federated Database Instance and Online Archive Private Endpoint in One Project

Path parameters

Query parameters

Responses

Pause One Data Lake Pipeline Deprecated

Path parameters

Query parameters

Responses

source object

Return All Organization Configurations from One Federation

Path parameters

Query parameters

Responses

Return All Restore Jobs for One Flex Cluster

Path parameters

Query parameters

Responses

Return All Pending Invoices for One Organization

Path parameters

Query parameters

Responses

Update LDAP or X.509 Configuration

Path parameters

Query parameters

Body Required

Responses

Verify LDAP Configuration in One Project

Path parameters

Query parameters

Body Required

Responses

Return One Legacy Backup Snapshot Deprecated

Path parameters

Query parameters

Responses

Update Expiration Date for One Legacy Backup Snapshot Deprecated

Path parameters

Query parameters

Body Required

Responses

Return All MongoDB Cloud Users Assigned to One Team

Path parameters

Query parameters

Responses

Return One Database for One MongoDB Process

Path parameters

Query parameters

Responses

Create One Network Peering Container

Path parameters