Mongodb atlas api client

A mongdb atlas api client for nodejs.

How to install

npm install mongodb-atlas-api-client

Getting Started

The basic syntax is:

const getClient = require("mongodb-atlas-api-client");
const {user, cluster} = getClient({
  "publicKey": "some public key",
  "privateKey": "some private key",
  "baseUrl": "https://cloud.mongodb.com/api/atlas/v1.0",
  "projectId": "some project/group id"
});

const options = {
  "envelope": true,
  "itemsPerPage": 10,
  "pretty": true
}

const response = await user.getAll(options); // get All users
const response = await cluster.get("someClusterName"); // get single cluster
const response = await user.delete("someUserName", options); // delete single user
const response = await user.create(body, options); // create user
const response = await user.update("someUserName", body, options); // update user

Running the tests

npm test

API

user.get(username, [options]) ⇒ Promise

Function - Returns the details of user name passed.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/database-users-get-single-user/

user.getAll([options]) ⇒ Promise

Function - Returns all the users. Pagination can be controlled via options object.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/database-users-get-all-users/

user.create(body, [options]) ⇒ Promise

Function - Creates the user as per body passed.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/database-users-create-a-user/

user.update(username, body, [options]) ⇒ Promise

Function - Updates the user for the username passed. It only updates the properties passed in body.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/database-users-update-a-user/

user.delete(username, [options]) ⇒ Promise

Function - Deletes the user name passed.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/database-users-delete-a-user/

cluster.get(clustername, [options]) ⇒ Promise

Function - Returns the details of cluster name passed.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/clusters-get-one/

cluster.getAll([options]) ⇒ Promise

Function - Returns all the clusters. Pagination can be controlled via options object.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/clusters-get-all/

cluster.getAdvanceConfiguration(clustername, [options]) ⇒ Promise

Function - Returns the advance configuration of cluster name passed.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/clusters-get-advanced-configuration-options/

cluster.create(body, [options]) ⇒ Promise

Function - Creates the cluster as per body passed.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/clusters-create-one/

cluster.update(clustername, body, [options]) ⇒ Promise

Function - Updates the cluster for the clustername passed. It only updates the properties passed in body.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/clusters-modify-one/

cluster.updateAdvanceConfiguration(clustername, body, [options]) ⇒ Promise

Function - Updates the advance configuration of cluster for the clustername passed. It only updates the properties passed in body.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/clusters-modify-advanced-configuration-options/

cluster.testPrimaryFailOver(clustername, [options]) ⇒ Promise

Function - Tests failure of primary replica set member.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/clusters-test-failover/

cluster.delete(clustername, [options]) ⇒ Promise

Function - Deletes the cluster name passed.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/clusters-delete-one/

customDbRole.get(rolename, [options]) ⇒ Promise

Function - Returns the details of role name passed.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-get-single-role/

customDbRole.getAll([options]) ⇒ Promise

Function - Returns all the roles. Pagination can be controlled via options object.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-get-all-roles/

customDbRole.create(body, [options]) ⇒ Promise

Function - Creates the role as per body passed.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-create-a-role/

customDbRole.update(rolename, body, [options]) ⇒ Promise

Function - Updates the role for the rolename passed. It only updates the properties passed in body.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-update-a-role/

customDbRole.delete(rolename, [options]) ⇒ Promise

Function - Deletes the role name passed.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-delete-a-role/

projectWhitelist.get(whitelistentry, [options]) ⇒ Promise

Function - Returns the details of whitelistentry name passed.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/whitelist-get-one-entry/

projectWhitelist.getAll([options]) ⇒ Promise

Function - Returns all the whitelistentries. Pagination can be controlled via options object.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/whitelist-get-all/

projectWhitelist.create(body, [options]) ⇒ Promise

Function - Creates the whitelistentry as per body passed.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/whitelist-add-one/

projectWhitelist.update(body, [options]) ⇒ Promise

Function - Updates the whitelistentry passed. It only updates the properties passed in body.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/whitelist-update-one/

projectWhitelist.delete(whitelistentry, [options]) ⇒ Promise

Function - Deletes the whitelistentry name passed.

Returns: Promise - - promise which resolves on success and rejects on error

More details - https://docs.atlas.mongodb.com/reference/api/whitelist-delete-one/