mongodb-atlas-api-client 2.30.0 → 3.0.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/.github/workflows/testcoverage.yml +46 -0
- package/README.md +80 -80
- package/package.json +6 -11
- package/src/alert.js +19 -16
- package/src/atlasSearch.js +43 -37
- package/src/atlasUser.js +31 -27
- package/src/cloudProviderAccess.js +26 -21
- package/src/cluster.js +49 -42
- package/src/customDbRole.js +31 -26
- package/src/dataLake.js +39 -37
- package/src/event.js +22 -20
- package/src/helper.js +11 -0
- package/src/httpClient.js +28 -0
- package/src/index.js +5 -6
- package/src/organization.js +41 -36
- package/src/project.js +46 -40
- package/src/projectAccesslist.js +31 -26
- package/src/projectWhitelist.js +31 -26
- package/src/user.js +31 -26
- package/test/alert.test.js +43 -0
- package/test/atlasSearch.test.js +91 -0
- package/test/dataLake.test.js +1 -2
- package/test/helper.test.js +38 -0
- package/.travis.yml +0 -6
package/README.md
CHANGED
|
@@ -2,11 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
A mongdb atlas api client for nodejs.
|
|
4
4
|
|
|
5
|
-
[](https://travis-ci.com/montumodi/mongodb-atlas-api-client)
|
|
8
|
-
[](https://david-dm.org/montumodi/mongodb-atlas-api-client#info=dependencies)
|
|
9
|
-
[](https://david-dm.org/montumodi/mongodb-atlas-api-client#info=devDependencies)
|
|
5
|
+
[](https://gist.github.com/montumodi/4863975b3d11c22536fcf9fcc8d237dd/raw/badge.svg)
|
|
6
|
+

|
|
10
7
|
|
|
11
8
|
[](https://www.npmjs.com/package/mongodb-atlas-api-client/)
|
|
12
9
|
|
|
@@ -18,9 +15,9 @@ npm install mongodb-atlas-api-client
|
|
|
18
15
|
|
|
19
16
|
## Getting Started
|
|
20
17
|
|
|
21
|
-
The basic syntax is
|
|
18
|
+
The basic syntax is
|
|
22
19
|
|
|
23
|
-
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)
|
|
24
21
|
|
|
25
22
|
```js
|
|
26
23
|
const getClient = require("mongodb-atlas-api-client");
|
|
@@ -34,7 +31,10 @@ const {user, cluster} = getClient({
|
|
|
34
31
|
const options = {
|
|
35
32
|
"envelope": true,
|
|
36
33
|
"itemsPerPage": 10,
|
|
37
|
-
"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
|
+
}
|
|
38
38
|
}
|
|
39
39
|
|
|
40
40
|
const response = await user.getAll(options); // get All users
|
|
@@ -76,7 +76,7 @@ Function - Returns the details of user name passed.
|
|
|
76
76
|
| Param | Type | Default | Description |
|
|
77
77
|
| --- | --- | --- | --- |
|
|
78
78
|
| username | <code>String</code> | | name of the user for which details needs to be retrieved |
|
|
79
|
-
| [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. |
|
|
80
80
|
|
|
81
81
|
More details - https://docs.atlas.mongodb.com/reference/api/database-users-get-single-user/
|
|
82
82
|
|
|
@@ -87,7 +87,7 @@ Function - Returns all the users. Pagination can be controlled via options objec
|
|
|
87
87
|
|
|
88
88
|
| Param | Type | Default | Description |
|
|
89
89
|
| --- | --- | --- | --- |
|
|
90
|
-
| [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 |
|
|
91
91
|
|
|
92
92
|
More details - https://docs.atlas.mongodb.com/reference/api/database-users-get-all-users/
|
|
93
93
|
|
|
@@ -99,7 +99,7 @@ Function - Creates the user as per body passed.
|
|
|
99
99
|
| Param | Type | Default | Description |
|
|
100
100
|
| --- | --- | --- | --- |
|
|
101
101
|
| body | <code>Object</code> | | Body which has details for user which needs to be created |
|
|
102
|
-
| [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 |
|
|
103
103
|
|
|
104
104
|
More details - https://docs.atlas.mongodb.com/reference/api/database-users-create-a-user/
|
|
105
105
|
|
|
@@ -112,7 +112,7 @@ Function - Updates the user for the username passed. It only updates the propert
|
|
|
112
112
|
| --- | --- | --- | --- |
|
|
113
113
|
| username | <code>String</code> | | name of the user for which details needs to be updated |
|
|
114
114
|
| body | <code>Object</code> | | Body which has details for user which needs to be updated |
|
|
115
|
-
| [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 |
|
|
116
116
|
|
|
117
117
|
More details - https://docs.atlas.mongodb.com/reference/api/database-users-update-a-user/
|
|
118
118
|
|
|
@@ -124,7 +124,7 @@ Function - Deletes the user name passed.
|
|
|
124
124
|
| Param | Type | Default | Description |
|
|
125
125
|
| --- | --- | --- | --- |
|
|
126
126
|
| username | <code>String</code> | | name of the user which needs to be deleted |
|
|
127
|
-
| [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 |
|
|
128
128
|
|
|
129
129
|
More details - https://docs.atlas.mongodb.com/reference/api/database-users-delete-a-user/
|
|
130
130
|
|
|
@@ -138,7 +138,7 @@ Function - Returns the details of cluster name passed.
|
|
|
138
138
|
| Param | Type | Default | Description |
|
|
139
139
|
| --- | --- | --- | --- |
|
|
140
140
|
| clustername | <code>String</code> | | name of the cluster for which details needs to be retrieved |
|
|
141
|
-
| [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 |
|
|
142
142
|
|
|
143
143
|
More details - https://docs.atlas.mongodb.com/reference/api/clusters-get-one/
|
|
144
144
|
|
|
@@ -149,7 +149,7 @@ Function - Returns all the clusters. Pagination can be controlled via options ob
|
|
|
149
149
|
|
|
150
150
|
| Param | Type | Default | Description |
|
|
151
151
|
| --- | --- | --- | --- |
|
|
152
|
-
| [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 |
|
|
153
153
|
|
|
154
154
|
More details - https://docs.atlas.mongodb.com/reference/api/clusters-get-all/
|
|
155
155
|
|
|
@@ -161,7 +161,7 @@ Function - Returns the advance configuration of cluster name passed.
|
|
|
161
161
|
| Param | Type | Default | Description |
|
|
162
162
|
| --- | --- | --- | --- |
|
|
163
163
|
| clustername | <code>String</code> | | name of the cluster for which advance configuration needs to be retrieved |
|
|
164
|
-
| [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 |
|
|
165
165
|
|
|
166
166
|
More details - https://docs.atlas.mongodb.com/reference/api/clusters-get-advanced-configuration-options/
|
|
167
167
|
|
|
@@ -173,7 +173,7 @@ Function - Creates the cluster as per body passed.
|
|
|
173
173
|
| Param | Type | Default | Description |
|
|
174
174
|
| --- | --- | --- | --- |
|
|
175
175
|
| body | <code>Object</code> | | Body which has details for cluster which needs to be created |
|
|
176
|
-
| [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 |
|
|
177
177
|
|
|
178
178
|
More details - https://docs.atlas.mongodb.com/reference/api/clusters-create-one/
|
|
179
179
|
|
|
@@ -186,7 +186,7 @@ Function - Updates the cluster for the clustername passed. It only updates the p
|
|
|
186
186
|
| --- | --- | --- | --- |
|
|
187
187
|
| clustername | <code>String</code> | | name of the cluster for which details needs to be updated |
|
|
188
188
|
| body | <code>Object</code> | | Body which has details for cluster which needs to be updated |
|
|
189
|
-
| [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 |
|
|
190
190
|
|
|
191
191
|
More details - https://docs.atlas.mongodb.com/reference/api/clusters-modify-one/
|
|
192
192
|
|
|
@@ -199,7 +199,7 @@ Function - Updates the advance configuration of cluster for the clustername pass
|
|
|
199
199
|
| --- | --- | --- | --- |
|
|
200
200
|
| clustername | <code>String</code> | | name of the cluster for which advance configuration needs to be updated |
|
|
201
201
|
| body | <code>Object</code> | | Body which has details for cluster which needs to be updated |
|
|
202
|
-
| [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 |
|
|
203
203
|
|
|
204
204
|
More details - https://docs.atlas.mongodb.com/reference/api/clusters-modify-advanced-configuration-options/
|
|
205
205
|
|
|
@@ -211,7 +211,7 @@ Function - Tests failure of primary replica set member.
|
|
|
211
211
|
| Param | Type | Default | Description |
|
|
212
212
|
| --- | --- | --- | --- |
|
|
213
213
|
| clustername | <code>String</code> | | name of the cluster for which failure needs to be tested |
|
|
214
|
-
| [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 |
|
|
215
215
|
|
|
216
216
|
More details - https://docs.atlas.mongodb.com/reference/api/clusters-test-failover/
|
|
217
217
|
|
|
@@ -223,7 +223,7 @@ Function - Deletes the cluster name passed.
|
|
|
223
223
|
| Param | Type | Default | Description |
|
|
224
224
|
| --- | --- | --- | --- |
|
|
225
225
|
| clustername | <code>String</code> | | name of the cluster which needs to be deleted |
|
|
226
|
-
| [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 |
|
|
227
227
|
|
|
228
228
|
More details - https://docs.atlas.mongodb.com/reference/api/clusters-delete-one/
|
|
229
229
|
|
|
@@ -237,7 +237,7 @@ Function - Returns the details of role name passed.
|
|
|
237
237
|
| Param | Type | Default | Description |
|
|
238
238
|
| --- | --- | --- | --- |
|
|
239
239
|
| rolename | <code>String</code> | | name of the role for which details needs to be retrieved |
|
|
240
|
-
| [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 |
|
|
241
241
|
|
|
242
242
|
More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-get-single-role/
|
|
243
243
|
|
|
@@ -248,7 +248,7 @@ Function - Returns all the roles. Pagination can be controlled via options objec
|
|
|
248
248
|
|
|
249
249
|
| Param | Type | Default | Description |
|
|
250
250
|
| --- | --- | --- | --- |
|
|
251
|
-
| [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 |
|
|
252
252
|
|
|
253
253
|
More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-get-all-roles/
|
|
254
254
|
|
|
@@ -260,7 +260,7 @@ Function - Creates the role as per body passed.
|
|
|
260
260
|
| Param | Type | Default | Description |
|
|
261
261
|
| --- | --- | --- | --- |
|
|
262
262
|
| body | <code>Object</code> | | Body which has details for role which needs to be created |
|
|
263
|
-
| [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 |
|
|
264
264
|
|
|
265
265
|
More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-create-a-role/
|
|
266
266
|
|
|
@@ -273,7 +273,7 @@ Function - Updates the role for the rolename passed. It only updates the propert
|
|
|
273
273
|
| --- | --- | --- | --- |
|
|
274
274
|
| rolename | <code>String</code> | | name of the role for which details needs to be updated |
|
|
275
275
|
| body | <code>Object</code> | | Body which has details for role which needs to be updated |
|
|
276
|
-
| [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 |
|
|
277
277
|
|
|
278
278
|
More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-update-a-role/
|
|
279
279
|
|
|
@@ -285,7 +285,7 @@ Function - Deletes the role name passed.
|
|
|
285
285
|
| Param | Type | Default | Description |
|
|
286
286
|
| --- | --- | --- | --- |
|
|
287
287
|
| rolename | <code>String</code> | | name of the role which needs to be deleted |
|
|
288
|
-
| [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 |
|
|
289
289
|
|
|
290
290
|
More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-delete-a-role/
|
|
291
291
|
|
|
@@ -299,7 +299,7 @@ Function - Returns the details of whitelistentry name passed.
|
|
|
299
299
|
| Param | Type | Default | Description |
|
|
300
300
|
| --- | --- | --- | --- |
|
|
301
301
|
| whitelistentry | <code>String</code> | | name of the whitelistentry for which details needs to be retrieved |
|
|
302
|
-
| [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 |
|
|
303
303
|
|
|
304
304
|
More details - https://docs.atlas.mongodb.com/reference/api/whitelist-get-one-entry/
|
|
305
305
|
|
|
@@ -310,7 +310,7 @@ Function - Returns all the whitelistentries. Pagination can be controlled via op
|
|
|
310
310
|
|
|
311
311
|
| Param | Type | Default | Description |
|
|
312
312
|
| --- | --- | --- | --- |
|
|
313
|
-
| [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 |
|
|
314
314
|
|
|
315
315
|
More details - https://docs.atlas.mongodb.com/reference/api/whitelist-get-all/
|
|
316
316
|
|
|
@@ -322,7 +322,7 @@ Function - Creates the whitelistentry as per body passed.
|
|
|
322
322
|
| Param | Type | Default | Description |
|
|
323
323
|
| --- | --- | --- | --- |
|
|
324
324
|
| body | <code>Object</code> | | Body which has details for whitelistentry which needs to be created |
|
|
325
|
-
| [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 |
|
|
326
326
|
|
|
327
327
|
More details - https://docs.atlas.mongodb.com/reference/api/whitelist-add-one/
|
|
328
328
|
|
|
@@ -334,7 +334,7 @@ Function - Updates the whitelistentry passed. It only updates the properties pas
|
|
|
334
334
|
| Param | Type | Default | Description |
|
|
335
335
|
| --- | --- | --- | --- |
|
|
336
336
|
| body | <code>Object</code> | | Body which has details for whitelistentry which needs to be updated |
|
|
337
|
-
| [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 |
|
|
338
338
|
|
|
339
339
|
More details - https://docs.atlas.mongodb.com/reference/api/whitelist-update-one/
|
|
340
340
|
|
|
@@ -346,7 +346,7 @@ Function - Deletes the whitelistentry name passed.
|
|
|
346
346
|
| Param | Type | Default | Description |
|
|
347
347
|
| --- | --- | --- | --- |
|
|
348
348
|
| whitelistentry | <code>String</code> | | name of the whitelistentry which needs to be deleted |
|
|
349
|
-
| [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 |
|
|
350
350
|
|
|
351
351
|
More details - https://docs.atlas.mongodb.com/reference/api/whitelist-delete-one/
|
|
352
352
|
|
|
@@ -360,7 +360,7 @@ Function - Returns the details of accesslistentry name passed.
|
|
|
360
360
|
| Param | Type | Default | Description |
|
|
361
361
|
| --- | --- | --- | --- |
|
|
362
362
|
| accesslistentry | <code>String</code> | | name of the accesslistentry for which details needs to be retrieved |
|
|
363
|
-
| [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 |
|
|
364
364
|
|
|
365
365
|
More details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/get-one-access-list-entry/
|
|
366
366
|
|
|
@@ -371,7 +371,7 @@ Function - Returns all the accesslistentries. Pagination can be controlled via o
|
|
|
371
371
|
|
|
372
372
|
| Param | Type | Default | Description |
|
|
373
373
|
| --- | --- | --- | --- |
|
|
374
|
-
| [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 |
|
|
375
375
|
|
|
376
376
|
More details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/get-all-access-list-entries/
|
|
377
377
|
|
|
@@ -383,7 +383,7 @@ Function - Creates the accesslistentry as per body passed.
|
|
|
383
383
|
| Param | Type | Default | Description |
|
|
384
384
|
| --- | --- | --- | --- |
|
|
385
385
|
| body | <code>Object</code> | | Body which has details for accesslistentry which needs to be created |
|
|
386
|
-
| [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 |
|
|
387
387
|
|
|
388
388
|
More details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/add-entries-to-access-list/
|
|
389
389
|
|
|
@@ -395,7 +395,7 @@ Function - Updates the accesslistentry passed. It only updates the properties pa
|
|
|
395
395
|
| Param | Type | Default | Description |
|
|
396
396
|
| --- | --- | --- | --- |
|
|
397
397
|
| body | <code>Object</code> | | Body which has details for accesslistentry which needs to be updated |
|
|
398
|
-
| [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 |
|
|
399
399
|
|
|
400
400
|
More details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/add-entries-to-access-list/
|
|
401
401
|
|
|
@@ -407,7 +407,7 @@ Function - Deletes the accesslistentry name passed.
|
|
|
407
407
|
| Param | Type | Default | Description |
|
|
408
408
|
| --- | --- | --- | --- |
|
|
409
409
|
| accesslistentry | <code>String</code> | | name of the accesslistentry which needs to be deleted |
|
|
410
|
-
| [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 |
|
|
411
411
|
|
|
412
412
|
More details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/delete-one-access-list-entry/
|
|
413
413
|
|
|
@@ -421,7 +421,7 @@ Function - Returns the details of project id passed.
|
|
|
421
421
|
| Param | Type | Default | Description |
|
|
422
422
|
| --- | --- | --- | --- |
|
|
423
423
|
| projectId | <code>String</code> | | project id for which details needs to be retrieved |
|
|
424
|
-
| [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 |
|
|
425
425
|
|
|
426
426
|
More details - https://docs.atlas.mongodb.com/reference/api/project-get-one/
|
|
427
427
|
|
|
@@ -433,7 +433,7 @@ Function - Returns the details of project name passed.
|
|
|
433
433
|
| Param | Type | Default | Description |
|
|
434
434
|
| --- | --- | --- | --- |
|
|
435
435
|
| projectId | <code>String</code> | | project name for which details needs to be retrieved |
|
|
436
|
-
| [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 |
|
|
437
437
|
|
|
438
438
|
More details - https://docs.atlas.mongodb.com/reference/api/project-get-one-by-name/
|
|
439
439
|
|
|
@@ -445,7 +445,7 @@ Function - Returns the teams of project id passed.
|
|
|
445
445
|
| Param | Type | Default | Description |
|
|
446
446
|
| --- | --- | --- | --- |
|
|
447
447
|
| projectId | <code>String</code> | | project id for which teams needs to be retrieved |
|
|
448
|
-
| [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 |
|
|
449
449
|
|
|
450
450
|
More details - https://docs.atlas.mongodb.com/reference/api/project-get-teams/
|
|
451
451
|
|
|
@@ -456,7 +456,7 @@ Function - Returns all the projects. Pagination can be controlled via options ob
|
|
|
456
456
|
|
|
457
457
|
| Param | Type | Default | Description |
|
|
458
458
|
| --- | --- | --- | --- |
|
|
459
|
-
| [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 |
|
|
460
460
|
|
|
461
461
|
More details - https://docs.atlas.mongodb.com/reference/api/project-get-all/
|
|
462
462
|
|
|
@@ -468,7 +468,7 @@ Function - Creates the project as per body passed.
|
|
|
468
468
|
| Param | Type | Default | Description |
|
|
469
469
|
| --- | --- | --- | --- |
|
|
470
470
|
| body | <code>Object</code> | | Body which has details for project which needs to be created |
|
|
471
|
-
| [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 |
|
|
472
472
|
|
|
473
473
|
More details - https://docs.atlas.mongodb.com/reference/api/project-create-one/
|
|
474
474
|
|
|
@@ -481,7 +481,7 @@ Function - Assigns the teams for the projectId passed. It only updates the prope
|
|
|
481
481
|
| --- | --- | --- | --- |
|
|
482
482
|
| projectId | <code>String</code> | | Id of the project for which teams needs to be associated |
|
|
483
483
|
| body | <code>Object</code> | | Body which has details for teams which needs to be associated |
|
|
484
|
-
| [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 |
|
|
485
485
|
|
|
486
486
|
More details - https://docs.atlas.mongodb.com/reference/api/project-add-team/
|
|
487
487
|
|
|
@@ -493,7 +493,7 @@ Function - Deletes the project id passed.
|
|
|
493
493
|
| Param | Type | Default | Description |
|
|
494
494
|
| --- | --- | --- | --- |
|
|
495
495
|
| projectId | <code>String</code> | | Id of the project which needs to be deleted |
|
|
496
|
-
| [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 |
|
|
497
497
|
|
|
498
498
|
More details - https://docs.atlas.mongodb.com/reference/api/project-delete-one/
|
|
499
499
|
|
|
@@ -506,7 +506,7 @@ Function - Removes the user id passed from the project.
|
|
|
506
506
|
| --- | --- | --- | --- |
|
|
507
507
|
| userId | <code>String</code> | | Id of the user which needs to be removed from project |
|
|
508
508
|
| projectId | <code>String</code> | | Id of the project |
|
|
509
|
-
| [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 |
|
|
510
510
|
|
|
511
511
|
More details - https://docs.atlas.mongodb.com/reference/api/project-remove-user/
|
|
512
512
|
|
|
@@ -520,7 +520,7 @@ Function - Returns the details of organization id passed.
|
|
|
520
520
|
| Param | Type | Default | Description |
|
|
521
521
|
| --- | --- | --- | --- |
|
|
522
522
|
| organizationId | <code>String</code> | | org§ id for which details needs to be retrieved |
|
|
523
|
-
| [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 |
|
|
524
524
|
|
|
525
525
|
More details - https://docs.atlas.mongodb.com/reference/api/organization-get-one/
|
|
526
526
|
|
|
@@ -532,7 +532,7 @@ Function - Returns all the users for organization id passed.
|
|
|
532
532
|
| Param | Type | Default | Description |
|
|
533
533
|
| --- | --- | --- | --- |
|
|
534
534
|
| organizationId | <code>String</code> | | organization id for which users needs to be retrieved |
|
|
535
|
-
| [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 |
|
|
536
536
|
|
|
537
537
|
More details - https://docs.atlas.mongodb.com/reference/api/organization-users-get-all-users/
|
|
538
538
|
|
|
@@ -544,7 +544,7 @@ Function - Returns all the projects for organization id passed.
|
|
|
544
544
|
| Param | Type | Default | Description |
|
|
545
545
|
| --- | --- | --- | --- |
|
|
546
546
|
| organizationId | <code>String</code> | | organization id for which projects needs to be retrieved |
|
|
547
|
-
| [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 |
|
|
548
548
|
|
|
549
549
|
More details - https://docs.atlas.mongodb.com/reference/api/organization-get-all-projects/
|
|
550
550
|
|
|
@@ -555,7 +555,7 @@ Function - Returns all the organizations. Pagination can be controlled via optio
|
|
|
555
555
|
|
|
556
556
|
| Param | Type | Default | Description |
|
|
557
557
|
| --- | --- | --- | --- |
|
|
558
|
-
| [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 |
|
|
559
559
|
|
|
560
560
|
More details - https://docs.atlas.mongodb.com/reference/api/organization-get-all/
|
|
561
561
|
|
|
@@ -568,7 +568,7 @@ Function - Renames the organization
|
|
|
568
568
|
| --- | --- | --- | --- |
|
|
569
569
|
| organizationId | <code>String</code> | | Id of the organization for which needs to be renamed |
|
|
570
570
|
| body | <code>Object</code> | | Body which has details for organization which needs to be renamed |
|
|
571
|
-
| [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 |
|
|
572
572
|
|
|
573
573
|
More details - https://docs.atlas.mongodb.com/reference/api/organization-rename/
|
|
574
574
|
|
|
@@ -584,7 +584,7 @@ Function - Sends an invitation to the given email (username) to join the Organiz
|
|
|
584
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. |
|
|
585
585
|
| body.teamIds | <code>string[]</code> | | *(Optional)* Unique 24-hexadecimal digit strings that identify the teams that you invite the user to join.
|
|
586
586
|
| body.username | <code>string</code> | | Email address of the invited user. This is the address to which Atlas sends the invite.
|
|
587
|
-
| [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 |
|
|
588
588
|
|
|
589
589
|
More details - https://docs.atlas.mongodb.com/reference/api/organization-create-one-invitation/
|
|
590
590
|
|
|
@@ -597,7 +597,7 @@ Function - Deletes the project id passed.
|
|
|
597
597
|
| Param | Type | Default | Description |
|
|
598
598
|
| --- | --- | --- | --- |
|
|
599
599
|
| organizationId | <code>String</code> | | Id of the organization which needs to be deleted |
|
|
600
|
-
| [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 |
|
|
601
601
|
|
|
602
602
|
More details - https://docs.atlas.mongodb.com/reference/api/organization-delete-one/
|
|
603
603
|
|
|
@@ -611,7 +611,7 @@ Function - Returns the details of user id passed.
|
|
|
611
611
|
| Param | Type | Default | Description |
|
|
612
612
|
| --- | --- | --- | --- |
|
|
613
613
|
| userId | <code>String</code> | | Id of the user for which details needs to be retrieved |
|
|
614
|
-
| [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 |
|
|
615
615
|
|
|
616
616
|
More details - https://docs.atlas.mongodb.com/reference/api/user-get-by-id/
|
|
617
617
|
|
|
@@ -623,7 +623,7 @@ Function - Returns the details of user name passed.
|
|
|
623
623
|
| Param | Type | Default | Description |
|
|
624
624
|
| --- | --- | --- | --- |
|
|
625
625
|
| username | <code>String</code> | | Name of the user for which details needs to be retrieved |
|
|
626
|
-
| [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 |
|
|
627
627
|
|
|
628
628
|
More details - https://docs.atlas.mongodb.com/reference/api/user-get-one-by-name/
|
|
629
629
|
|
|
@@ -634,7 +634,7 @@ Function - Returns all the users. Pagination can be controlled via options objec
|
|
|
634
634
|
|
|
635
635
|
| Param | Type | Default | Description |
|
|
636
636
|
| --- | --- | --- | --- |
|
|
637
|
-
| [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 |
|
|
638
638
|
|
|
639
639
|
More details - https://docs.atlas.mongodb.com/reference/api/user-get-all/
|
|
640
640
|
|
|
@@ -646,7 +646,7 @@ Function - Creates the atlas user as per body passed.
|
|
|
646
646
|
| Param | Type | Default | Description |
|
|
647
647
|
| --- | --- | --- | --- |
|
|
648
648
|
| body | <code>Object</code> | | Body which has details for atlas user which needs to be created |
|
|
649
|
-
| [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 |
|
|
650
650
|
|
|
651
651
|
More details - https://docs.atlas.mongodb.com/reference/api/user-create/
|
|
652
652
|
|
|
@@ -659,7 +659,7 @@ Function - Updates the user for the userId passed. It only updates the propertie
|
|
|
659
659
|
| --- | --- | --- | --- |
|
|
660
660
|
| userId | <code>String</code> | | Id of the user for which details needs to be updated |
|
|
661
661
|
| body | <code>Object</code> | | Body which has details for user which needs to be updated |
|
|
662
|
-
| [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 |
|
|
663
663
|
|
|
664
664
|
More details - https://docs.atlas.mongodb.com/reference/api/user-update/
|
|
665
665
|
|
|
@@ -673,7 +673,7 @@ Function - Returns the details of event id passed.
|
|
|
673
673
|
| Param | Type | Default | Description |
|
|
674
674
|
| --- | --- | --- | --- |
|
|
675
675
|
| eventId | <code>String</code> | | id of the event for which details needs to be retrieved |
|
|
676
|
-
| [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 |
|
|
677
677
|
|
|
678
678
|
More details - https://docs.atlas.mongodb.com/reference/api/events-projects-get-one/
|
|
679
679
|
|
|
@@ -684,7 +684,7 @@ Function - Returns all the events. Pagination can be controlled via options obje
|
|
|
684
684
|
|
|
685
685
|
| Param | Type | Default | Description |
|
|
686
686
|
| --- | --- | --- | --- |
|
|
687
|
-
| [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 |
|
|
688
688
|
|
|
689
689
|
More details - https://docs.atlas.mongodb.com/reference/api/events-projects-get-all/
|
|
690
690
|
|
|
@@ -697,7 +697,7 @@ Function - Returns the details of event id passed for organization id.
|
|
|
697
697
|
| --- | --- | --- | --- |
|
|
698
698
|
| organizationId | <code>String</code> | | id of the organization for which details needs to be retrieved |
|
|
699
699
|
| eventId | <code>String</code> | | id of the event for which details needs to be retrieved |
|
|
700
|
-
| [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 |
|
|
701
701
|
|
|
702
702
|
More details - https://docs.atlas.mongodb.com/reference/api/events-orgs-get-one/
|
|
703
703
|
|
|
@@ -709,7 +709,7 @@ Function - Returns all the events. Pagination can be controlled via options obje
|
|
|
709
709
|
| Param | Type | Default | Description |
|
|
710
710
|
| --- | --- | --- | --- |
|
|
711
711
|
| organizationId | <code>String</code> | | id of the organization for which details needs to be retrieved |
|
|
712
|
-
| [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 |
|
|
713
713
|
|
|
714
714
|
More details - https://docs.atlas.mongodb.com/reference/api/events-orgs-get-all/
|
|
715
715
|
|
|
@@ -723,7 +723,7 @@ Function - Returns the details of alert id passed.
|
|
|
723
723
|
| Param | Type | Default | Description |
|
|
724
724
|
| --- | --- | --- | --- |
|
|
725
725
|
| alertId | <code>String</code> | | id of the alert for which details needs to be retrieved |
|
|
726
|
-
| [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 |
|
|
727
727
|
|
|
728
728
|
More details - https://docs.atlas.mongodb.com/reference/api/alerts-get-alert/
|
|
729
729
|
|
|
@@ -734,7 +734,7 @@ Function - Returns all the alerts. Pagination can be controlled via options obje
|
|
|
734
734
|
|
|
735
735
|
| Param | Type | Default | Description |
|
|
736
736
|
| --- | --- | --- | --- |
|
|
737
|
-
| [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 |
|
|
738
738
|
|
|
739
739
|
More details - https://docs.atlas.mongodb.com/reference/api/alerts-get-all-alerts/
|
|
740
740
|
|
|
@@ -747,7 +747,7 @@ Function - Acknowledge or unacknowledge an alert
|
|
|
747
747
|
| --- | --- | --- | --- |
|
|
748
748
|
| alertId | <code>String</code> | | id of the alert which needs to be acknowledged |
|
|
749
749
|
| body | <code>Object</code> | | Body which has details for alert which needs to be acknowledged |
|
|
750
|
-
| [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 |
|
|
751
751
|
|
|
752
752
|
More details - https://docs.atlas.mongodb.com/reference/api/alerts-acknowledge-alert/
|
|
753
753
|
|
|
@@ -761,7 +761,7 @@ Function - Returns the details of dataLake name passed.
|
|
|
761
761
|
| Param | Type | Default | Description |
|
|
762
762
|
| --- | --- | --- | --- |
|
|
763
763
|
| dataLakeName | <code>String</code> | | name of the dataLake for which details needs to be retrieved |
|
|
764
|
-
| [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 |
|
|
765
765
|
|
|
766
766
|
More details - https://docs.mongodb.com/datalake/reference/api/dataLakes-get-one-tenant/
|
|
767
767
|
|
|
@@ -772,7 +772,7 @@ Function - Returns all the dataLakes. Pagination can be controlled via options o
|
|
|
772
772
|
|
|
773
773
|
| Param | Type | Default | Description |
|
|
774
774
|
| --- | --- | --- | --- |
|
|
775
|
-
| [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 |
|
|
776
776
|
|
|
777
777
|
More details - https://docs.mongodb.com/datalake/reference/api/dataLakes-get-all-tenants/
|
|
778
778
|
|
|
@@ -784,7 +784,7 @@ Function - Returns the dataLake logs stream.
|
|
|
784
784
|
| Param | Type | Default | Description |
|
|
785
785
|
| --- | --- | --- | --- |
|
|
786
786
|
| dataLakeName | <code>String</code> | | name of the dataLake for which details needs to be retrieved |
|
|
787
|
-
| [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 |
|
|
788
788
|
|
|
789
789
|
More details - https://docs.mongodb.com/datalake/reference/api/dataLakes-download-query-logs/
|
|
790
790
|
|
|
@@ -796,7 +796,7 @@ Function - Creates the dataLake as per body passed.
|
|
|
796
796
|
| Param | Type | Default | Description |
|
|
797
797
|
| --- | --- | --- | --- |
|
|
798
798
|
| body | <code>Object</code> | | Body which has details for dataLake which needs to be created |
|
|
799
|
-
| [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 |
|
|
800
800
|
|
|
801
801
|
More details - https://docs.mongodb.com/datalake/reference/api/dataLakes-create-one-tenant/
|
|
802
802
|
|
|
@@ -809,7 +809,7 @@ Function - Updates the dataLake for the username passed. It only updates the pro
|
|
|
809
809
|
| --- | --- | --- | --- |
|
|
810
810
|
| dataLakeName | <code>String</code> | | name of the dataLake for which details needs to be retrieved |
|
|
811
811
|
| body | <code>Object</code> | | Body which has details for dataLake which needs to be updated |
|
|
812
|
-
| [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 |
|
|
813
813
|
|
|
814
814
|
More details - https://docs.mongodb.com/datalake/reference/api/dataLakes-update-one-tenant/
|
|
815
815
|
|
|
@@ -821,7 +821,7 @@ Function - Deletes the dataLake name passed.
|
|
|
821
821
|
| Param | Type | Default | Description |
|
|
822
822
|
| --- | --- | --- | --- |
|
|
823
823
|
| dataLakeName | <code>String</code> | | name of the datalake which needs to be deleted |
|
|
824
|
-
| [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 |
|
|
825
825
|
|
|
826
826
|
More details - https://docs.mongodb.com/datalake/reference/api/dataLakes-delete-one-tenant/
|
|
827
827
|
|
|
@@ -834,7 +834,7 @@ Function - Returns all the cloudProviderAccess. Pagination can be controlled via
|
|
|
834
834
|
|
|
835
835
|
| Param | Type | Default | Description |
|
|
836
836
|
| --- | --- | --- | --- |
|
|
837
|
-
| [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 |
|
|
838
838
|
|
|
839
839
|
More details - https://docs.atlas.mongodb.com/reference/api/cloud-provider-access-get-roles/
|
|
840
840
|
|
|
@@ -846,7 +846,7 @@ Function - Creates the cloudProviderAccess as per body passed.
|
|
|
846
846
|
| Param | Type | Default | Description |
|
|
847
847
|
| --- | --- | --- | --- |
|
|
848
848
|
| body | <code>Object</code> | | Body which has details for cloudProviderAccess which needs to be created |
|
|
849
|
-
| [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 |
|
|
850
850
|
|
|
851
851
|
More details - https://docs.atlas.mongodb.com/reference/api/cloud-provider-access-create-one-role/
|
|
852
852
|
|
|
@@ -859,7 +859,7 @@ Function - Updates the cloudProviderAccess for the roleId passed. It only update
|
|
|
859
859
|
| --- | --- | --- | --- |
|
|
860
860
|
| roleId | <code>String</code> | | roleId of the cloudProviderAccess for which details needs to be updated |
|
|
861
861
|
| body | <code>Object</code> | | Body which has details for dataLake which needs to be updated |
|
|
862
|
-
| [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 |
|
|
863
863
|
|
|
864
864
|
More details - https://docs.atlas.mongodb.com/reference/api/cloud-provider-access-authorize-one-role/
|
|
865
865
|
|
|
@@ -871,7 +871,7 @@ Function - Deletes the cloudProviderAccess name passed.
|
|
|
871
871
|
| Param | Type | Default | Description |
|
|
872
872
|
| --- | --- | --- | --- |
|
|
873
873
|
| roleId | <code>String</code> | | roleId of the cloudProviderAccess which needs to be deleted |
|
|
874
|
-
| [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 |
|
|
875
875
|
|
|
876
876
|
More details - https://docs.atlas.mongodb.com/reference/api/cloud-provider-access-deauthorize-one-role/
|
|
877
877
|
|
|
@@ -886,7 +886,7 @@ Function - Returns the details of atlas search index by cluster name and index p
|
|
|
886
886
|
| --- | --- | --- | --- |
|
|
887
887
|
| clusterName | <code>String</code> | | name of the cluster for which details needs to be retrieved |
|
|
888
888
|
| indexId | <code>String</code> | | id of the index for which details needs to be retrieved |
|
|
889
|
-
| [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 |
|
|
890
890
|
|
|
891
891
|
More details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-one/
|
|
892
892
|
|
|
@@ -900,7 +900,7 @@ Function - Returns all the atlas search indexes. Pagination can be controlled vi
|
|
|
900
900
|
| clusterName | <code>String</code> | | name of the cluster for which details needs to be retrieved |
|
|
901
901
|
| databaseName | <code>String</code> | | name of the database for which details needs to be retrieved |
|
|
902
902
|
| collectionName | <code>String</code> | | name of the collection for which details needs to be retrieved |
|
|
903
|
-
| [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 |
|
|
904
904
|
|
|
905
905
|
More details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/
|
|
906
906
|
|
|
@@ -912,7 +912,7 @@ Function - Returns all the Analyzers. Pagination can be controlled via options o
|
|
|
912
912
|
| Param | Type | Default | Description |
|
|
913
913
|
| --- | --- | --- | --- |
|
|
914
914
|
| clusterName | <code>String</code> | | name of the cluster for which details needs to be retrieved |
|
|
915
|
-
| [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 |
|
|
916
916
|
|
|
917
917
|
More details - https://docs.atlas.mongodb.com/reference/api/fts-analyzers-get-all/
|
|
918
918
|
|
|
@@ -925,7 +925,7 @@ Function - Creates the atlas search index as per body passed.
|
|
|
925
925
|
| --- | --- | --- | --- |
|
|
926
926
|
| clusterName | <code>String</code> | | name of the cluster for which details needs to be retrieved |
|
|
927
927
|
| body | <code>Object</code> | | Body which has details for cluster which needs to be created |
|
|
928
|
-
| [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 |
|
|
929
929
|
|
|
930
930
|
More details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-create-one/
|
|
931
931
|
|
|
@@ -939,7 +939,7 @@ Function - Updates the atlas search index for the clusterName passed. It only up
|
|
|
939
939
|
| clusterName | <code>String</code> | | name of the cluster for which details needs to be updated |
|
|
940
940
|
| indexId | <code>String</code> | | name of the index for which details needs to be updated |
|
|
941
941
|
| body | <code>Object</code> | | Body which has details for cluster which needs to be updated |
|
|
942
|
-
| [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 |
|
|
943
943
|
|
|
944
944
|
More details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-update-one/
|
|
945
945
|
|
|
@@ -952,7 +952,7 @@ Function - Upserts the analyser for the clusterName passed.
|
|
|
952
952
|
| --- | --- | --- | --- |
|
|
953
953
|
| clusterName | <code>String</code> | | name of the cluster for which details needs to be upserted |
|
|
954
954
|
| body | <code>Object</code> | | Body which has details for cluster which needs to be upserted |
|
|
955
|
-
| [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 |
|
|
956
956
|
|
|
957
957
|
More details - https://docs.atlas.mongodb.com/reference/api/fts-analyzers-update-all/
|
|
958
958
|
|
|
@@ -965,7 +965,7 @@ Function - Deletes the atlas search index by cluster name passed.
|
|
|
965
965
|
| --- | --- | --- | --- |
|
|
966
966
|
| clusterName | <code>String</code> | | name of the cluster which needs to be deleted |
|
|
967
967
|
| indexId | <code>String</code> | | name of the index for which details needs to be deleted |
|
|
968
|
-
| [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 |
|
|
969
969
|
|
|
970
970
|
More details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-delete-one/
|
|
971
971
|
|