mongodb-atlas-api-client 2.32.0 → 3.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -2,14 +2,9 @@
2
2
 
3
3
  A mongdb atlas api client for nodejs.
4
4
 
5
- [![Known Vulnerabilities](https://snyk.io/test/github/montumodi/mongodb-atlas-api-client/badge.svg)](https://snyk.io/test/github/montumodi/mongodb-atlas-api-client)
6
- [![Coverage Status](https://coveralls.io/repos/github/montumodi/mongodb-atlas-api-client/badge.svg?branch=master)](https://coveralls.io/github/montumodi/mongodb-atlas-api-client?branch=master)
7
- [![Build Status](https://travis-ci.com/montumodi/mongodb-atlas-api-client.svg?branch=master)](https://travis-ci.com/montumodi/mongodb-atlas-api-client)
5
+ [![Coverage Status](https://gist.github.com/montumodi/4863975b3d11c22536fcf9fcc8d237dd/raw/badge.svg)](https://gist.github.com/montumodi/4863975b3d11c22536fcf9fcc8d237dd/raw/badge.svg)
8
6
  ![NPM Publish](https://github.com/montumodi/mongodb-atlas-api-client/actions/workflows/.github/workflows/npmpublish.yml/badge.svg)
9
7
 
10
- [![Deps](https://david-dm.org/montumodi/mongodb-atlas-api-client.svg)](https://david-dm.org/montumodi/mongodb-atlas-api-client#info=dependencies)
11
- [![devDependency Status](https://david-dm.org/montumodi/mongodb-atlas-api-client/dev-status.svg)](https://david-dm.org/montumodi/mongodb-atlas-api-client#info=devDependencies)
12
-
13
8
  [![NPM](https://nodei.co/npm/mongodb-atlas-api-client.png?downloads=true)](https://www.npmjs.com/package/mongodb-atlas-api-client/)
14
9
 
15
10
  ## How to install
@@ -20,9 +15,9 @@ npm install mongodb-atlas-api-client
20
15
 
21
16
  ## Getting Started
22
17
 
23
- The basic syntax is:
18
+ The basic syntax is
24
19
 
25
- Atlas API uses HTTP Digest Authentication. It essentially requires a username and a password which are hashed using a unique server-generated value called a nonce. The username is the API public key and the password is the corresponding private key.
20
+ Atlas API uses HTTP Digest Authentication. It essentially requires a username and a password which are hashed using a unique server-generated value called a nonce. The username is the API public key and the password is the corresponding private key. It internally uses [urllib](https://www.npmjs.com/package/urllib)
26
21
 
27
22
  ```js
28
23
  const getClient = require("mongodb-atlas-api-client");
@@ -36,7 +31,10 @@ const {user, cluster} = getClient({
36
31
  const options = {
37
32
  "envelope": true,
38
33
  "itemsPerPage": 10,
39
- "pretty": true
34
+ "pretty": true,
35
+ "httpOptions": { // This parameter will not be sent as querystring. This will be send to http request package `urllib`
36
+ "timeout": 5000
37
+ }
40
38
  }
41
39
 
42
40
  const response = await user.getAll(options); // get All users
@@ -78,7 +76,7 @@ Function - Returns the details of user name passed.
78
76
  | Param | Type | Default | Description |
79
77
  | --- | --- | --- | --- |
80
78
  | username | <code>String</code> | | name of the user for which details needs to be retrieved |
81
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
79
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib. |
82
80
 
83
81
  More details - https://docs.atlas.mongodb.com/reference/api/database-users-get-single-user/
84
82
 
@@ -89,7 +87,7 @@ Function - Returns all the users. Pagination can be controlled via options objec
89
87
 
90
88
  | Param | Type | Default | Description |
91
89
  | --- | --- | --- | --- |
92
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
90
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
93
91
 
94
92
  More details - https://docs.atlas.mongodb.com/reference/api/database-users-get-all-users/
95
93
 
@@ -101,7 +99,7 @@ Function - Creates the user as per body passed.
101
99
  | Param | Type | Default | Description |
102
100
  | --- | --- | --- | --- |
103
101
  | body | <code>Object</code> | | Body which has details for user which needs to be created |
104
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
102
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
105
103
 
106
104
  More details - https://docs.atlas.mongodb.com/reference/api/database-users-create-a-user/
107
105
 
@@ -114,7 +112,7 @@ Function - Updates the user for the username passed. It only updates the propert
114
112
  | --- | --- | --- | --- |
115
113
  | username | <code>String</code> | | name of the user for which details needs to be updated |
116
114
  | body | <code>Object</code> | | Body which has details for user which needs to be updated |
117
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
115
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
118
116
 
119
117
  More details - https://docs.atlas.mongodb.com/reference/api/database-users-update-a-user/
120
118
 
@@ -126,7 +124,7 @@ Function - Deletes the user name passed.
126
124
  | Param | Type | Default | Description |
127
125
  | --- | --- | --- | --- |
128
126
  | username | <code>String</code> | | name of the user which needs to be deleted |
129
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
127
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
130
128
 
131
129
  More details - https://docs.atlas.mongodb.com/reference/api/database-users-delete-a-user/
132
130
 
@@ -140,7 +138,7 @@ Function - Returns the details of cluster name passed.
140
138
  | Param | Type | Default | Description |
141
139
  | --- | --- | --- | --- |
142
140
  | clustername | <code>String</code> | | name of the cluster for which details needs to be retrieved |
143
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
141
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
144
142
 
145
143
  More details - https://docs.atlas.mongodb.com/reference/api/clusters-get-one/
146
144
 
@@ -151,7 +149,7 @@ Function - Returns all the clusters. Pagination can be controlled via options ob
151
149
 
152
150
  | Param | Type | Default | Description |
153
151
  | --- | --- | --- | --- |
154
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
152
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
155
153
 
156
154
  More details - https://docs.atlas.mongodb.com/reference/api/clusters-get-all/
157
155
 
@@ -163,7 +161,7 @@ Function - Returns the advance configuration of cluster name passed.
163
161
  | Param | Type | Default | Description |
164
162
  | --- | --- | --- | --- |
165
163
  | clustername | <code>String</code> | | name of the cluster for which advance configuration needs to be retrieved |
166
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
164
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
167
165
 
168
166
  More details - https://docs.atlas.mongodb.com/reference/api/clusters-get-advanced-configuration-options/
169
167
 
@@ -175,7 +173,7 @@ Function - Creates the cluster as per body passed.
175
173
  | Param | Type | Default | Description |
176
174
  | --- | --- | --- | --- |
177
175
  | body | <code>Object</code> | | Body which has details for cluster which needs to be created |
178
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
176
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
179
177
 
180
178
  More details - https://docs.atlas.mongodb.com/reference/api/clusters-create-one/
181
179
 
@@ -188,7 +186,7 @@ Function - Updates the cluster for the clustername passed. It only updates the p
188
186
  | --- | --- | --- | --- |
189
187
  | clustername | <code>String</code> | | name of the cluster for which details needs to be updated |
190
188
  | body | <code>Object</code> | | Body which has details for cluster which needs to be updated |
191
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
189
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
192
190
 
193
191
  More details - https://docs.atlas.mongodb.com/reference/api/clusters-modify-one/
194
192
 
@@ -201,7 +199,7 @@ Function - Updates the advance configuration of cluster for the clustername pass
201
199
  | --- | --- | --- | --- |
202
200
  | clustername | <code>String</code> | | name of the cluster for which advance configuration needs to be updated |
203
201
  | body | <code>Object</code> | | Body which has details for cluster which needs to be updated |
204
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
202
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
205
203
 
206
204
  More details - https://docs.atlas.mongodb.com/reference/api/clusters-modify-advanced-configuration-options/
207
205
 
@@ -213,7 +211,7 @@ Function - Tests failure of primary replica set member.
213
211
  | Param | Type | Default | Description |
214
212
  | --- | --- | --- | --- |
215
213
  | clustername | <code>String</code> | | name of the cluster for which failure needs to be tested |
216
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
214
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
217
215
 
218
216
  More details - https://docs.atlas.mongodb.com/reference/api/clusters-test-failover/
219
217
 
@@ -225,7 +223,7 @@ Function - Deletes the cluster name passed.
225
223
  | Param | Type | Default | Description |
226
224
  | --- | --- | --- | --- |
227
225
  | clustername | <code>String</code> | | name of the cluster which needs to be deleted |
228
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
226
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
229
227
 
230
228
  More details - https://docs.atlas.mongodb.com/reference/api/clusters-delete-one/
231
229
 
@@ -239,7 +237,7 @@ Function - Returns the details of role name passed.
239
237
  | Param | Type | Default | Description |
240
238
  | --- | --- | --- | --- |
241
239
  | rolename | <code>String</code> | | name of the role for which details needs to be retrieved |
242
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
240
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
243
241
 
244
242
  More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-get-single-role/
245
243
 
@@ -250,7 +248,7 @@ Function - Returns all the roles. Pagination can be controlled via options objec
250
248
 
251
249
  | Param | Type | Default | Description |
252
250
  | --- | --- | --- | --- |
253
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
251
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
254
252
 
255
253
  More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-get-all-roles/
256
254
 
@@ -262,7 +260,7 @@ Function - Creates the role as per body passed.
262
260
  | Param | Type | Default | Description |
263
261
  | --- | --- | --- | --- |
264
262
  | body | <code>Object</code> | | Body which has details for role which needs to be created |
265
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
263
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
266
264
 
267
265
  More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-create-a-role/
268
266
 
@@ -275,7 +273,7 @@ Function - Updates the role for the rolename passed. It only updates the propert
275
273
  | --- | --- | --- | --- |
276
274
  | rolename | <code>String</code> | | name of the role for which details needs to be updated |
277
275
  | body | <code>Object</code> | | Body which has details for role which needs to be updated |
278
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
276
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
279
277
 
280
278
  More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-update-a-role/
281
279
 
@@ -287,7 +285,7 @@ Function - Deletes the role name passed.
287
285
  | Param | Type | Default | Description |
288
286
  | --- | --- | --- | --- |
289
287
  | rolename | <code>String</code> | | name of the role which needs to be deleted |
290
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
288
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
291
289
 
292
290
  More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-delete-a-role/
293
291
 
@@ -301,7 +299,7 @@ Function - Returns the details of whitelistentry name passed.
301
299
  | Param | Type | Default | Description |
302
300
  | --- | --- | --- | --- |
303
301
  | whitelistentry | <code>String</code> | | name of the whitelistentry for which details needs to be retrieved |
304
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
302
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
305
303
 
306
304
  More details - https://docs.atlas.mongodb.com/reference/api/whitelist-get-one-entry/
307
305
 
@@ -312,7 +310,7 @@ Function - Returns all the whitelistentries. Pagination can be controlled via op
312
310
 
313
311
  | Param | Type | Default | Description |
314
312
  | --- | --- | --- | --- |
315
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
313
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
316
314
 
317
315
  More details - https://docs.atlas.mongodb.com/reference/api/whitelist-get-all/
318
316
 
@@ -324,7 +322,7 @@ Function - Creates the whitelistentry as per body passed.
324
322
  | Param | Type | Default | Description |
325
323
  | --- | --- | --- | --- |
326
324
  | body | <code>Object</code> | | Body which has details for whitelistentry which needs to be created |
327
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
325
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
328
326
 
329
327
  More details - https://docs.atlas.mongodb.com/reference/api/whitelist-add-one/
330
328
 
@@ -336,7 +334,7 @@ Function - Updates the whitelistentry passed. It only updates the properties pas
336
334
  | Param | Type | Default | Description |
337
335
  | --- | --- | --- | --- |
338
336
  | body | <code>Object</code> | | Body which has details for whitelistentry which needs to be updated |
339
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
337
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
340
338
 
341
339
  More details - https://docs.atlas.mongodb.com/reference/api/whitelist-update-one/
342
340
 
@@ -348,7 +346,7 @@ Function - Deletes the whitelistentry name passed.
348
346
  | Param | Type | Default | Description |
349
347
  | --- | --- | --- | --- |
350
348
  | whitelistentry | <code>String</code> | | name of the whitelistentry which needs to be deleted |
351
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
349
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
352
350
 
353
351
  More details - https://docs.atlas.mongodb.com/reference/api/whitelist-delete-one/
354
352
 
@@ -362,7 +360,7 @@ Function - Returns the details of accesslistentry name passed.
362
360
  | Param | Type | Default | Description |
363
361
  | --- | --- | --- | --- |
364
362
  | accesslistentry | <code>String</code> | | name of the accesslistentry for which details needs to be retrieved |
365
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
363
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
366
364
 
367
365
  More details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/get-one-access-list-entry/
368
366
 
@@ -373,7 +371,7 @@ Function - Returns all the accesslistentries. Pagination can be controlled via o
373
371
 
374
372
  | Param | Type | Default | Description |
375
373
  | --- | --- | --- | --- |
376
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
374
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
377
375
 
378
376
  More details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/get-all-access-list-entries/
379
377
 
@@ -385,7 +383,7 @@ Function - Creates the accesslistentry as per body passed.
385
383
  | Param | Type | Default | Description |
386
384
  | --- | --- | --- | --- |
387
385
  | body | <code>Object</code> | | Body which has details for accesslistentry which needs to be created |
388
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
386
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
389
387
 
390
388
  More details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/add-entries-to-access-list/
391
389
 
@@ -397,7 +395,7 @@ Function - Updates the accesslistentry passed. It only updates the properties pa
397
395
  | Param | Type | Default | Description |
398
396
  | --- | --- | --- | --- |
399
397
  | body | <code>Object</code> | | Body which has details for accesslistentry which needs to be updated |
400
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
398
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
401
399
 
402
400
  More details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/add-entries-to-access-list/
403
401
 
@@ -409,7 +407,7 @@ Function - Deletes the accesslistentry name passed.
409
407
  | Param | Type | Default | Description |
410
408
  | --- | --- | --- | --- |
411
409
  | accesslistentry | <code>String</code> | | name of the accesslistentry which needs to be deleted |
412
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
410
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
413
411
 
414
412
  More details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/delete-one-access-list-entry/
415
413
 
@@ -423,7 +421,7 @@ Function - Returns the details of project id passed.
423
421
  | Param | Type | Default | Description |
424
422
  | --- | --- | --- | --- |
425
423
  | projectId | <code>String</code> | | project id for which details needs to be retrieved |
426
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
424
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
427
425
 
428
426
  More details - https://docs.atlas.mongodb.com/reference/api/project-get-one/
429
427
 
@@ -435,7 +433,7 @@ Function - Returns the details of project name passed.
435
433
  | Param | Type | Default | Description |
436
434
  | --- | --- | --- | --- |
437
435
  | projectId | <code>String</code> | | project name for which details needs to be retrieved |
438
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
436
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
439
437
 
440
438
  More details - https://docs.atlas.mongodb.com/reference/api/project-get-one-by-name/
441
439
 
@@ -447,7 +445,7 @@ Function - Returns the teams of project id passed.
447
445
  | Param | Type | Default | Description |
448
446
  | --- | --- | --- | --- |
449
447
  | projectId | <code>String</code> | | project id for which teams needs to be retrieved |
450
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
448
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
451
449
 
452
450
  More details - https://docs.atlas.mongodb.com/reference/api/project-get-teams/
453
451
 
@@ -458,7 +456,7 @@ Function - Returns all the projects. Pagination can be controlled via options ob
458
456
 
459
457
  | Param | Type | Default | Description |
460
458
  | --- | --- | --- | --- |
461
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
459
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
462
460
 
463
461
  More details - https://docs.atlas.mongodb.com/reference/api/project-get-all/
464
462
 
@@ -470,7 +468,7 @@ Function - Creates the project as per body passed.
470
468
  | Param | Type | Default | Description |
471
469
  | --- | --- | --- | --- |
472
470
  | body | <code>Object</code> | | Body which has details for project which needs to be created |
473
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
471
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
474
472
 
475
473
  More details - https://docs.atlas.mongodb.com/reference/api/project-create-one/
476
474
 
@@ -483,7 +481,7 @@ Function - Assigns the teams for the projectId passed. It only updates the prope
483
481
  | --- | --- | --- | --- |
484
482
  | projectId | <code>String</code> | | Id of the project for which teams needs to be associated |
485
483
  | body | <code>Object</code> | | Body which has details for teams which needs to be associated |
486
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
484
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
487
485
 
488
486
  More details - https://docs.atlas.mongodb.com/reference/api/project-add-team/
489
487
 
@@ -495,7 +493,7 @@ Function - Deletes the project id passed.
495
493
  | Param | Type | Default | Description |
496
494
  | --- | --- | --- | --- |
497
495
  | projectId | <code>String</code> | | Id of the project which needs to be deleted |
498
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
496
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
499
497
 
500
498
  More details - https://docs.atlas.mongodb.com/reference/api/project-delete-one/
501
499
 
@@ -508,7 +506,7 @@ Function - Removes the user id passed from the project.
508
506
  | --- | --- | --- | --- |
509
507
  | userId | <code>String</code> | | Id of the user which needs to be removed from project |
510
508
  | projectId | <code>String</code> | | Id of the project |
511
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
509
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
512
510
 
513
511
  More details - https://docs.atlas.mongodb.com/reference/api/project-remove-user/
514
512
 
@@ -522,7 +520,7 @@ Function - Returns the details of organization id passed.
522
520
  | Param | Type | Default | Description |
523
521
  | --- | --- | --- | --- |
524
522
  | organizationId | <code>String</code> | | org§ id for which details needs to be retrieved |
525
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
523
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
526
524
 
527
525
  More details - https://docs.atlas.mongodb.com/reference/api/organization-get-one/
528
526
 
@@ -534,7 +532,7 @@ Function - Returns all the users for organization id passed.
534
532
  | Param | Type | Default | Description |
535
533
  | --- | --- | --- | --- |
536
534
  | organizationId | <code>String</code> | | organization id for which users needs to be retrieved |
537
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
535
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
538
536
 
539
537
  More details - https://docs.atlas.mongodb.com/reference/api/organization-users-get-all-users/
540
538
 
@@ -546,7 +544,7 @@ Function - Returns all the projects for organization id passed.
546
544
  | Param | Type | Default | Description |
547
545
  | --- | --- | --- | --- |
548
546
  | organizationId | <code>String</code> | | organization id for which projects needs to be retrieved |
549
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
547
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
550
548
 
551
549
  More details - https://docs.atlas.mongodb.com/reference/api/organization-get-all-projects/
552
550
 
@@ -557,7 +555,7 @@ Function - Returns all the organizations. Pagination can be controlled via optio
557
555
 
558
556
  | Param | Type | Default | Description |
559
557
  | --- | --- | --- | --- |
560
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
558
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
561
559
 
562
560
  More details - https://docs.atlas.mongodb.com/reference/api/organization-get-all/
563
561
 
@@ -570,7 +568,7 @@ Function - Renames the organization
570
568
  | --- | --- | --- | --- |
571
569
  | organizationId | <code>String</code> | | Id of the organization for which needs to be renamed |
572
570
  | body | <code>Object</code> | | Body which has details for organization which needs to be renamed |
573
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
571
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
574
572
 
575
573
  More details - https://docs.atlas.mongodb.com/reference/api/organization-rename/
576
574
 
@@ -586,7 +584,7 @@ Function - Sends an invitation to the given email (username) to join the Organiz
586
584
  | body.roles | <code>string[]</code> | | Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. |
587
585
  | body.teamIds | <code>string[]</code> | | *(Optional)* Unique 24-hexadecimal digit strings that identify the teams that you invite the user to join.
588
586
  | body.username | <code>string</code> | | Email address of the invited user. This is the address to which Atlas sends the invite.
589
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
587
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
590
588
 
591
589
  More details - https://docs.atlas.mongodb.com/reference/api/organization-create-one-invitation/
592
590
 
@@ -599,7 +597,7 @@ Function - Deletes the project id passed.
599
597
  | Param | Type | Default | Description |
600
598
  | --- | --- | --- | --- |
601
599
  | organizationId | <code>String</code> | | Id of the organization which needs to be deleted |
602
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
600
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
603
601
 
604
602
  More details - https://docs.atlas.mongodb.com/reference/api/organization-delete-one/
605
603
 
@@ -613,7 +611,7 @@ Function - Returns the details of user id passed.
613
611
  | Param | Type | Default | Description |
614
612
  | --- | --- | --- | --- |
615
613
  | userId | <code>String</code> | | Id of the user for which details needs to be retrieved |
616
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
614
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
617
615
 
618
616
  More details - https://docs.atlas.mongodb.com/reference/api/user-get-by-id/
619
617
 
@@ -625,7 +623,7 @@ Function - Returns the details of user name passed.
625
623
  | Param | Type | Default | Description |
626
624
  | --- | --- | --- | --- |
627
625
  | username | <code>String</code> | | Name of the user for which details needs to be retrieved |
628
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
626
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
629
627
 
630
628
  More details - https://docs.atlas.mongodb.com/reference/api/user-get-one-by-name/
631
629
 
@@ -636,7 +634,7 @@ Function - Returns all the users. Pagination can be controlled via options objec
636
634
 
637
635
  | Param | Type | Default | Description |
638
636
  | --- | --- | --- | --- |
639
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
637
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
640
638
 
641
639
  More details - https://docs.atlas.mongodb.com/reference/api/user-get-all/
642
640
 
@@ -648,7 +646,7 @@ Function - Creates the atlas user as per body passed.
648
646
  | Param | Type | Default | Description |
649
647
  | --- | --- | --- | --- |
650
648
  | body | <code>Object</code> | | Body which has details for atlas user which needs to be created |
651
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
649
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
652
650
 
653
651
  More details - https://docs.atlas.mongodb.com/reference/api/user-create/
654
652
 
@@ -661,7 +659,7 @@ Function - Updates the user for the userId passed. It only updates the propertie
661
659
  | --- | --- | --- | --- |
662
660
  | userId | <code>String</code> | | Id of the user for which details needs to be updated |
663
661
  | body | <code>Object</code> | | Body which has details for user which needs to be updated |
664
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
662
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
665
663
 
666
664
  More details - https://docs.atlas.mongodb.com/reference/api/user-update/
667
665
 
@@ -675,7 +673,7 @@ Function - Returns the details of event id passed.
675
673
  | Param | Type | Default | Description |
676
674
  | --- | --- | --- | --- |
677
675
  | eventId | <code>String</code> | | id of the event for which details needs to be retrieved |
678
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
676
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
679
677
 
680
678
  More details - https://docs.atlas.mongodb.com/reference/api/events-projects-get-one/
681
679
 
@@ -686,7 +684,7 @@ Function - Returns all the events. Pagination can be controlled via options obje
686
684
 
687
685
  | Param | Type | Default | Description |
688
686
  | --- | --- | --- | --- |
689
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
687
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
690
688
 
691
689
  More details - https://docs.atlas.mongodb.com/reference/api/events-projects-get-all/
692
690
 
@@ -699,7 +697,7 @@ Function - Returns the details of event id passed for organization id.
699
697
  | --- | --- | --- | --- |
700
698
  | organizationId | <code>String</code> | | id of the organization for which details needs to be retrieved |
701
699
  | eventId | <code>String</code> | | id of the event for which details needs to be retrieved |
702
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
700
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
703
701
 
704
702
  More details - https://docs.atlas.mongodb.com/reference/api/events-orgs-get-one/
705
703
 
@@ -711,7 +709,7 @@ Function - Returns all the events. Pagination can be controlled via options obje
711
709
  | Param | Type | Default | Description |
712
710
  | --- | --- | --- | --- |
713
711
  | organizationId | <code>String</code> | | id of the organization for which details needs to be retrieved |
714
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
712
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
715
713
 
716
714
  More details - https://docs.atlas.mongodb.com/reference/api/events-orgs-get-all/
717
715
 
@@ -725,7 +723,7 @@ Function - Returns the details of alert id passed.
725
723
  | Param | Type | Default | Description |
726
724
  | --- | --- | --- | --- |
727
725
  | alertId | <code>String</code> | | id of the alert for which details needs to be retrieved |
728
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
726
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
729
727
 
730
728
  More details - https://docs.atlas.mongodb.com/reference/api/alerts-get-alert/
731
729
 
@@ -736,7 +734,7 @@ Function - Returns all the alerts. Pagination can be controlled via options obje
736
734
 
737
735
  | Param | Type | Default | Description |
738
736
  | --- | --- | --- | --- |
739
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
737
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
740
738
 
741
739
  More details - https://docs.atlas.mongodb.com/reference/api/alerts-get-all-alerts/
742
740
 
@@ -749,7 +747,7 @@ Function - Acknowledge or unacknowledge an alert
749
747
  | --- | --- | --- | --- |
750
748
  | alertId | <code>String</code> | | id of the alert which needs to be acknowledged |
751
749
  | body | <code>Object</code> | | Body which has details for alert which needs to be acknowledged |
752
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
750
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
753
751
 
754
752
  More details - https://docs.atlas.mongodb.com/reference/api/alerts-acknowledge-alert/
755
753
 
@@ -763,7 +761,7 @@ Function - Returns the details of dataLake name passed.
763
761
  | Param | Type | Default | Description |
764
762
  | --- | --- | --- | --- |
765
763
  | dataLakeName | <code>String</code> | | name of the dataLake for which details needs to be retrieved |
766
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
764
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
767
765
 
768
766
  More details - https://docs.mongodb.com/datalake/reference/api/dataLakes-get-one-tenant/
769
767
 
@@ -774,7 +772,7 @@ Function - Returns all the dataLakes. Pagination can be controlled via options o
774
772
 
775
773
  | Param | Type | Default | Description |
776
774
  | --- | --- | --- | --- |
777
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
775
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
778
776
 
779
777
  More details - https://docs.mongodb.com/datalake/reference/api/dataLakes-get-all-tenants/
780
778
 
@@ -786,7 +784,7 @@ Function - Returns the dataLake logs stream.
786
784
  | Param | Type | Default | Description |
787
785
  | --- | --- | --- | --- |
788
786
  | dataLakeName | <code>String</code> | | name of the dataLake for which details needs to be retrieved |
789
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
787
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
790
788
 
791
789
  More details - https://docs.mongodb.com/datalake/reference/api/dataLakes-download-query-logs/
792
790
 
@@ -798,7 +796,7 @@ Function - Creates the dataLake as per body passed.
798
796
  | Param | Type | Default | Description |
799
797
  | --- | --- | --- | --- |
800
798
  | body | <code>Object</code> | | Body which has details for dataLake which needs to be created |
801
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
799
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
802
800
 
803
801
  More details - https://docs.mongodb.com/datalake/reference/api/dataLakes-create-one-tenant/
804
802
 
@@ -811,7 +809,7 @@ Function - Updates the dataLake for the username passed. It only updates the pro
811
809
  | --- | --- | --- | --- |
812
810
  | dataLakeName | <code>String</code> | | name of the dataLake for which details needs to be retrieved |
813
811
  | body | <code>Object</code> | | Body which has details for dataLake which needs to be updated |
814
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
812
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
815
813
 
816
814
  More details - https://docs.mongodb.com/datalake/reference/api/dataLakes-update-one-tenant/
817
815
 
@@ -823,7 +821,7 @@ Function - Deletes the dataLake name passed.
823
821
  | Param | Type | Default | Description |
824
822
  | --- | --- | --- | --- |
825
823
  | dataLakeName | <code>String</code> | | name of the datalake which needs to be deleted |
826
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
824
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
827
825
 
828
826
  More details - https://docs.mongodb.com/datalake/reference/api/dataLakes-delete-one-tenant/
829
827
 
@@ -836,7 +834,7 @@ Function - Returns all the cloudProviderAccess. Pagination can be controlled via
836
834
 
837
835
  | Param | Type | Default | Description |
838
836
  | --- | --- | --- | --- |
839
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
837
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
840
838
 
841
839
  More details - https://docs.atlas.mongodb.com/reference/api/cloud-provider-access-get-roles/
842
840
 
@@ -848,7 +846,7 @@ Function - Creates the cloudProviderAccess as per body passed.
848
846
  | Param | Type | Default | Description |
849
847
  | --- | --- | --- | --- |
850
848
  | body | <code>Object</code> | | Body which has details for cloudProviderAccess which needs to be created |
851
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
849
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
852
850
 
853
851
  More details - https://docs.atlas.mongodb.com/reference/api/cloud-provider-access-create-one-role/
854
852
 
@@ -861,7 +859,7 @@ Function - Updates the cloudProviderAccess for the roleId passed. It only update
861
859
  | --- | --- | --- | --- |
862
860
  | roleId | <code>String</code> | | roleId of the cloudProviderAccess for which details needs to be updated |
863
861
  | body | <code>Object</code> | | Body which has details for dataLake which needs to be updated |
864
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
862
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
865
863
 
866
864
  More details - https://docs.atlas.mongodb.com/reference/api/cloud-provider-access-authorize-one-role/
867
865
 
@@ -873,7 +871,7 @@ Function - Deletes the cloudProviderAccess name passed.
873
871
  | Param | Type | Default | Description |
874
872
  | --- | --- | --- | --- |
875
873
  | roleId | <code>String</code> | | roleId of the cloudProviderAccess which needs to be deleted |
876
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
874
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
877
875
 
878
876
  More details - https://docs.atlas.mongodb.com/reference/api/cloud-provider-access-deauthorize-one-role/
879
877
 
@@ -888,7 +886,7 @@ Function - Returns the details of atlas search index by cluster name and index p
888
886
  | --- | --- | --- | --- |
889
887
  | clusterName | <code>String</code> | | name of the cluster for which details needs to be retrieved |
890
888
  | indexId | <code>String</code> | | id of the index for which details needs to be retrieved |
891
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
889
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
892
890
 
893
891
  More details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-one/
894
892
 
@@ -902,7 +900,7 @@ Function - Returns all the atlas search indexes. Pagination can be controlled vi
902
900
  | clusterName | <code>String</code> | | name of the cluster for which details needs to be retrieved |
903
901
  | databaseName | <code>String</code> | | name of the database for which details needs to be retrieved |
904
902
  | collectionName | <code>String</code> | | name of the collection for which details needs to be retrieved |
905
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
903
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
906
904
 
907
905
  More details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/
908
906
 
@@ -914,7 +912,7 @@ Function - Returns all the Analyzers. Pagination can be controlled via options o
914
912
  | Param | Type | Default | Description |
915
913
  | --- | --- | --- | --- |
916
914
  | clusterName | <code>String</code> | | name of the cluster for which details needs to be retrieved |
917
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
915
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
918
916
 
919
917
  More details - https://docs.atlas.mongodb.com/reference/api/fts-analyzers-get-all/
920
918
 
@@ -927,7 +925,7 @@ Function - Creates the atlas search index as per body passed.
927
925
  | --- | --- | --- | --- |
928
926
  | clusterName | <code>String</code> | | name of the cluster for which details needs to be retrieved |
929
927
  | body | <code>Object</code> | | Body which has details for cluster which needs to be created |
930
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
928
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
931
929
 
932
930
  More details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-create-one/
933
931
 
@@ -941,7 +939,7 @@ Function - Updates the atlas search index for the clusterName passed. It only up
941
939
  | clusterName | <code>String</code> | | name of the cluster for which details needs to be updated |
942
940
  | indexId | <code>String</code> | | name of the index for which details needs to be updated |
943
941
  | body | <code>Object</code> | | Body which has details for cluster which needs to be updated |
944
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
942
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
945
943
 
946
944
  More details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-update-one/
947
945
 
@@ -954,7 +952,7 @@ Function - Upserts the analyser for the clusterName passed.
954
952
  | --- | --- | --- | --- |
955
953
  | clusterName | <code>String</code> | | name of the cluster for which details needs to be upserted |
956
954
  | body | <code>Object</code> | | Body which has details for cluster which needs to be upserted |
957
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
955
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
958
956
 
959
957
  More details - https://docs.atlas.mongodb.com/reference/api/fts-analyzers-update-all/
960
958
 
@@ -967,7 +965,7 @@ Function - Deletes the atlas search index by cluster name passed.
967
965
  | --- | --- | --- | --- |
968
966
  | clusterName | <code>String</code> | | name of the cluster which needs to be deleted |
969
967
  | indexId | <code>String</code> | | name of the index for which details needs to be deleted |
970
- | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
968
+ | [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api. It can also include httpOptions which will be sent to `urllib`. More info can be found here - https://github.com/node-modules/urllib |
971
969
 
972
970
  More details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-delete-one/
973
971