A mongodb atlas api client for nodejs.
npm install mongodb-atlas-api-clientA mongdb atlas api client for nodejs.
!NPM Publish
``
npm install mongodb-atlas-api-client
This package is also available as a Model Context Protocol (MCP) server that provides AI assistants with direct access to MongoDB Atlas APIs. The MCP server enables AI agents to manage Atlas resources like clusters, users, and databases through natural language interactions.
The MCP server is available as a separate package:
- Package: mongodb-atlas-mcp-server
- Documentation: Full setup and configuration instructions available on npm
The MCP server wraps this MongoDB Atlas API client and exposes Atlas operations through the Model Context Protocol, making it easy for AI assistants to interact with your MongoDB Atlas infrastructure.
The basic syntax is
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
`js
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,
"httpOptions": { // This parameter will not be sent as querystring. This will be send to http request package urllib
"timeout": 5000
}
}
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
`
npm test
Following entities are currently supported
- User
- CloudBackup
- Cluster
- CustomDbRole
- ProjectWhitelist
- ProjectAccesslist
- Project
- Organization
- AtlasUser
- Event
- Alert
- DataLake
- AtlasSearch
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| username | String | | name of the user for which details needs to be retrieved |
| [options] | Object | {} | 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. |
More details - https://docs.atlas.mongodb.com/reference/api/database-users-get-single-user/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/database-users-get-all-users/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| body | Object | | Body which has details for user which needs to be created |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/database-users-create-a-user/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| username | String | | name of the user for which details needs to be updated |
| body | Object | | Body which has details for user which needs to be updated |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/database-users-update-a-user/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| username | String | | name of the user which needs to be deleted |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/database-users-delete-a-user/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| clustername | String | | name of the cluster for which details needs to be retrieved |
| snapshotId | String | | Id of the snapshot for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/getReplicaSetBackup
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| clustername | String | | name of the cluster for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/listReplicaSetBackups
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| clustername | String | | name of the cluster for which details needs to be retrieved |
| restoreJobId | String | | snapshot restore job id for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/getBackupRestoreJob
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| clustername | String | | name of the cluster for which details needs to be retrieved |
| body | Object | | Body which has details for snapshot restore job which needs to be created |
| [options] | Object | {} | 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 |
More details - https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v1/#tag/Cloud-Backups/operation/createBackupRestoreJob
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| clustername | String | | name of the cluster for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/clusters-get-one/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/clusters-get-all/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| clustername | String | | name of the cluster for which advance configuration needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/clusters-get-advanced-configuration-options/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| body | Object | | Body which has details for cluster which needs to be created |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/clusters-create-one/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| clustername | String | | name of the cluster for which details needs to be updated |
| body | Object | | Body which has details for cluster which needs to be updated |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/clusters-modify-one/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| clustername | String | | name of the cluster for which advance configuration needs to be updated |
| body | Object | | Body which has details for cluster which needs to be updated |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/clusters-modify-advanced-configuration-options/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| clustername | String | | name of the cluster for which failure needs to be tested |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/clusters-test-failover/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| clustername | String | | name of the cluster which needs to be deleted |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/clusters-delete-one/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| rolename | String | | name of the role for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-get-single-role/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-get-all-roles/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| body | Object | | Body which has details for role which needs to be created |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-create-a-role/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| rolename | String | | name of the role for which details needs to be updated |
| body | Object | | Body which has details for role which needs to be updated |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-update-a-role/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| rolename | String | | name of the role which needs to be deleted |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/custom-roles-delete-a-role/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| whitelistentry | String | | name of the whitelistentry for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/whitelist-get-one-entry/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/whitelist-get-all/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| body | Object | | Body which has details for whitelistentry which needs to be created |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/whitelist-add-one/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| body | Object | | Body which has details for whitelistentry which needs to be updated |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/whitelist-update-one/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| whitelistentry | String | | name of the whitelistentry which needs to be deleted |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/whitelist-delete-one/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| accesslistentry | String | | name of the accesslistentry for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/get-one-access-list-entry/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/get-all-access-list-entries/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| body | Object | | Body which has details for accesslistentry which needs to be created |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/add-entries-to-access-list/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| body | Object | | Body which has details for accesslistentry which needs to be updated |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/add-entries-to-access-list/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| accesslistentry | String | | name of the accesslistentry which needs to be deleted |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/ip-access-list/delete-one-access-list-entry/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| projectId | String | | project id for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/project-get-one/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| projectId | String | | project name for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/project-get-one-by-name/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| projectId | String | | project id for which teams needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/project-get-teams/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/project-get-all/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| body | Object | | Body which has details for project which needs to be created |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/project-create-one/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| projectId | String | | Id of the project for which teams needs to be associated |
| body | Object | | Body which has details for teams which needs to be associated |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/project-add-team/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| projectId | String | | Id of the project which needs to be deleted |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/project-delete-one/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| userId | String | | Id of the user which needs to be removed from project |
| projectId | String | | Id of the project |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/project-remove-user/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| organizationId | String | | org§ id for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/organization-get-one/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| organizationId | String | | organization id for which users needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/organization-users-get-all-users/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| organizationId | String | | organization id for which projects needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/organization-get-all-projects/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/organization-get-all/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| organizationId | String | | Id of the organization for which needs to be renamed |
| body | Object | | Body which has details for organization which needs to be renamed |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/organization-rename/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| organizationId | String | | Id of the organization for which needs to be renamed |
| body | Object | | Organization invitation details
| body.roles | string[] | | Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. |
| body.teamIds | string[] | | (Optional) Unique 24-hexadecimal digit strings that identify the teams that you invite the user to join.
| body.username | string | | Email address of the invited user. This is the address to which Atlas sends the invite.
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/organization-create-one-invitation/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| organizationId | String | | Id of the organization which needs to be deleted |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/organization-delete-one/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| userId | String | | Id of the user for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/user-get-by-id/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| username | String | | Name of the user for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/user-get-one-by-name/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/user-get-all/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| body | Object | | Body which has details for atlas user which needs to be created |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/user-create/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| userId | String | | Id of the user for which details needs to be updated |
| body | Object | | Body which has details for user which needs to be updated |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/user-update/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| eventId | String | | id of the event for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/events-projects-get-one/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/events-projects-get-all/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| organizationId | String | | id of the organization for which details needs to be retrieved |
| eventId | String | | id of the event for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/events-orgs-get-one/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| organizationId | String | | id of the organization for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/events-orgs-get-all/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| alertId | String | | id of the alert for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/alerts-get-alert/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/alerts-get-all-alerts/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| alertId | String | | id of the alert which needs to be acknowledged |
| body | Object | | Body which has details for alert which needs to be acknowledged |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/alerts-acknowledge-alert/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| dataLakeName | String | | name of the dataLake for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.mongodb.com/datalake/reference/api/dataLakes-get-one-tenant/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | Object | {} | 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 |
More details - https://docs.mongodb.com/datalake/reference/api/dataLakes-get-all-tenants/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| dataLakeName | String | | name of the dataLake for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.mongodb.com/datalake/reference/api/dataLakes-download-query-logs/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| body | Object | | Body which has details for dataLake which needs to be created |
| [options] | Object | {} | 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 |
More details - https://docs.mongodb.com/datalake/reference/api/dataLakes-create-one-tenant/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| dataLakeName | String | | name of the dataLake for which details needs to be retrieved |
| body | Object | | Body which has details for dataLake which needs to be updated |
| [options] | Object | {} | 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 |
More details - https://docs.mongodb.com/datalake/reference/api/dataLakes-update-one-tenant/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| dataLakeName | String | | name of the datalake which needs to be deleted |
| [options] | Object | {} | 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 |
More details - https://docs.mongodb.com/datalake/reference/api/dataLakes-delete-one-tenant/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/cloud-provider-access-get-roles/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| body | Object | | Body which has details for cloudProviderAccess which needs to be created |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/cloud-provider-access-create-one-role/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| roleId | String | | roleId of the cloudProviderAccess for which details needs to be updated |
| body | Object | | Body which has details for dataLake which needs to be updated |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/cloud-provider-access-authorize-one-role/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| roleId | String | | roleId of the cloudProviderAccess which needs to be deleted |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/cloud-provider-access-deauthorize-one-role/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| clusterName | String | | name of the cluster for which details needs to be retrieved |
| indexId | String | | id of the index for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-one/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| clusterName | String | | name of the cluster for which details needs to be retrieved |
| databaseName | String | | name of the database for which details needs to be retrieved |
| collectionName | String | | name of the collection for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| clusterName | String | | name of the cluster for which details needs to be retrieved |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/fts-analyzers-get-all/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| clusterName | String | | name of the cluster for which details needs to be retrieved |
| body | Object | | Body which has details for cluster which needs to be created |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-create-one/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| clusterName | String | | name of the cluster for which details needs to be updated |
| indexId | String | | name of the index for which details needs to be updated |
| body | Object | | Body which has details for cluster which needs to be updated |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-update-one/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| clusterName | String | | name of the cluster for which details needs to be upserted |
| body | Object | | Body which has details for cluster which needs to be upserted |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/fts-analyzers-update-all/
Returns: Promise - - promise which resolves on success and rejects on error
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| clusterName | String | | name of the cluster which needs to be deleted |
| indexId | String | | name of the index for which details needs to be deleted |
| [options] | Object | {} | 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 |
More details - https://docs.atlas.mongodb.com/reference/api/fts-indexes-delete-one/