Appearance
MongoDB Atlas
Manage clusters, databases, users, and monitoring with the MongoDB Atlas API.
| Detail | Value |
|---|---|
| Category | Database |
| Base URL | https://cloud.mongodb.com/api/atlas/v2 |
| Authentication | HTTP Digest |
| Endpoints | 8 |
| Connector key | mongodb-atlas |
Using MongoDB Atlas in a workflow
- Go to Connections and click New Connection.
- Pick MongoDB Atlas from the marketplace.
- Enter your credentials (see Authentication above for what's expected).
- In a workflow, drop an API Call node and select this connection.
- Pick the operation you need from the Operation dropdown — the full list is below.
Available endpoints
| Endpoint | Summary |
|---|---|
GET /groups | List projects |
GET /groups/{groupId}/clusters | List clusters |
POST /groups/{groupId}/clusters | Create a cluster |
GET /groups/{groupId}/clusters/{clusterName} | Get cluster details |
DELETE /groups/{groupId}/clusters/{clusterName} | Delete a cluster |
GET /groups/{groupId}/databaseUsers | List database users |
POST /groups/{groupId}/databaseUsers | Create a database user |
GET /groups/{groupId}/alerts | List alerts |
Each endpoint is documented in full below. Use the outline on the right to jump to one.
GET /groups
List projects
| Detail | Value |
|---|---|
| Operation ID | database.listProjects |
| Method | GET |
| Path | /groups |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your MongoDB Atlas connection from the Connection dropdown.
- In the Operation dropdown, select
database.listProjects. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream MongoDB Atlas API reference.
GET /groups/{groupId}/clusters
List clusters
| Detail | Value |
|---|---|
| Operation ID | database.listClusters |
| Method | GET |
| Path | /groups/{groupId}/clusters |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your MongoDB Atlas connection from the Connection dropdown.
- In the Operation dropdown, select
database.listClusters. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream MongoDB Atlas API reference.
POST /groups/{groupId}/clusters
Create a cluster
| Detail | Value |
|---|---|
| Operation ID | database.createCluster |
| Method | POST |
| Path | /groups/{groupId}/clusters |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your MongoDB Atlas connection from the Connection dropdown.
- In the Operation dropdown, select
database.createCluster. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream MongoDB Atlas API reference.
GET /groups/{groupId}/clusters/{clusterName}
Get cluster details
| Detail | Value |
|---|---|
| Operation ID | database.getCluster |
| Method | GET |
| Path | /groups/{groupId}/clusters/{clusterName} |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your MongoDB Atlas connection from the Connection dropdown.
- In the Operation dropdown, select
database.getCluster. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream MongoDB Atlas API reference.
DELETE /groups/{groupId}/clusters/{clusterName}
Delete a cluster
| Detail | Value |
|---|---|
| Operation ID | database.deleteCluster |
| Method | DELETE |
| Path | /groups/{groupId}/clusters/{clusterName} |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your MongoDB Atlas connection from the Connection dropdown.
- In the Operation dropdown, select
database.deleteCluster. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream MongoDB Atlas API reference.
GET /groups/{groupId}/databaseUsers
List database users
| Detail | Value |
|---|---|
| Operation ID | database.listDatabaseUsers |
| Method | GET |
| Path | /groups/{groupId}/databaseUsers |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your MongoDB Atlas connection from the Connection dropdown.
- In the Operation dropdown, select
database.listDatabaseUsers. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream MongoDB Atlas API reference.
POST /groups/{groupId}/databaseUsers
Create a database user
| Detail | Value |
|---|---|
| Operation ID | database.createDatabaseUser |
| Method | POST |
| Path | /groups/{groupId}/databaseUsers |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your MongoDB Atlas connection from the Connection dropdown.
- In the Operation dropdown, select
database.createDatabaseUser. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream MongoDB Atlas API reference.
GET /groups/{groupId}/alerts
List alerts
| Detail | Value |
|---|---|
| Operation ID | database.listAlerts |
| Method | GET |
| Path | /groups/{groupId}/alerts |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your MongoDB Atlas connection from the Connection dropdown.
- In the Operation dropdown, select
database.listAlerts. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream MongoDB Atlas API reference.