{"id":28089086,"url":"https://github.com/montumodi/mongodb-atlas-api-client","last_synced_at":"2025-05-13T12:53:39.922Z","repository":{"id":36699581,"uuid":"229757177","full_name":"montumodi/mongodb-atlas-api-client","owner":"montumodi","description":"A mongdb atlas api client for nodejs.","archived":false,"fork":false,"pushed_at":"2024-12-24T13:05:51.000Z","size":1272,"stargazers_count":19,"open_issues_count":1,"forks_count":12,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-02T15:01:52.549Z","etag":null,"topics":["api","atlas","client","javascript","mongodb","mongodb-atlas","mongodb-atlas-api","node","nodejs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/montumodi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-12-23T13:22:55.000Z","updated_at":"2025-01-07T16:51:42.000Z","dependencies_parsed_at":"2023-02-17T04:45:32.471Z","dependency_job_id":"2d7d150b-377f-49fa-aae6-aab401abeaf0","html_url":"https://github.com/montumodi/mongodb-atlas-api-client","commit_stats":null,"previous_names":[],"tags_count":59,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/montumodi%2Fmongodb-atlas-api-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/montumodi%2Fmongodb-atlas-api-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/montumodi%2Fmongodb-atlas-api-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/montumodi%2Fmongodb-atlas-api-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/montumodi","download_url":"https://codeload.github.com/montumodi/mongodb-atlas-api-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253948110,"owners_count":21988951,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","atlas","client","javascript","mongodb","mongodb-atlas","mongodb-atlas-api","node","nodejs"],"created_at":"2025-05-13T12:53:39.163Z","updated_at":"2025-05-13T12:53:39.902Z","avatar_url":"https://github.com/montumodi.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mongodb atlas api client for NODEJS\n\nA mongdb atlas api client for nodejs.\n\n[![Coverage Status](https://gist.github.com/montumodi/4863975b3d11c22536fcf9fcc8d237dd/raw/badge.svg)](https://gist.github.com/montumodi/4863975b3d11c22536fcf9fcc8d237dd/raw/badge.svg)\n![NPM Publish](https://github.com/montumodi/mongodb-atlas-api-client/actions/workflows/.github/workflows/npmpublish.yml/badge.svg)\n\n[![NPM](https://nodei.co/npm/mongodb-atlas-api-client.png?downloads=true)](https://www.npmjs.com/package/mongodb-atlas-api-client/)\n\n## How to install\n\n```\nnpm install mongodb-atlas-api-client\n```\n\n## Getting Started\n\nThe basic syntax is\n\nAtlas 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)\n\n```js\nconst getClient = require(\"mongodb-atlas-api-client\");\nconst {user, cluster} = getClient({\n  \"publicKey\": \"some public key\",\n  \"privateKey\": \"some private key\",\n  \"baseUrl\": \"https://cloud.mongodb.com/api/atlas/v1.0\",\n  \"projectId\": \"some project/group id\"\n});\n\nconst options = {\n  \"envelope\": true,\n  \"itemsPerPage\": 10,\n  \"pretty\": true,\n  \"httpOptions\": { // This parameter will not be sent as querystring. This will be send to http request package `urllib`\n    \"timeout\": 5000\n  }\n}\n\nconst response = await user.getAll(options); // get All users\nconst response = await cluster.get(\"someClusterName\"); // get single cluster\nconst response = await user.delete(\"someUserName\", options); // delete single user\nconst response = await user.create(body, options); // create user\nconst response = await user.update(\"someUserName\", body, options); // update user\n\n```\n\n## Running the tests\n\n`npm test`\n\n### API\n\nFollowing entities are currently supported\n\n- [User](#user)\n- [CloudBackup](#cloudbackup)\n- [Cluster](#cluster)\n- [CustomDbRole](#customdbrole)\n- [ProjectWhitelist](#projectwhitelist)\n- [ProjectAccesslist](#projectaccesslist)\n- [Project](#project)\n- [Organization](#organization)\n- [AtlasUser](#atlasuser)\n- [Event](#event)\n- [Alert](#alert)\n- [DataLake](#datalake)\n- [AtlasSearch](#atlassearch)\n\n### User\n\n### user.get(username, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the details of user name passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| username | \u003ccode\u003eString\u003c/code\u003e |  | name of the user for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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. |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/database-users-get-single-user/\n\n### user.getAll([options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns all the users. Pagination can be controlled via options object.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/database-users-get-all-users/\n\n### user.create(body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Creates the user as per body passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for user which needs to be created |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/database-users-create-a-user/\n\n### user.update(username, body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Updates the user for the username passed. It only updates the properties passed in body.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| username | \u003ccode\u003eString\u003c/code\u003e |  | name of the user for which details needs to be updated |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for user which needs to be updated |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/database-users-update-a-user/\n\n### user.delete(username, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Deletes the user name passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| username | \u003ccode\u003eString\u003c/code\u003e |  | name of the user which needs to be deleted |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/database-users-delete-a-user/\n\n### CloudBackup\n\n### cloudBackup.getReplicaSetCloudBackup(clustername, snapshotId, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the details of the specified snapshotId.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| clustername | \u003ccode\u003eString\u003c/code\u003e |  | name of the cluster for which details needs to be retrieved |\n| snapshotId | \u003ccode\u003eString\u003c/code\u003e |  | Id of the snapshot for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/getReplicaSetBackup\n\n### cloudBackup.getAllReplicaSetCloudBackups(clustername, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the details of all snapshots of an specified clustername.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| clustername | \u003ccode\u003eString\u003c/code\u003e |  | name of the cluster for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/listReplicaSetBackups\n\n### cloudBackup.getSnapshotRestoreJob(clustername, restoreJobId, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the details of all snapshots of an specified clustername.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| clustername | \u003ccode\u003eString\u003c/code\u003e |  | name of the cluster for which details needs to be retrieved |\n| restoreJobId | \u003ccode\u003eString\u003c/code\u003e |  | snapshot restore job id for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/getBackupRestoreJob\n\n### cloudBackup.createSnapshotRestoreJob(clustername, body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the details of all snapshots of an specified clustername.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| clustername | \u003ccode\u003eString\u003c/code\u003e |  | name of the cluster for which details needs to be retrieved |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for snapshot restore job which needs to be created |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/createBackupRestoreJob\n\n### Cluster\n\n### cluster.get(clustername, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the details of cluster name passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| clustername | \u003ccode\u003eString\u003c/code\u003e |  | name of the cluster for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/clusters-get-one/\n\n### cluster.getAll([options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns all the clusters. Pagination can be controlled via options object.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/clusters-get-all/\n\n### cluster.getAdvanceConfiguration(clustername, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the advance configuration of cluster name passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| clustername | \u003ccode\u003eString\u003c/code\u003e |  | name of the cluster for which advance configuration needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/clusters-get-advanced-configuration-options/\n\n### cluster.create(body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Creates the cluster as per body passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for cluster which needs to be created |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/clusters-create-one/\n\n### cluster.update(clustername, body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Updates the cluster for the clustername passed. It only updates the properties passed in body.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| clustername | \u003ccode\u003eString\u003c/code\u003e |  | name of the cluster for which details needs to be updated |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for cluster which needs to be updated |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/clusters-modify-one/\n\n### cluster.updateAdvanceConfiguration(clustername, body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Updates the advance configuration of cluster for the clustername passed. It only updates the properties passed in body.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| clustername | \u003ccode\u003eString\u003c/code\u003e |  | name of the cluster for which advance configuration needs to be updated |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for cluster which needs to be updated |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/clusters-modify-advanced-configuration-options/\n\n### cluster.testPrimaryFailOver(clustername, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Tests failure of primary replica set member.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| clustername | \u003ccode\u003eString\u003c/code\u003e |  | name of the cluster for which failure needs to be tested |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/clusters-test-failover/\n\n### cluster.delete(clustername, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Deletes the cluster name passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| clustername | \u003ccode\u003eString\u003c/code\u003e |  | name of the cluster which needs to be deleted |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/clusters-delete-one/\n\n### CustomDbRole\n\n### customDbRole.get(rolename, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the details of role name passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| rolename | \u003ccode\u003eString\u003c/code\u003e |  | name of the role for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/custom-roles-get-single-role/\n\n### customDbRole.getAll([options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns all the roles. Pagination can be controlled via options object.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/custom-roles-get-all-roles/\n\n### customDbRole.create(body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Creates the role as per body passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for role which needs to be created |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/custom-roles-create-a-role/\n\n### customDbRole.update(rolename, body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Updates the role for the rolename passed. It only updates the properties passed in body.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| rolename | \u003ccode\u003eString\u003c/code\u003e |  | name of the role for which details needs to be updated |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for role which needs to be updated |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/custom-roles-update-a-role/\n\n### customDbRole.delete(rolename, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Deletes the role name passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| rolename | \u003ccode\u003eString\u003c/code\u003e |  | name of the role which needs to be deleted |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/custom-roles-delete-a-role/\n\n### ProjectWhitelist\n\n### projectWhitelist.get(whitelistentry, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the details of whitelistentry name passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| whitelistentry | \u003ccode\u003eString\u003c/code\u003e |  | name of the whitelistentry for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/whitelist-get-one-entry/\n\n### projectWhitelist.getAll([options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns all the whitelistentries. Pagination can be controlled via options object.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/whitelist-get-all/\n\n### projectWhitelist.create(body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Creates the whitelistentry as per body passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for whitelistentry which needs to be created |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/whitelist-add-one/\n\n### projectWhitelist.update(body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Updates the whitelistentry passed. It only updates the properties passed in body.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for whitelistentry which needs to be updated |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/whitelist-update-one/\n\n### projectWhitelist.delete(whitelistentry, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Deletes the whitelistentry name passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| whitelistentry | \u003ccode\u003eString\u003c/code\u003e |  | name of the whitelistentry which needs to be deleted |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/whitelist-delete-one/\n\n### ProjectAccesslist\n\n### projectAccesslist.get(accesslistentry, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the details of accesslistentry name passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error\n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| accesslistentry | \u003ccode\u003eString\u003c/code\u003e |  | name of the accesslistentry for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/get-one-access-list-entry/\n\n### projectAccesslist.getAll([options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns all the accesslistentries. Pagination can be controlled via options object.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error\n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/get-all-access-list-entries/\n\n### projectAccesslist.create(body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Creates the accesslistentry as per body passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error\n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for accesslistentry which needs to be created |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/add-entries-to-access-list/\n\n### projectAccesslist.update(body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Updates the accesslistentry passed. It only updates the properties passed in body.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error\n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for accesslistentry which needs to be updated |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/add-entries-to-access-list/\n\n### projectAccesslist.delete(accesslistentry, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Deletes the accesslistentry name passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error\n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| accesslistentry | \u003ccode\u003eString\u003c/code\u003e |  | name of the accesslistentry which needs to be deleted |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/delete-one-access-list-entry/\n\n### Project\n\n### project.getById(projectId, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the details of project id passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| projectId | \u003ccode\u003eString\u003c/code\u003e |  | project id for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/project-get-one/\n\n### project.getByName(projectName, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the details of project name passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| projectId | \u003ccode\u003eString\u003c/code\u003e |  | project name for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/project-get-one-by-name/\n\n### project.getTeamsByProjectId(projectId, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the teams of project id passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| projectId | \u003ccode\u003eString\u003c/code\u003e |  | project id for which teams needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/project-get-teams/\n\n### project.getAll([options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns all the projects. Pagination can be controlled via options object.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/project-get-all/\n\n### project.create(body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Creates the project as per body passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for project which needs to be created |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/project-create-one/\n\n### project.assignTeams(projectId, body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Assigns the teams for the projectId passed. It only updates the properties passed in body.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| projectId | \u003ccode\u003eString\u003c/code\u003e |  | Id of the project for which teams needs to be associated |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for teams which needs to be associated |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/project-add-team/\n\n### project.delete(projectId, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Deletes the project id passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| projectId | \u003ccode\u003eString\u003c/code\u003e |  | Id of the project which needs to be deleted |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/project-delete-one/\n\n### project.removeUserFromProject(projectId, userId, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Removes the user id passed from the project.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| userId | \u003ccode\u003eString\u003c/code\u003e |  | Id of the user which needs to be removed from project |\n| projectId | \u003ccode\u003eString\u003c/code\u003e |  | Id of the project |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/project-remove-user/\n\n### Organization\n\n### organization.getById(organizationId, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the details of organization id passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| organizationId | \u003ccode\u003eString\u003c/code\u003e |  | org§ id for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/organization-get-one/\n\n### organization.getAllUsersForOrganization(organizationId, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns all the users for organization id passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| organizationId | \u003ccode\u003eString\u003c/code\u003e |  | organization id for which users needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/organization-users-get-all-users/\n\n### organization.getAllProjectsForOrganization(organizationId, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns all the projects for organization id passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| organizationId | \u003ccode\u003eString\u003c/code\u003e |  | organization id for which projects needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/organization-get-all-projects/\n\n### organization.getAll([options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns all the organizations. Pagination can be controlled via options object.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/organization-get-all/\n\n### organization.rename(organizationId, body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Renames the organization\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| organizationId | \u003ccode\u003eString\u003c/code\u003e |  | Id of the organization for which needs to be renamed |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for organization which needs to be renamed |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/organization-rename/\n\n### organization.invite(organizationId, body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Sends an invitation to the given email (username) to join the Organization\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| organizationId | \u003ccode\u003eString\u003c/code\u003e |  | Id of the organization for which needs to be renamed |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Organization invitation details \n| body.roles | \u003ccode\u003estring[]\u003c/code\u003e |  | Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. |\n| body.teamIds | \u003ccode\u003estring[]\u003c/code\u003e |  | *(Optional)* Unique 24-hexadecimal digit strings that identify the teams that you invite the user to join. \n| body.username | \u003ccode\u003estring\u003c/code\u003e |  | Email address of the invited user. This is the address to which Atlas sends the invite. \n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/organization-create-one-invitation/\n\n\n### organization.delete(organizationId, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Deletes the project id passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| organizationId | \u003ccode\u003eString\u003c/code\u003e |  | Id of the organization which needs to be deleted |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/organization-delete-one/\n\n### AtlasUser\n\n### atlasUser.getById(userId, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the details of user id passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| userId | \u003ccode\u003eString\u003c/code\u003e |  | Id of the user for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/user-get-by-id/\n\n### atlasUser.getByName(username, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the details of user name passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| username | \u003ccode\u003eString\u003c/code\u003e |  | Name of the user for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/user-get-one-by-name/\n\n### atlasUser.getAll([options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns all the users. Pagination can be controlled via options object.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/user-get-all/\n\n### atlasUser.create(body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Creates the atlas user as per body passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for atlas user which needs to be created |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/user-create/\n\n### atlasUser.update(userId, body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Updates the user for the userId passed. It only updates the properties passed in body.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| userId | \u003ccode\u003eString\u003c/code\u003e |  | Id of the user for which details needs to be updated |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for user which needs to be updated |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/user-update/\n\n### Event\n\n### event.get(eventId, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the details of event id passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| eventId | \u003ccode\u003eString\u003c/code\u003e |  | id of the event for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/events-projects-get-one/\n\n### event.getAll([options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns all the events. Pagination can be controlled via options object.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/events-projects-get-all/\n\n### event.getByOrganizationId(organizationId, eventId, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the details of event id passed for organization id.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| organizationId | \u003ccode\u003eString\u003c/code\u003e |  | id of the organization for which details needs to be retrieved |\n| eventId | \u003ccode\u003eString\u003c/code\u003e |  | id of the event for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/events-orgs-get-one/\n\n### event.getAllByOrganizationId(organizationId, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns all the events. Pagination can be controlled via options object.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| organizationId | \u003ccode\u003eString\u003c/code\u003e |  | id of the organization for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/events-orgs-get-all/\n\n### Alert\n\n### alert.get(alertId, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the details of alert id passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| alertId | \u003ccode\u003eString\u003c/code\u003e |  | id of the alert for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/alerts-get-alert/\n\n### alert.getAll([options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns all the alerts. Pagination can be controlled via options object.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/alerts-get-all-alerts/\n\n### event.acknowledge(alertId, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Acknowledge or unacknowledge an alert\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| alertId | \u003ccode\u003eString\u003c/code\u003e |  | id of the alert which needs to be acknowledged |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for alert which needs to be acknowledged |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/alerts-acknowledge-alert/\n\n### DataLake\n\n### dataLake.get(dataLakeName, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the details of dataLake name passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| dataLakeName | \u003ccode\u003eString\u003c/code\u003e |  | name of the dataLake for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.mongodb.com/datalake/reference/api/dataLakes-get-one-tenant/\n\n### dataLake.getAll([options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns all the dataLakes. Pagination can be controlled via options object.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.mongodb.com/datalake/reference/api/dataLakes-get-all-tenants/\n\n### dataLake.getLogsStream(dataLakeName, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the dataLake logs stream.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| dataLakeName | \u003ccode\u003eString\u003c/code\u003e |  | name of the dataLake for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.mongodb.com/datalake/reference/api/dataLakes-download-query-logs/\n\n### dataLake.create(body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Creates the dataLake as per body passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for dataLake which needs to be created |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.mongodb.com/datalake/reference/api/dataLakes-create-one-tenant/\n\n### dataLake.update(dataLakeName, body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Updates the dataLake for the username passed. It only updates the properties passed in body.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| dataLakeName | \u003ccode\u003eString\u003c/code\u003e |  | name of the dataLake for which details needs to be retrieved |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for dataLake which needs to be updated |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.mongodb.com/datalake/reference/api/dataLakes-update-one-tenant/\n\n### dataLake.delete(dataLakeName, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Deletes the dataLake name passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| dataLakeName | \u003ccode\u003eString\u003c/code\u003e |  | name of the datalake which needs to be deleted |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.mongodb.com/datalake/reference/api/dataLakes-delete-one-tenant/\n\n### CloudProviderAccess\n\n### cloudProviderAccess.getAll([options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns all the cloudProviderAccess. Pagination can be controlled via options object.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/cloud-provider-access-get-roles/\n\n### cloudProviderAccess.create(body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Creates the cloudProviderAccess as per body passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for cloudProviderAccess which needs to be created |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/cloud-provider-access-create-one-role/\n\n### cloudProviderAccess.update(roleId, body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Updates the cloudProviderAccess for the roleId passed. It only updates the properties passed in body.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| roleId | \u003ccode\u003eString\u003c/code\u003e |  | roleId of the cloudProviderAccess for which details needs to be updated |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for dataLake which needs to be updated |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/cloud-provider-access-authorize-one-role/\n\n### cloudProviderAccess.delete(roleId, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Deletes the cloudProviderAccess name passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| roleId | \u003ccode\u003eString\u003c/code\u003e |  | roleId of the cloudProviderAccess which needs to be deleted |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/cloud-provider-access-deauthorize-one-role/\n\n### AtlasSearch\n\n### atlasSearch.get(clusterName, indexId, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns the details of atlas search index by cluster name and index passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| clusterName | \u003ccode\u003eString\u003c/code\u003e |  | name of the cluster for which details needs to be retrieved |\n| indexId | \u003ccode\u003eString\u003c/code\u003e |  | id of the index for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-one/\n\n### atlasSearch.getAll(clusterName, databaseName, collectionName, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns all the atlas search indexes. Pagination can be controlled via options object.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| clusterName | \u003ccode\u003eString\u003c/code\u003e |  | name of the cluster for which details needs to be retrieved |\n| databaseName | \u003ccode\u003eString\u003c/code\u003e |  | name of the database for which details needs to be retrieved |\n| collectionName | \u003ccode\u003eString\u003c/code\u003e |  | name of the collection for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/\n\n### atlasSearch.getAllAnalyzers(clusterName, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Returns all the Analyzers. Pagination can be controlled via options object.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| clusterName | \u003ccode\u003eString\u003c/code\u003e |  | name of the cluster for which details needs to be retrieved |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/fts-analyzers-get-all/\n\n### atlasSearch.create(clusterName, body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Creates the atlas search index as per body passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| clusterName | \u003ccode\u003eString\u003c/code\u003e |  | name of the cluster for which details needs to be retrieved |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for cluster which needs to be created |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-create-one/\n\n### atlasSearch.update(clusterName, indexId, body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Updates the atlas search index for the clusterName passed. It only updates the properties passed in body.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| clusterName | \u003ccode\u003eString\u003c/code\u003e |  | name of the cluster for which details needs to be updated |\n| indexId | \u003ccode\u003eString\u003c/code\u003e |  | name of the index for which details needs to be updated |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for cluster which needs to be updated |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-update-one/\n\n### atlasSearch.upsertAnalyzer(clusterName, body, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Upserts the analyser for the clusterName passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| clusterName | \u003ccode\u003eString\u003c/code\u003e |  | name of the cluster for which details needs to be upserted |\n| body | \u003ccode\u003eObject\u003c/code\u003e |  | Body which has details for cluster which needs to be upserted |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/fts-analyzers-update-all/\n\n### atlasSearch.delete(clusterName, indexId, [options]) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nFunction - Deletes the atlas search index by cluster name passed.\n\n**Returns**: \u003ccode\u003ePromise\u003c/code\u003e - - promise which resolves on success and rejects on error  \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| clusterName | \u003ccode\u003eString\u003c/code\u003e |  | name of the cluster which needs to be deleted |\n| indexId | \u003ccode\u003eString\u003c/code\u003e |  | name of the index for which details needs to be deleted |\n| [options] | \u003ccode\u003eObject\u003c/code\u003e | \u003ccode\u003e{}\u003c/code\u003e | 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 |\n\nMore details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-delete-one/\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmontumodi%2Fmongodb-atlas-api-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmontumodi%2Fmongodb-atlas-api-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmontumodi%2Fmongodb-atlas-api-client/lists"}