Skip to main content
MongoDB logo
  • Category: databases
  • Auth: S2S_OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 496
  • Triggers: 0
  • Slug: MONGODB
  • Version: 20261101_00

Tools

Slug: MONGODB_ACCEPT_GROUP_STREAM_VPC_PEERING_CONNECTIONAccept One Incoming VPC Peering Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Owner

Input Parameters

string
required
The VPC Peering Connection id.
object
required
Container for elements used to challenge the user before taking certain actions on VPC Peering connections.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_ACKNOWLEDGE_GROUP_ALERTAcknowledge or unacknowledge one alert in a project using the MongoDB Atlas Administration API. Required Atlas role: Project Alerts Manager.

Input Parameters

object
required
Acknowledging an alert prevents successive notifications. Specify the acknowledgeUntil date and optional comment or unacknowledgeAlert boolean.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the alert.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_ADD_GROUP_API_KEYAssign One Organization API Key to One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

array
required
Explanatory text that describes this API key, the list of roles to grant this API key, or both.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_ADD_GROUP_TEAMSAdd Multiple Teams to One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

Input Parameters

array
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_ADD_GROUP_USER_ROLEAdd One Project Role to One MongoDB Cloud User. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user’s userId or verify a user’s status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_ADD_GROUP_USERSAdd One MongoDB Cloud User to One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_ADD_ORG_TEAM_USERAdd One MongoDB Cloud User to One Team. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the team to add the MongoDB Cloud user to.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_ADD_ORG_USER_ROLEAdd One Organization Role to One MongoDB Cloud User. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user’s userId or verify a user’s status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_AUTHORIZE_GROUP_CLOUD_PROVIDER_ACCESS_ROLEAuthorize One Cloud Provider Access Role. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Owner

Input Parameters

string
required
Grants access to the specified project for the specified access role.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the role. Amazon Web Services (AWS) IAM roles and Google Service Accounts return this value as roleId. Azure Service Principals return it as _id.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CANCEL_GROUP_CLUSTER_BACKUP_RESTORE_JOBCancel One Restore Job for One Cluster. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Export Operator, Project Backup Recovery Operator

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.
string
required
Unique 24-hexadecimal digit string that identifies the restore job to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_EPHEMERAL_CLUSTERCreate One Ephemeral Atlas Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: No specific Atlas role is documented.

Input Parameters

object
Create an Atlas Ephemeral cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_FEDERATION_SETTING_CONNECTED_ORG_CONFIG_ROLE_MAPPINGCreate One Role Mapping in One Organization Configuration. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

Input Parameters

object
required
The role mapping that you want to create.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your federation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_FEDERATION_SETTING_IDENTITY_PROVIDERCreate an identity provider in a federation using OIDC workforce or workload configuration through the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

Input Parameters

string
required
The identity provider that you want to create.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your federation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUPCreate One Project. Uses the MongoDB Atlas Administration API.

Input Parameters

object
required
Creates one project.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_ACCESS_LIST_ENTRYAdd Entries to Project IP Access List. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Network Access Manager.

Input Parameters

array
required
One or more access list entries to add to the specified project.
string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_AI_MODEL_API_KEYCreate New AI Model API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Model Owner

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_ALERT_CONFIGCreate One Alert Configuration in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Alerts Manager.

Input Parameters

string
required
Documented request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_API_KEYCreate and Assign One Organization API Key to One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_BACKUP_EXPORT_BUCKETCreate One Snapshot Export Bucket. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

Input Parameters

string
required
Specifies the role and AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket that the Export Bucket should reference.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_BACKUP_PRIVATE_ENDPOINTCreate one AWS object storage private endpoint for cloud backups in a project using the MongoDB Atlas Administration API. Requires the Project Owner Atlas role.

Input Parameters

object
required
Creates a private endpoint in the specified region for object storage backup operations.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cloud provider for the private endpoint to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_CLOUD_PROVIDER_ACCESSCreate One Cloud Provider Access Role. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Owner

Input Parameters

string
required
Creates one role for the specified cloud provider.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_CLUSTERCreate One Cluster in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Creator.

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Controls how hardware specification fields are returned in the response after cluster creation. When set to true, returns the original client-specified values and provides separate effective fields showing current operational values. When false (default), hardware specification fields show current operational values directly. Primarily used for autoscaling compatibility.
boolean
Controls how replicationSpecs fields are returned in the response. When set to true, stores the client’s view of replicationSpecs and returns it in replicationSpecs, while the actual cluster state (including auto-scaled hardware and auto-added shards) is returned in effectiveReplicationSpecs. When false (default), replicationSpecs contains the actual cluster state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_CLUSTER_BACKUP_EXPORTCreate One Snapshot Export Job. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Export Operator

Input Parameters

object
required
Information about the Cloud Backup Snapshot Export Job to create.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_CLUSTER_BACKUP_RESTORE_JOBCreate One Restore Job of One Cluster. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Export Operator, Project Backup Recovery Operator

Input Parameters

object
required
Restores one snapshot of one cluster from the specified project.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_CLUSTER_COLLECTION_RESTORE_JOBCreate One Collection Restore Job. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Recovery Operator

Input Parameters

object
required
Creates one collection-level restore job for one cluster from the specified project.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the source cluster for the restore.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_CLUSTER_GLOBAL_WRITE_CUSTOM_ZONE_MAPPINGAdd custom zone mappings to one Global Cluster using the MongoDB Atlas Administration API. Required Atlas role: Project Owner.

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies this cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_CLUSTER_GLOBAL_WRITE_MANAGED_NAMESPACECreate One Managed Namespace in One Global Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies this cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_CLUSTER_INDEX_ROLLING_INDEXCreate One Rolling Index. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin, Project Index Manager

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster on which MongoDB Cloud creates an index.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_CLUSTER_ONLINE_ARCHIVECreate One Online Archive. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_CLUSTER_OVERLOAD_SIMULATIONCreate One Overload Protection Simulation. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager

Input Parameters

object
required
Request to start an overload protection simulation for a cluster.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster on which to start the overload protection simulation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_CLUSTER_SEARCH_DEPLOYMENTCreate Search Nodes. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the cluster to create Search Nodes for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_CLUSTER_SEARCH_INDEXCreate One Atlas Search Index. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Search Index Editor

Input Parameters

string
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Name of the cluster that contains the collection on which to create an Atlas Search index.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_CONTAINERCreate One Network Peering Container. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

string
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_CUSTOM_DB_ROLE_ROLECreate One Custom Role. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Database Access Admin, Project Stream Processing Owner

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_DATABASE_USERCreate one database user in an Atlas project, with role names restricted to the listed built-in choices or the literal custom-role placeholder. Uses the MongoDB Atlas Administration API; required Atlas roles: Project Database Access Admin, Project Stream Processing Owner.

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_DATABASE_USER_CERTCreate One X.509 Certificate for One Database User. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that represents the MongoDB database user account for whom to create a certificate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_DATA_FEDERATIONCreate One Federated Database Instance in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_ENCRYPTION_AT_REST_PRIVATE_ENDPOINTCreate one private endpoint for encryption at rest using customer key management for AWS or Azure in one project. Uses the MongoDB Atlas Administration API; required Atlas role: Project Owner.

Input Parameters

string
required
Encryption At Rest Private Endpoint.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string ("AZURE" | "AWS")
required
Human-readable label that identifies the cloud provider for the private endpoint to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_FLEX_CLUSTERCreate One Flex Cluster in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

object
required
Settings that you can specify when you create a flex cluster.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_FLEX_CLUSTER_BACKUP_RESTORE_JOBCreate One Restore Job for One Flex Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Backup Recovery Operator

Input Parameters

object
required
Details to create one restore job of a flex cluster.
string
required
Human-readable label that identifies the flex cluster whose snapshot you want to restore.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_INTEGRATIONCreate One Third-Party Service Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

string
required
Collection of settings that describe third-party integrations.
string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.
string ("PAGER_DUTY" | "SLACK" | "DATADOG" | "NEW_RELIC" | "OPS_GENIE" | "VICTOR_OPS" | "WEBHOOK" | "HIP_CHAT" | "PROMETHEUS" | "MICROSOFT_TEAMS")
required
Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_LIVE_MIGRATIONCreate a migration for one local managed cluster to MongoDB Atlas; the migration can drop all destination collections before it starts. Uses the MongoDB Atlas Administration API and requires the Organization Owner role.

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_LOG_INTEGRATIONCreate One Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

string
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_MCP_CONFIGCreate One MCP Configuration for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_MCP_CONFIG_SECRETCreate One Secret for One Project MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique identifier of the MCP configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_METRIC_INTEGRATIONCreate One Metric Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

object
required
Metric integration configuration to create.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_PEERCreate One Network Peering Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Network Access Manager

Input Parameters

string
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_PRIVATE_ENDPOINT_ENDPOINT_SERVICECreate One Private Endpoint Service for One Provider. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

object
required
Creates one private endpoint for the specified cloud service provider.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_PRIVATE_ENDPOINT_ENDPOINT_SERVICE_ENDPOINTCreate One Private Endpoint for One Provider. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

string
required
Creates one private endpoint for the specified cloud service provider.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string ("AWS" | "AZURE" | "GCP")
required
Cloud service provider that manages this private endpoint.
string
required
Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_PRIVATE_NETWORK_SETTING_ENDPOINT_IDCreate One Federated Database Instance and Online Archive Private Endpoint for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_SERVICE_ACCOUNTCreate One Project Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

object
required
Details of the new Service Account.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_SERVICE_ACCOUNT_ACCESS_LISTAdd Access List Entries for One Project Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager.

Input Parameters

array
required
A list of access list entries to add to the access list of the specified Service Account for the project.
string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
The Client ID of the Service Account.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_SERVICE_ACCOUNT_SECRETCreate One Project Service Account Secret. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

object
required
Details for the new secret.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
The Client ID of the Service Account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_STREAM_CONNECTIONCreate One Stream Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

Input Parameters

string
required
Settings that define a connection to an external data store.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_STREAM_CONNECTION_FAILOVER_CONNECTIONCreate One Failover Stream Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

Input Parameters

string
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace.
string
required
Label that identifies the stream connection name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_STREAM_PROCESSORCreate One Stream Processor. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

Input Parameters

object
required
An Atlas stream processor request.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_STREAMS_WORKSPACE_PRIVATE_ENDPOINTCreate One Workspace Private Endpoint for Atlas Stream Processing. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Owner

Input Parameters

object
required
Customer VPC endpoint to register for inbound private connectivity to Atlas Stream Processing.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_GROUP_STREAM_WORKSPACECreate One Stream Workspace. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Data Access Admin, Project Stream Processing Manager

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_ORGCreate One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: No specific Atlas role is documented.

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_ORG_API_KEYCreate One Organization API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Organization Service Account that Atlas creates for this organization. If omitted, Atlas doesn’t create an organization Service Account for this organization. If specified, this object requires all body parameters. Note that API Keys cannot be specified in the same request.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_ORG_API_KEY_ACCESS_LIST_ENTRYCreate access list entries for one organization API key using the MongoDB Atlas Administration API. No specific Atlas role is documented.

Input Parameters

array
required
Operation-specific request body.
string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_ORG_BILLING_COST_EXPLORER_USAGE_PROCESSCreate One Cost Explorer Query Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

Input Parameters

object
required
Request body for a cost explorer query.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_ORG_INVOICE_REPORTCreate One Invoice Report. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
string
required
Unique string that identifies the invoice for which to generate the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_ORG_LOG_INTEGRATIONCreate One Organization Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_ORG_MCP_CONFIGCreate One MCP Configuration for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_ORG_MCP_CONFIG_SECRETCreate One Secret for One Organization MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
string
required
Unique identifier of the MCP configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_ORG_RESOURCE_POLICYCreate One Atlas Resource Policy. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_ORG_SANDBOX_CONFIGCreate One Sandbox Configuration for an Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

Input Parameters

object
required
Settings to configure the sandbox feature for an organization.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_ORG_SERVICE_ACCOUNTCreate One Organization Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

Input Parameters

object
required
Details of the new Service Account.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_ORG_SERVICE_ACCOUNT_ACCESS_LISTAdd Access List Entries for One Organization Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

Input Parameters

array
required
A list of access list entries to add to the access list of the specified Service Account for the organization.
string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
The Client ID of the Service Account.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_ORG_SERVICE_ACCOUNT_SECRETCreate One Organization Service Account Secret. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

Input Parameters

object
required
Details for the new secret.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
The Client ID of the Service Account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_ORG_TEAMCreate One Team in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CREATE_ORG_USERAdd One MongoDB Cloud User to One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_CUTOVER_GROUP_LIVE_MIGRATIONCut Over One Migrated Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the migration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DEAUTHORIZE_GROUP_CLOUD_PROVIDER_ACCESS_ROLEDeauthorize One Cloud Provider Access Role. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the role. Amazon Web Services (AWS) IAM roles and Google Service Accounts return this value as roleId. Azure Service Principals return it as _id.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string ("AWS" | "AZURE" | "GCP")
required
Human-readable label that identifies the cloud provider of the role to deauthorize.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DEFER_GROUP_MAINTENANCE_WINDOWDefer One Maintenance Window for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_FEDERATION_SETTINGDelete One Federation Settings Instance. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies your federation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_FEDERATION_SETTING_CONNECTED_ORG_CONFIG_ROLE_MAPPINGRemove One Role Mapping from One Organization. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your federation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_FEDERATION_SETTING_IDENTITY_PROVIDERDelete One Identity Provider. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies the identity provider to connect.
string
required
Unique 24-hexadecimal digit string that identifies your federation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUPRemove One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Owner.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_ACCESS_LIST_ENTRYRemove One Entry from One Project IP Access List. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Network Access Manager.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Access list entry that you want to remove from the project’s IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (/) with its URL-encoded value (%2F). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including: - how your application established the connection, - how MongoDB Cloud or the driver using the address behaves, and - which protocol (like TCP or UDP) the connection uses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_AI_MODEL_API_KEYDelete Existing AI Model API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Model Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
The id of the API key to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_ALERT_CONFIGRemove One Alert Configuration from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Alerts Manager.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the alert configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_BACKUP_EXPORT_BUCKETDelete One Snapshot Export Bucket. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal character string that identifies the Export Bucket.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_BACKUP_PRIVATE_ENDPOINTDelete one AWS object storage private endpoint for cloud backups from a project using the MongoDB Atlas Administration API. Requires the Project Owner Atlas role.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the private endpoint to delete.
string
required
Human-readable label that identifies the cloud provider of the private endpoint to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_CLUSTERRemove One Cluster from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.
boolean
Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_CLUSTER_BACKUP_SCHEDULERemove all Cloud Backup schedules for one cluster using the MongoDB Atlas Administration API. Requires the Project Backup Manager role.

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_CLUSTER_BACKUP_SNAPSHOTRemove One Replica Set Cloud Backup. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the desired snapshot.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_CLUSTER_BACKUP_SNAPSHOT_SHARDED_CLUSTERRemove One Sharded Cluster Cloud Backup. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the desired snapshot.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_CLUSTER_GLOBAL_WRITE_CUSTOM_ZONE_MAPPINGRemove All Custom Zone Mappings from One Global Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies this cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_CLUSTER_GLOBAL_WRITE_MANAGED_NAMESPACESRemove One Managed Namespace from One Global Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin

Input Parameters

string
required
Human-readable label that identifies the database that contains the collection.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the collection associated with the managed namespace.
string
required
Human-readable label that identifies this cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_CLUSTER_ONLINE_ARCHIVERemove One Online Archive. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the online archive to delete.
string
required
Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_CLUSTER_OVERLOAD_SIMULATIONDelete One Overload Protection Simulation. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster on which the overload protection simulation is running.
string
required
Unique 24-hexadecimal digit string that identifies the overload protection simulation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_CLUSTER_PRIVATE_ENDPOINT_CONNECTION_STRINGDelete One Private Endpoint Connection String from One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.
string
required
Unique 24-hexadecimal digit string that identifies this private endpoint connection string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_CLUSTER_SEARCH_DEPLOYMENTDelete Search Nodes. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the cluster to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_CLUSTER_SEARCH_INDEXRemove One Atlas Search Index by ID. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Search Index Editor

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the Get All Atlas Search Indexes for a Collection API endpoint to find the IDs of all Atlas Search indexes.
string
required
Name of the cluster that contains the database and collection with one or more Application Search indexes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_CLUSTER_SEARCH_INDEX_BY_NAMERemove One Atlas Search Index by Name. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Search Index Editor

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Name of the Atlas Search index to delete.
string
required
Name of the cluster that contains the database and collection with one or more Application Search indexes.
string
required
Label that identifies the database that contains the collection with one or more Atlas Search indexes.
string
required
Name of the collection that contains one or more Atlas Search indexes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_CONTAINERRemove One Network Peering Container. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_CUSTOM_DB_ROLE_ROLERemove One Custom Role from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Database Access Admin, Project Stream Processing Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_DATABASE_USERRemove One Database User from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Database Access Admin, Project Stream Processing Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsIAMType | ROLE | <abbr title=“Amazon Resource Name”>ARN</abbr> | | AWS IAM | awsIAMType | USER | <abbr title=“Amazon Resource Name”>ARN</abbr> | | x.509 | x509Type | CUSTOMER | RFC 2253 Distinguished Name | | x.509 | x509Type | MANAGED | RFC 2253 Distinguished Name | | LDAP | ldapAuthType | USER | RFC 2253 Distinguished Name | | LDAP | ldapAuthType | GROUP | RFC 2253 Distinguished Name | | OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a ’/’, followed by the IdP group name | | OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a ’/’, followed by the IdP user name | | SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |.
string
required
The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be $external. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be admin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_DATA_FEDERATIONRemove One Federated Database Instance from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the federated database instance to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_DATA_FEDERATION_LIMITDelete One Query Limit for One Federated Database Instance. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string ("bytesProcessed.query" | "bytesProcessed.daily" | "bytesProcessed.weekly" | "bytesProcessed.monthly")
required
Human-readable label that identifies this data federation instance limit. | Limit Name | Description | Default | | --- | --- | --- | | bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A | | bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A | | bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A | | bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |.
string
required
Human-readable label that identifies the federated database instance to which the query limit applies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_FLEX_CLUSTERRemove One Flex Cluster from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

string
required
Human-readable label that identifies the flex cluster.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_INTEGRATIONRemove One Third-Party Service Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string ("PAGER_DUTY" | "SLACK" | "DATADOG" | "NEW_RELIC" | "OPS_GENIE" | "VICTOR_OPS" | "WEBHOOK" | "HIP_CHAT" | "PROMETHEUS" | "MICROSOFT_TEAMS")
required
Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_LIMITRemove One Project Limit. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Owner.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string ("atlas.project.security.databaseAccess.users" | "atlas.project.deployment.clusters" | "atlas.project.deployment.serverlessMTMs" | "atlas.project.security.databaseAccess.customRoles" | "atlas.project.security.networkAccess.entries" | "atlas.project.security.networkAccess.crossRegionEntries" | "atlas.project.deployment.nodesPerPrivateLinkRegion" | "dataFederation.bytesProcessed.query" | "dataFederation.bytesProcessed.daily" | "dataFederation.bytesProcessed.weekly" | "dataFederation.bytesProcessed.monthly" | "atlas.project.deployment.privateServiceConnectionsPerRegionGroup" | "atlas.project.deployment.privateServiceConnectionsSubnetMask")
required
Human-readable label that identifies this project limit. | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 100 | | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on AWS PrivateLink addressable target nodes per region in this project. For sharded clusters using optimized (load-balanced) connection strings, currentUsage doesn’t grow with the number of mongos — the load balancer is counted as a single addressable target regardless of how many mongos sit behind it. | 50 | 90 | | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | | dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_LOG_INTEGRATIONRemove One Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

string
required
Unique identifier of the log integration configuration.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_MCP_CONFIGDelete One MCP Configuration for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether to delete the MCP configuration even if it has active secrets. If false and active secrets exist, the request returns an error. Defaults to false.
string
required
Unique identifier of the MCP configuration to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_MCP_CONFIG_SECRETDelete One Secret for One Project MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the secret.
string
required
Unique identifier of the MCP configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_METRIC_INTEGRATIONRemove One Metric Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique identifier of the metric integration configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_PEERRemove One Network Peering Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Network Access Manager

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_PRIVATE_ENDPOINT_ENDPOINT_SERVICERemove One Private Endpoint Service for One Provider. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string ("AWS" | "AZURE" | "GCP")
required
Cloud service provider that manages this private endpoint service.
string
required
Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_PRIVATE_ENDPOINT_ENDPOINT_SERVICE_ENDPOINTRemove One Private Endpoint for One Provider. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique string that identifies the private endpoint you want to delete. The format of the endpointId parameter differs for AWS and Azure. You must URL encode the endpointId for Azure private endpoints.
string ("AWS" | "AZURE" | "GCP")
required
Cloud service provider that manages this private endpoint.
string
required
Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_PRIVATE_NETWORK_SETTING_ENDPOINT_IDRemove One Federated Database Instance and Online Archive Private Endpoint from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_SERVICE_ACCOUNTRemove One Project Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
The Client ID of the Service Account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_SERVICE_ACCOUNT_ACCESS_LIST_ENTRYRemove One Access List Entry from One Project Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
The Client ID of the Service Account.
string
required
One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_SERVICE_ACCOUNT_SECRETDelete One Project Service Account Secret. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
The Client ID of the Service Account.
string
required
Unique 24-hexadecimal digit string that identifies the secret.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_STREAM_CONNECTIONDelete One Stream Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace.
string
required
Label that identifies the stream connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_STREAM_CONNECTION_FAILOVER_CONNECTIONDelete One Stream Failover Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace.
string
required
Label that identifies the stream connection.
string
required
Label that identifies the stream failover connection id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_STREAM_PROCESSORDelete One Stream Processor. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace.
string
required
Label that identifies the stream processor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_STREAM_VPC_PEERING_CONNECTIONDelete One VPC Peering Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Owner

Input Parameters

string
required
The VPC Peering Connection id.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_STREAM_WORKSPACEDelete One Stream Workspace. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Data Access Admin, Project Stream Processing Manager

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_GROUP_USER_SECURITY_LDAP_USER_TO_DN_MAPPINGRemove LDAP User to DN Mapping. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_ORGRemove One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_ORG_API_KEYRemove One Organization API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies this organization API key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_ORG_API_KEY_ACCESS_LIST_ENTRYRemove One Access List Entry for One Organization API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: No specific Atlas role is documented.

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.
string
required
Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_ORG_LOG_INTEGRATIONRemove One Organization Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique identifier of the log integration configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_ORG_MCP_CONFIGDelete One MCP Configuration for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether to delete the MCP configuration even if it has active secrets. If false and active secrets exist, the request returns an error. Defaults to false.
string
required
Unique identifier of the MCP configuration to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_ORG_MCP_CONFIG_SECRETDelete One Secret for One Organization MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
string
required
Unique 24-hexadecimal digit string that identifies the secret.
string
required
Unique identifier of the MCP configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_ORG_RESOURCE_POLICYDelete One Atlas Resource Policy. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies an atlas resource policy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_ORG_SANDBOX_CONFIGDelete the Default Sandbox Configuration and Disable Sandbox. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
string
required
Unique 24-hexadecimal digit string that identifies the sandbox configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_ORG_SERVICE_ACCOUNTDelete One Organization Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
The Client ID of the Service Account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_ORG_SERVICE_ACCOUNT_ACCESS_LIST_ENTRYRemove One Access List Entry from One Organization Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
The Client ID of the Service Account.
string
required
One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_ORG_SERVICE_ACCOUNT_SECRETDelete One Organization Service Account Secret. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
The Client ID of the Service Account.
string
required
Unique 24-hexadecimal digit string that identifies the secret.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DELETE_ORG_TEAMRemove One Team from One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the team that you want to delete.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DISABLE_GROUP_BACKUP_COMPLIANCE_POLICYDisable Backup Compliance Policy Settings. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DISABLE_GROUP_MANAGED_SLOW_MSDisable Managed Slow Operation Threshold. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DISABLE_GROUP_USER_SECURITY_CUSTOMER_X509Disable Customer-Managed X.509. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DOWNLOAD_GROUP_CLUSTER_LOGDownload Logs for One Cluster Host in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Log Viewer, Project Data Access Admin, Project Data Access Read Only, Project Data Access Read Write, Project Stream Processing Owner

Input Parameters

integer
Specifies the date and time for the ending point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours after the start date. If the start date is also unspecified, the value will default to the time of the request.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string ("mongodb" | "mongos" | "mongodb-audit-log" | "mongos-audit-log")
required
Human-readable label that identifies the log file that you want to return. To return audit logs, enable Database Auditing for the specified project.
string
required
Human-readable label that identifies the host that stores the log files that you want to download.
integer
Specifies the date and time for the starting point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours prior to the end date. If the end date is also unspecified, the value will default to 24 hours prior to the time of the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DOWNLOAD_GROUP_CLUSTER_ONLINE_ARCHIVE_QUERY_LOGSDownload Online Archive Query Logs. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin, Project Data Access Read Only, Project Data Access Read Write, Project Stream Processing Owner

Input Parameters

integer
Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the UNIX epoch.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
integer
Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the UNIX epoch.
boolean
Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.
string
required
Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DOWNLOAD_GROUP_DATA_FEDERATION_QUERY_LOGSDownload Query Logs for One Federated Database Instance. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin, Project Data Access Read Only, Project Data Access Read Write, Project Stream Processing Owner

Input Parameters

integer
Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
integer
Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.
string
required
Human-readable label that identifies the federated database instance for which you want to download query logs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DOWNLOAD_GROUP_FLEX_CLUSTER_BACKUPRequest a flex cluster snapshot download through the MongoDB Atlas Administration API, returning job details that may include a download URL. Required Atlas role: Project Backup Export Operator.

Input Parameters

object
required
Details for one backup snapshot download of a flex cluster.
string
required
Human-readable label that identifies the flex cluster.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DOWNLOAD_GROUP_STREAM_AUDIT_LOGSDownload Audit Logs for One Atlas Stream Processing Workspace. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Data Access Admin, Project Data Access Read Only, Project Data Access Read Write, Project Stream Processing Manager

Input Parameters

string
Name of the stream processor to download logs for. An empty string will download logs for all stream processors in the workspace.
integer
Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
integer
Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.
string
required
Label that identifies the stream workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_DOWNLOAD_GROUP_STREAM_OPERATIONAL_LOGSDownload Operational Logs for One Atlas Stream Processing Workspace. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Data Access Admin, Project Data Access Read Only, Project Data Access Read Write, Project Stream Processing Manager

Input Parameters

string
Name of the stream processor to download logs for. An empty string will download logs for all stream processors in the workspace.
integer
Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
integer
Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.
string
required
Label that identifies the stream workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_ENABLE_GROUP_MANAGED_SLOW_MSEnable Managed Slow Operation Threshold. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_END_GROUP_CLUSTER_OUTAGE_SIMULATIONEnd One Outage Simulation. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager, Project Cluster Resilience Tester, Project Replica Set Manager

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster that is undergoing outage simulation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GENERATE_GROUP_SANDBOX_CLUSTER_DESCRIPTIONReturn Cluster Description from Sandbox Template Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Project Creator.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the sandbox configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GENERATE_ORG_INVOICE_AND_DOWNLOAD_REPORTGenerate and Download Invoice Report. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
string
required
Unique string that identifies the invoice for which to generate the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_DEFAULT_GROUP_LIMITReturn One User-Configurable Project Limit and Description. Uses the MongoDB Atlas Administration API.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string ("MONGODB_USERS" | "NUM_CLUSTERS" | "NUM_SERVERLESS_MTMS" | "NUM_USER_CUSTOM_ROLES" | "MAX_NETWORK_PERMISSION_ENTRIES" | "MAX_CROSS_REGION_NETWORK_PERMISSION_ENTRIES" | "MAX_NODES_PER_PRIVATELINK_REGION" | "BYTES_PROCESSED_QUERY" | "BYTES_PROCESSED_DAILY" | "BYTES_PROCESSED_WEEKLY" | "BYTES_PROCESSED_MONTHLY" | "NUM_PRIVATE_SERVICE_CONNECTIONS_PER_REGION_GROUP" | "GCP_PSC_NAT_SUBNET_MASK")
required
Atlas endpoint identifier for the user-managed limit. These finite identifiers are not the dotted names returned by unrelated limit-list operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_EPHEMERAL_CLUSTERReturn One Ephemeral Atlas Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: No specific Atlas role is documented.

Input Parameters

string
required
Unique ID of the ephemeral cluster to look up.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_FEDERATION_SETTING_CONNECTED_ORG_CONFIGReturn One Organization Configuration from One Federation. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the connected organization configuration to return.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your federation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_FEDERATION_SETTING_CONNECTED_ORG_CONFIG_ROLE_MAPPINGReturn One Role Mapping from One Organization. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the role mapping that you want to return.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your federation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_FEDERATION_SETTING_IDENTITY_PROVIDERReturn One Identity Provider by ID. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.
string
required
Unique 24-hexadecimal digit string that identifies your federation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_FEDERATION_SETTING_IDENTITY_PROVIDER_METADATAReturn Metadata of One Identity Provider. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

Input Parameters

string
required
Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.
string
required
Unique 24-hexadecimal digit string that identifies your federation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUPReturn One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_ACCESS_LIST_ENTRYReturn One Project IP Access List Entry. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Access list entry that you want to return from the project’s IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (/) with its URL-encoded value (%2F).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_ACCESS_LIST_STATUSReturn Status of One Project IP Access List Entry. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Network address or cloud provider security construct that identifies which project access list entry to be verified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_ACTIVITY_FEEDReturn Pre-Filtered Activity Feed Link for One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
End date and time for events to include in the activity feed link. ISO 8601 timestamp format in UTC.
string
Start date and time for events to include in the activity feed link. ISO 8601 timestamp format in UTC.
array
Category of incident recorded at this moment in time. IMPORTANT: The complete list of event type values changes frequently.
array
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_AI_MODEL_API_CLOUD_GEOGRAPHY_MODEL_GROUP_NAME_RATE_LIMITSReturn Single AI Model Rate Limit for One Group. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

string
required
Cloud provider scope. Must be “ANY”. Additional values will be supported in future API versions.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Geography scope. Must be “ANY”. Additional values will be supported in future API versions.
string
required
The name of the model group to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_AI_MODEL_API_KEYReturn Single AI Model API Key for One Group. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
The id of the API key to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_AI_MODEL_API_RATE_LIMITSReturn a page of AI Model Rate Limits for one group using the MongoDB Atlas Administration API, with a continuation cursor when more results may be available. Required Atlas role: Project Read Only.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_ALERTReturn One Alert from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the alert.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_ALERT_ALERT_CONFIGSReturn a Page of Alert Configurations Set for One Alert. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

Input Parameters

string
Cursor returned by the previous page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the alert.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_ALERT_CONFIGReturn One Alert Configuration from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the alert configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_ALERT_CONFIG_ALERTSReturn a Page of Open Alerts for One Alert Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.
string
required
Unique 24-hexadecimal digit string that identifies the alert configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_AUDIT_LOGReturn Auditing Configuration for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_AWS_CUSTOM_DNSReturn One Custom DNS Configuration for Atlas Clusters on AWS. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_BACKUP_COMPLIANCE_POLICYReturn Backup Compliance Policy Settings. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_BACKUP_EXPORT_BUCKETReturn One Snapshot Export Bucket. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read Only

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal character string that identifies the Export Bucket.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_BACKUP_PRIVATE_ENDPOINTReturn one AWS object storage private endpoint for cloud backups in a project using the MongoDB Atlas Administration API. Requires the Project Owner Atlas role.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the private endpoint.
string
required
Human-readable label that identifies the cloud provider of the private endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_BY_NAMEReturn One Project by Name. Uses the MongoDB Atlas Administration API.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Human-readable label that identifies this project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLOUD_PROVIDER_ACCESSReturn One Cloud Provider Access Role. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the role. Amazon Web Services (AWS) IAM roles and Google Service Accounts return this value as roleId. Azure Service Principals return it as _id.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTERReturn One Cluster from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies this cluster.
boolean
Controls how hardware specification fields are returned in the response. When set to true, returns the original client-specified values and provides separate effective fields showing current operational values. When false (default), hardware specification fields show current operational values directly. Primarily used for autoscaling compatibility.
boolean
Controls how replicationSpecs are returned in the response. When set to true, returns the client-specified view in replicationSpecs and the actual cluster state in effectiveReplicationSpecs. When false (default), replicationSpecs contains the actual cluster state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_ADAPTIVE_SETTINGSReturn Adaptive Settings for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_BACKUP_EXPORTReturn One Snapshot Export Job. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal character string that identifies the Export Job.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_BACKUP_RESTORE_JOBReturn One Restore Job for One Cluster. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster with the restore jobs you want to return.
string
required
Unique 24-hexadecimal digit string that identifies the restore job to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_BACKUP_SCHEDULEReturn One Cloud Backup Schedule. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_BACKUP_SNAPSHOTReturn One Replica Set Cloud Backup. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the desired snapshot.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_BACKUP_SNAPSHOT_DATABASEReturn One Database in One Snapshot. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the desired snapshot.
string
required
Human-readable label that identifies the cluster.
string
required
Human-readable label that identifies the database.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_BACKUP_SNAPSHOT_DATABASE_COLLECTIONReturn One Collection in One Database in One Snapshot. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the desired snapshot.
string
required
Human-readable label that identifies the cluster.
string
required
Human-readable label that identifies the database.
string
required
Human-readable label that identifies the collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_BACKUP_SNAPSHOT_SHARDED_CLUSTERReturn One Sharded Cluster Cloud Backup. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the desired snapshot.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_COLLECTION_RESTORE_JOBReturn One Collection Restore Job for One Cluster. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the collection restore job to return.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster with the collection restore jobs you want to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_COLLECTION_RESTORE_JOB_COLLECTIONReturn One Collection State for One Collection Restore Job. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the collection restore job.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster with the collection restore job you want to return.
string
required
Source namespace that identifies the collection to return (e.g. db.collection).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_COLL_STAT_NAMESPACESReturn Ranked Namespaces from One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster to pin namespaces to.
string ("PRIMARY" | "SECONDARY" | "INDIVIDUAL_PROCESS")
required
Human-readable label that identifies the cluster topology to retrieve metrics for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_GLOBAL_WRITESReturn the Global Writes configuration for one Global Cluster, including managed namespaces and custom zone mappings, using the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies this cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_ONLINE_ARCHIVEReturn One Online Archive. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the online archive to return.
string
required
Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_OUTAGE_SIMULATIONReturn One Outage Simulation. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager, Project Cluster Resilience Tester

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster that is undergoing outage simulation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_OVERLOAD_SIMULATIONReturn One Overload Protection Simulation. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster on which the overload protection simulation is running.
string
required
Unique 24-hexadecimal digit string that identifies the overload protection simulation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_PRIVATE_ENDPOINT_CONNECTION_STRINGReturn One Private Endpoint Connection String for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.
string
required
Unique 24-hexadecimal digit string that identifies this private endpoint connection string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_PROCESS_ARGSReturn Advanced Configuration Options for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_QUERY_SHAPEReturn One Query Shape. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.
string
required
A SHA256 hash of a query shape, output by MongoDB commands like $queryStats and $explain or slow query logs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_QUERY_SHAPE_INSIGHT_DETAILSReturn Query Shape Details. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

integer
Date and time from which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the UNIX epoch. - If you don’t specify the until parameter, the endpoint returns data covering from the since value and the current time. - If you specify neither the since nor the until parameters, the endpoint returns data from the previous 24 hours.
integer
Date and time up until which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the UNIX epoch. - If you specify the until parameter, you must specify the since parameter. - If you specify neither the since nor the until parameters, the endpoint returns data from the previous 24 hours.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
array
Process IDs from which to retrieve query shape statistics. A processId is a combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests. To include multiple processIds, pass the parameter multiple times delimited with an ampersand (&) between each processId.
string
required
Human-readable label that identifies the cluster.
string
required
A SHA256 hash of a query shape, output by MongoDB commands like $queryStats and $explain or slow query logs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_SEARCH_DEPLOYMENTReturn All Search Nodes. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the cluster to return the Search Nodes for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_SEARCH_INDEXReturn One Atlas Search Index by ID. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Read Only, Project Data Access Read Write, Project Search Index Editor, Project Stream Processing Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the Application Search index. Use the Get All Application Search Indexes for a Collection API endpoint to find the IDs of all Application Search indexes.
string
required
Name of the cluster that contains the collection with one or more Atlas Search indexes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_SEARCH_INDEX_BY_NAMEReturn One Atlas Search Index by Name. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Read Only, Project Data Access Read Write, Project Search Index Editor, Project Stream Processing Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Name of the Atlas Search index to return.
string
required
Name of the cluster that contains the collection with one or more Atlas Search indexes.
string
required
Label that identifies the database that contains the collection with one or more Atlas Search indexes.
string
required
Name of the collection that contains one or more Atlas Search indexes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_SQL_INTERFACEReturn SQL Interface Status. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CLUSTER_STATUSReturn the status of database user changes on a cluster using the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CONTAINERReturn One Network Peering Container. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_CUSTOM_DB_ROLE_ROLEReturn One Custom Role in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_DATABASE_USERReturn One Database User from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsIAMType | ROLE | <abbr title=“Amazon Resource Name”>ARN</abbr> | | AWS IAM | awsIAMType | USER | <abbr title=“Amazon Resource Name”>ARN</abbr> | | x.509 | x509Type | CUSTOMER | RFC 2253 Distinguished Name | | x.509 | x509Type | MANAGED | RFC 2253 Distinguished Name | | LDAP | ldapAuthType | USER | RFC 2253 Distinguished Name | | LDAP | ldapAuthType | GROUP | RFC 2253 Distinguished Name | | OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a ’/’, followed by the IdP group name | | OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a ’/’, followed by the IdP user name | | SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |.
string
required
The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be $external. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be admin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_DATA_FEDERATIONReturn One Federated Database Instance in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the Federated Database to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_DATA_FEDERATION_LIMITReturn One Federated Database Instance Query Limit for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string ("bytesProcessed.query" | "bytesProcessed.daily" | "bytesProcessed.weekly" | "bytesProcessed.monthly")
required
Human-readable label that identifies this data federation instance limit. | Limit Name | Description | Default | | --- | --- | --- | | bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A | | bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A | | bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A | | bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |.
string
required
Human-readable label that identifies the federated database instance to which the query limit applies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_DB_ACCESS_HISTORY_CLUSTERReturn Database Access History for One Cluster by Cluster Name. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Log Viewer, Project Database Access Admin

Input Parameters

integer
Date and time when to stop retrieving database history. If you specify end, you must also specify start. This parameter uses UNIX epoch time in milliseconds.
integer
Date and time when MongoDB Cloud begins retrieving database history. If you specify start, you must also specify end. This parameter uses UNIX epoch time in milliseconds.
integer
Maximum number of lines from the log to return.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
One Internet Protocol address that attempted to authenticate with the database.
boolean
Flag that indicates whether the response returns the successful authentication attempts only.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_DB_ACCESS_HISTORY_PROCESSReturn Database Access History for One Cluster by Hostname. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Log Viewer, Project Database Access Admin

Input Parameters

integer
Date and time when to stop retrieving database history. If you specify end, you must also specify start. This parameter uses UNIX epoch time in milliseconds.
integer
Date and time when MongoDB Cloud begins retrieving database history. If you specify start, you must also specify end. This parameter uses UNIX epoch time in milliseconds.
integer
Maximum number of lines from the log to return.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.
string
One Internet Protocol address that attempted to authenticate with the database.
boolean
Flag that indicates whether the response returns the successful authentication attempts only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_ENCRYPTION_AT_RESTReturn One Configuration for Encryption at Rest Using Customer-Managed Keys for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_ENCRYPTION_AT_REST_PRIVATE_ENDPOINTReturn One Private Endpoint for Encryption at Rest Using Customer Key Management for One Cloud Provider in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the private endpoint.
string ("AZURE" | "AWS")
required
Human-readable label that identifies the cloud provider of the private endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_EVENTReturn One Event from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies the event that you want to return.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_FLEX_CLUSTERReturn One Flex Cluster from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
required
Human-readable label that identifies the flex cluster.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_FLEX_CLUSTER_BACKUP_RESTORE_JOBReturn One Restore Job for One Flex Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
required
Human-readable label that identifies the flex cluster.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the restore job to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_FLEX_CLUSTER_BACKUP_SNAPSHOTReturn One Snapshot for One Flex Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
required
Human-readable label that identifies the flex cluster.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the desired snapshot.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_HOST_FTS_METRIC_INDEX_MEASUREMENTSReturn Atlas Search Metrics for One Index in One Namespace. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.
array
required
List that contains the measurements that MongoDB Atlas reports for the associated data series.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the index.
string
required
Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.
string
required
Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.
string
required
Human-readable label that identifies the database.
string
required
Human-readable label that identifies the collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_INTEGRATIONReturn One Third-Party Service Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string ("PAGER_DUTY" | "SLACK" | "DATADOG" | "NEW_RELIC" | "OPS_GENIE" | "VICTOR_OPS" | "WEBHOOK" | "HIP_CHAT" | "PROMETHEUS" | "MICROSOFT_TEAMS")
required
Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_IP_ADDRESSESReturn All IP Addresses for One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_LIMITReturn One Limit for One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string ("atlas.project.security.databaseAccess.users" | "atlas.project.deployment.clusters" | "atlas.project.deployment.serverlessMTMs" | "atlas.project.security.databaseAccess.customRoles" | "atlas.project.security.networkAccess.entries" | "atlas.project.security.networkAccess.crossRegionEntries" | "atlas.project.deployment.nodesPerPrivateLinkRegion" | "dataFederation.bytesProcessed.query" | "dataFederation.bytesProcessed.daily" | "dataFederation.bytesProcessed.weekly" | "dataFederation.bytesProcessed.monthly" | "atlas.project.deployment.privateServiceConnectionsPerRegionGroup" | "atlas.project.deployment.privateServiceConnectionsSubnetMask")
required
Human-readable label that identifies this project limit. | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 100 | | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on AWS PrivateLink addressable target nodes per region in this project. For sharded clusters using optimized (load-balanced) connection strings, currentUsage doesn’t grow with the number of mongos — the load balancer is counted as a single addressable target regardless of how many mongos sit behind it. | 50 | 90 | | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | | dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_LIVE_MIGRATIONReturn One Migration Job. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the migration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_LIVE_MIGRATION_VALIDATE_STATUSReturn One Migration Validation Job. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the validation job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_LOG_INTEGRATIONReturn One Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

string
required
Unique identifier of the log integration configuration.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_MAINTENANCE_WINDOWReturn One Maintenance Window for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_MANAGED_SLOW_MSReturn Managed Slow Operation Threshold Status. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_MCP_CONFIGReturn One MCP Configuration for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique identifier of the MCP configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_MCP_CONFIG_SECRETReturn One Secret for One Project MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the secret.
string
required
Unique identifier of the MCP configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_METRIC_INTEGRATIONReturn One Metric Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique identifier of the metric integration configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_MONGO_DB_VERSIONSReturn a Page of Available MongoDB LTS Versions for Clusters in One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
Filter results to only one instance size.
string ("AWS" | "AZURE" | "GCP" | "TENANT")
Filter results to only one cloud provider.
string
Filter results to only the default values per tier. This value must be DEFAULT.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_PEERReturn One Network Peering Connection in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_PRIVATE_ENDPOINT_ENDPOINT_SERVICEReturn One Private Endpoint Service for One Provider. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string ("AWS" | "AZURE" | "GCP")
required
Cloud service provider that manages this private endpoint service.
string
required
Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_PRIVATE_ENDPOINT_ENDPOINT_SERVICE_ENDPOINTReturn One Private Endpoint for One Provider. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique string that identifies the private endpoint you want to return. The format of the endpointId parameter differs for AWS and Azure. You must URL encode the endpointId for Azure private endpoints.
string ("AWS" | "AZURE" | "GCP")
required
Cloud service provider that manages this private endpoint.
string
required
Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_PRIVATE_ENDPOINT_REGIONAL_MODEReturn Regionalized Private Endpoint Status. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_PRIVATE_NETWORK_SETTING_ENDPOINT_IDReturn One Federated Database Instance and Online Archive Private Endpoint in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_PROCESSReturn One MongoDB Process by ID. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_PROCESS_COLL_STAT_NAMESPACESReturn Ranked Namespaces from One Host. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_PROCESS_DATABASEReturn One Database for One MongoDB Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.
string
required
Human-readable label that identifies the database that the specified MongoDB process serves.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_PROCESS_DATABASE_MEASUREMENTSReturn Measurements for One Database in One MongoDB Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.
string
required
Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.
string
required
Human-readable label that identifies the database that the specified MongoDB process serves.
array
Measurement types to return. If omitted, Atlas returns all measurements that apply to the specified database.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_PROCESS_DISKReturn details for one disk or partition of a MongoDB process using the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.
string
required
Human-readable label of the disk or partition to which the measurements apply.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_PROCESS_DISK_MEASUREMENTSReturn Measurements of One Disk for One MongoDB Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.
string
required
Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.
string
required
Human-readable label of the disk or partition to which the measurements apply.
array
Measurement types to return. If omitted, Atlas returns all measurements that apply to the specified disk or partition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_PROCESS_MEASUREMENTSReturn Measurements for One MongoDB Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.
string
required
Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.
array
Measurement types to return. If omitted, Atlas returns all measurements that apply to the specified MongoDB process.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_SAMPLE_DATASET_LOADReturn Status of Sample Dataset Load for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the loaded sample dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_SERVICE_ACCOUNTReturn One Project Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
The Client ID of the Service Account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_SETTINGSReturn Project Settings. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_STREAM_ACCOUNT_DETAILSReturn Account ID and VPC ID for One Project and Region. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
The cloud provider specific region name, i.e. “US_EAST_1” for cloud provider “aws”.
string
required
One of “aws”, “azure” or “gcp”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_STREAM_CONNECTIONReturn One Stream Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Data Access Admin, Project Data Access Read Only, Project Data Access Read Write, Project Stream Processing Manager

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace to return.
string
required
Label that identifies the stream connection to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_STREAM_CONNECTION_FAILOVER_CONNECTIONReturn One Stream Failover Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace.
string
required
Label that identifies the stream connection.
string
required
Label that identifies the stream failover connection id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_STREAM_PROCESSORReturn One Stream Processor. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace.
string
required
Label that identifies the stream processor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_STREAM_PROCESSORSReturn a Page of Stream Processors in One Stream Workspace. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_STREAMS_WORKSPACE_PRIVATE_ENDPOINTReturn One Workspace Private Endpoint for Atlas Stream Processing. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Owner

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique identifier of the customer’s VPC endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_STREAM_WORKSPACEReturn One Stream Workspace. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Data Access Admin, Project Data Access Read Only, Project Data Access Read Write, Project Stream Processing Manager

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace to return.
boolean
Flag to indicate whether connections information should be included in the stream workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_TEAMReturn One Team in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the team for which you want to get.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_USERReturn One MongoDB Cloud User in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user’s userId or verify a user’s status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
array
Organization membership status to filter users by. You can supply this parameter multiple times. Allowed values: ACTIVE, PENDING, INVITATION_EXPIRED, INVITATION_REJECTED. If you exclude this parameter, this resource returns ACTIVE and PENDING users. Not supported in deprecated versions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_USER_SECURITYReturn LDAP or X.509 Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_GROUP_USER_SECURITY_LDAP_VERIFYReturn Status of LDAP Configuration Verification in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique string that identifies the request to verify an Lightweight Directory Access Protocol (LDAP) configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORGReturn One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_ACTIVITY_FEEDReturn Pre-Filtered Activity Feed Link for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Member.

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
End date and time for events to include in the activity feed link. ISO 8601 timestamp format in UTC.
string
Start date and time for events to include in the activity feed link. ISO 8601 timestamp format in UTC.
array
Category of incident recorded at this moment in time. IMPORTANT: The complete list of event type values changes frequently.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_AI_MODEL_API_CLOUD_GEOGRAPHY_MODEL_GROUP_NAME_RATE_LIMITSReturn a single AI model rate limit for an organization and model group using the MongoDB Atlas Administration API, with cloud and geography limited to ANY. Required Atlas role: Organization Read Only.

Input Parameters

string
required
Cloud provider scope. Must be “ANY”. Additional values will be supported in future API versions.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Geography scope. Must be “ANY”. Additional values will be supported in future API versions.
string
required
The name of the model group to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_AI_MODEL_API_KEYReturn Single AI Model API Key for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
The id of the API key to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_AI_MODEL_API_RATE_LIMITSReturn a page of AI model rate limits for one organization using the MongoDB Atlas Administration API. Required Atlas role: Organization Read Only.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_API_KEYReturn One Organization API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies this organization API key that you want to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_API_KEY_ACCESS_LIST_ENTRYReturn One Access List Entry for One Organization API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.
string
required
Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_ASSOCIATED_INVOICESReturn Associated Invoices. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

Input Parameters

integer
The year for which to retrieve invoices. Defaults to current year.
integer
The month for which to retrieve invoices (1-12). Defaults to current month.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Whether to include invoices from linked organizations. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_BILLING_COST_EXPLORER_USAGEReturn Usage Details for One Cost Explorer Query. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

Input Parameters

string
required
Unique 64 digit string that identifies the Cost Explorer query.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_DELEGATION_SETTINGSReturn Delegation Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_EVENTReturn One Event from One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member.

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies the event that you want to return.
boolean
Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_FEDERATION_SETTINGSReturn Federation Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_GROUPSReturn a Page of Projects in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

Input Parameters

string
Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name.
string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_INVOICEReturn One Invoice for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_INVOICE_CSVReturn One Invoice as CSV for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_INVOICE_REPORTReturn One Invoice Report. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
string
required
Unique string that identifies the report to retrieve.
string
required
Unique string that identifies the invoice the report was generated for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_LOG_INTEGRATIONReturn One Organization Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique identifier of the log integration configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_MAINTENANCE_SETTINGSReturn Maintenance Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_MCP_CONFIGReturn One MCP Configuration for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique identifier of the MCP configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_MCP_CONFIG_SECRETReturn One Secret for One Organization MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies the secret.
string
required
Unique identifier of the MCP configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_NON_COMPLIANT_RESOURCESReturn All Non-Compliant Resources. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_RESOURCE_POLICYReturn One Atlas Resource Policy. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies an atlas resource policy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_SANDBOX_CONFIGReturn Default Sandbox Configuration for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Project Creator.

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies the sandbox configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_SERVICE_ACCOUNTReturn One Organization Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only.

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
The Client ID of the Service Account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_SERVICE_ACCOUNT_GROUPSReturn a Page of Service Account Project Assignments. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
The Client ID of the Service Account.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_SETTINGSReturn Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_TEAMReturn One Team by ID. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the team whose information you want to return.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_TEAM_BY_NAMEReturn One Team by Name. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Name of the team whose information you want to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_ORG_USERReturn One MongoDB Cloud User in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user’s userId or verify a user’s status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
array
Organization membership status to filter users by. You can supply this parameter multiple times. Allowed values: ACTIVE, PENDING, INVITATION_EXPIRED, INVITATION_REJECTED. If you exclude this parameter, this resource returns ACTIVE and PENDING users. Not supported in deprecated versions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_RATE_LIMITReturn One Rate Limit. Uses the MongoDB Atlas Administration API. Required Atlas roles: No specific Atlas role is documented.

Input Parameters

string
Unique 24-hexadecimal digit string that identifies the Atlas Organization to request rate limits for. When this parameter is provided, the limits returned are applicable to the specified organization. The requesting user must have the Organization Read Only role for the specified organization.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
A string that identifies the Atlas user to request rate limits for. The ID can for example be the Service Account Client ID or the API Public Key. When this parameter is provided, the limits returned are applicable to the specified user. The requesting user must be the same as the specified user.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
Unique 24-hexadecimal digit string that identifies the Atlas Project to request rate limits for. When this parameter is provided, the limits returned are applicable to the specified project. The requesting user must have the Project Read Only role for the specified project.
string
An IP address to request rate limits for. When this parameter is provided, the limits returned are applicable to the specified IP address. The requesting user must have the same IP address as the one provided in the request.
string
required
The ID of the rate limit endpoint set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_SKUReturn One Stock Keeping Unit. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member, Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique identifier of the SKU to retrieve.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GET_SYSTEM_STATUSReturn the Status of This MongoDB Application. Uses the MongoDB Atlas Administration API.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_GRANT_GROUP_CLUSTER_MONGO_DB_EMPLOYEE_ACCESSGrant MongoDB Employee Cluster Access for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Support Access Manager.

Input Parameters

object
required
Documented request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies this cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_INVITE_GROUP_SERVICE_ACCOUNTAssign One Service Account to One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

Input Parameters

object
required
The Project permissions for the Service Account in the specified Project.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
The Client ID of the Service Account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ALERT_CONFIG_MATCHER_FIELD_NAMESReturn All Alert Configuration Matchers Field Names. Uses the MongoDB Atlas Administration API.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_CLUSTER_DETAILSReturn a Page of Authorized Clusters in All Projects. Uses the MongoDB Atlas Administration API.

Input Parameters

string
Cursor returned by the previous page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_CONTROL_PLANE_IP_ADDRESSESReturn All Control Plane IP Addresses. Uses the MongoDB Atlas Administration API.

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_DEFAULT_GROUP_LIMITSReturn a page of descriptions of user-configurable project limits using the MongoDB Atlas Administration API. Use the returned cursor to retrieve further pages.

Input Parameters

string
Cursor returned by the previous page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_EVENT_TYPESReturn a Page of Event Types. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member, Project Read Only.

Input Parameters

string
Cursor returned by the previous page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_FEDERATION_SETTING_CONNECTED_ORG_CONFIG_ROLE_MAPPINGSReturn a single paginated result of role mappings from one organization using the MongoDB Atlas Administration API; the result may not include every mapping. Required Atlas role: Organization Owner.

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your federation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_FEDERATION_SETTING_CONNECTED_ORG_CONFIGSReturn a Page of Organization Configurations from One Federation. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
integer
Number of items that the response returns per page.
string
required
Unique 24-hexadecimal digit string that identifies your federation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_FEDERATION_SETTING_IDENTITY_PROVIDERSReturn a Page of Identity Providers in One Federation. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
array
The types of the target identity providers.
array
The protocols of the target identity providers.
integer
Number of items that the response returns per page.
string
required
Unique 24-hexadecimal digit string that identifies your federation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_ACCESS_LIST_ENTRIESReturn a Page of Project IP Access List Entries. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_AI_MODEL_API_KEYSReturn a page of AI Model API Keys for one group using the MongoDB Atlas Administration API, with a continuation cursor when more results may be available. Required Atlas role: Project Read Only.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_ALERT_CONFIGSReturn a Page of Alert Configurations in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

Input Parameters

string
Cursor returned by the previous page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_ALERTSReturn a Page of Alerts from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string ("OPEN" | "TRACKING" | "CLOSED")
Status of the alerts to return. Omit this parameter to return all alerts in all statuses. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_API_KEYSReturn a Page of Organization API Keys Assigned to One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_BACKUP_EXPORT_BUCKETSReturn a Page of Snapshot Export Buckets. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_BACKUP_PRIVATE_ENDPOINTSReturn a page of AWS object storage private endpoints for cloud backups in a project using the MongoDB Atlas Administration API. Requires the Project Owner Atlas role.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
string
required
Human-readable label that identifies the cloud provider for the private endpoints to return.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLOUD_PROVIDER_ACCESSReturn All Cloud Provider Access Roles. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_BACKUP_EXPORTSReturn a Page of Snapshot Export Jobs. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_BACKUP_RESTORE_JOBSReturn a Page of Restore Jobs for One Cluster. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster with the restore jobs you want to return.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_BACKUP_SNAPSHOT_DATABASE_COLLECTIONSReturn Collections in One Database in One Snapshot. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the desired snapshot.
string
required
Human-readable label that identifies the cluster.
string
required
Human-readable label that identifies the database.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_BACKUP_SNAPSHOT_DATABASESReturn Databases in One Snapshot. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the desired snapshot.
string
required
Human-readable label that identifies the cluster.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_BACKUP_SNAPSHOTSReturn a Page of Replica Set Cloud Backups. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
integer
Oplog timestamp that represents the desired point in time. This is the first part of an Oplog timestamp. Must be used with oplogInc. Mutually exclusive with pointInTimeUtcSeconds.
integer
Oplog operation number that represents the desired point in time. This is the second part of an Oplog timestamp. Must be used with oplogTs. Mutually exclusive with pointInTimeUtcSeconds.
string
required
Human-readable label that identifies the cluster.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.
integer
Desired point in time, expressed as the number of seconds that have elapsed since the UNIX epoch. If specified, returns the closest snapshot created before that point in time. Mutually exclusive with oplogTs and oplogInc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_BACKUP_SNAPSHOT_SHARDED_CLUSTERSReturn All Sharded Cluster Cloud Backups. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_COLLECTION_RESTORE_JOB_COLLECTIONSReturn a Page of Collection States for One Collection Restore Job. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

Input Parameters

string ("NOT_STARTED" | "IN_PROGRESS" | "FINALIZING" | "NOT_FOUND" | "UNSUPPORTED" | "SUCCESSFUL" | "ROLLBACK" | "NOT_RESTORED" | "FAILED")
Collection-level state to filter by.
string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the collection restore job.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster with the collection restore job you want to return.
integer
Number of items that the response returns per page.
string
Source namespace to filter by (e.g. db.collection).
string
Target namespace to filter by (e.g. db.collection).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_COLLECTION_RESTORE_JOBSReturn a Page of Collection Restore Jobs for One Cluster. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster with the collection restore jobs you want to return.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_COLL_STAT_MEASUREMENTSReturn cluster-level query latency measurements for a specified database and collection using the MongoDB Atlas Administration API. Requires the Project Read Only Atlas role.

Input Parameters

string
Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.
array
List that contains the metrics that you want to retrieve for the associated data series. If you don’t set this parameter, this resource returns data series for all Coll Stats Latency metrics.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster to retrieve metrics for.
string ("PRIMARY" | "SECONDARY" | "INDIVIDUAL_PROCESS")
required
Human-readable label that identifies the cluster topology to retrieve metrics for.
string
required
Human-readable label that identifies the database.
string
required
Human-readable label that identifies the collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_COLL_STAT_PINNED_NAMESPACESReturn Pinned Namespaces. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster to retrieve pinned namespaces for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_ONLINE_ARCHIVESReturn a Page of Online Archives for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_OVERLOAD_SIMULATIONSReturn a Page of Overload Protection Simulations. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster on which the overload protection simulations are running.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_PERFORMANCE_ADVISOR_DROP_INDEX_SUGGESTIONSReturn All Suggested Indexes to Drop. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_PERFORMANCE_ADVISOR_SCHEMA_ADVICEReturn Schema Advice. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_PERFORMANCE_ADVISOR_SUGGESTED_INDEXESReturn All Suggested Indexes. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

integer
Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the UNIX epoch. - If you don’t specify the until parameter, the endpoint returns data covering from the since value and the current time. - If you specify neither the since nor the until parameters, the endpoint returns data from the previous 24 hours.
integer
Date and time up until which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the UNIX epoch. - If you specify the until parameter, you must specify the since parameter. - If you specify neither the since nor the until parameters, the endpoint returns data from the previous 24 hours.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
array
Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as .: <database>.<collection>. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (&) between each namespace. Omit this parameter to return results for all namespaces.
array
Process IDs from which to retrieve suggested indexes. A processId is a combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests. To include multiple processIds, pass the parameter multiple times delimited with an ampersand (&) between each processId.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_PRIVATE_ENDPOINT_CONNECTION_STRINGSReturn a Page of Private Endpoint Connection Strings for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

Input Parameters

string
Cursor returned by the previous page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string ("PENDING" | "AVAILABLE" | "FAILED")
Filter records by lifecycle status.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.
string ("SELF_MANAGED" | "IMPORTED")
Filter records by management type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_PROVIDER_REGIONSReturn a Page of Cloud Provider Regions. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

Input Parameters

string
Cluster tier for which to retrieve the regions.
string
Cursor returned by the previous page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
array
Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_QUERY_SHAPE_INSIGHT_SUMMARIESReturn Query Statistic Summaries. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

integer
Date and time from which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the UNIX epoch. - If you don’t specify the until parameter, the endpoint returns data covering from the since value and the current time. - If you specify neither the since nor the until parameters, the endpoint returns data from the previous 24 hours.
integer
Date and time up until which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the UNIX epoch. - If you specify the until parameter, you must specify the since parameter. - If you specify neither the since nor the until parameters, the endpoint returns data from the previous 24 hours.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
array
Query shape statistics data series to retrieve. A series represents a specific metric about query execution. To include multiple series, pass the parameter multiple times delimited with an ampersand (&) between each series. Omit this parameter to return results for all available series. The P50_EXECUTION_TIME, P90_EXECUTION_TIME, and P99_EXECUTION_TIME series are deprecated as the values they report may be inaccurate. They will be removed in a future release.
array
Retrieve query shape statistics matching specified MongoDB commands. To include multiple commands, pass the parameter multiple times delimited with an ampersand (&) between each command. The currently supported parameters are: find, distinct, aggregate, count, insert, update, and delete. The insert, update, and delete commands return results only for clusters running MongoDB 9.0 or later with write query shape statistics enabled for the project. Omit this parameter to return results for all supported commands.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
array
Namespaces from which to retrieve query shape statistics. A namespace consists of one database and one collection resource written as .: <database>.<collection>. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (&) between each namespace. Omit this parameter to return results for all namespaces.
integer
Maximum number of query statistic summaries to return.
array
Process IDs from which to retrieve query shape statistics. A processId is a combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests. To include multiple processId, pass the parameter multiple times delimited with an ampersand (&) between each processId.
string
required
Human-readable label that identifies the cluster.
array
A list of SHA256 hashes of desired query shapes, output by MongoDB commands like $queryStats and $explain or slow query logs. To include multiple series, pass the parameter multiple times delimited with an ampersand (&) between each series. Omit this parameter to return results for all available series.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_QUERY_SHAPESReturn a page of rejected query shapes for one cluster using the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
The status of query shapes to retrieve. Only REJECTED status is supported. If omitted, defaults to REJECTED.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTERSReturn a Page of Clusters in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

Input Parameters

string
Cursor returned by the previous page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.
boolean
Controls how hardware specification fields are returned in the response. When set to true, returns the original client-specified values and provides separate effective fields showing current operational values. When false (default), hardware specification fields show current operational values directly. Primarily used for autoscaling compatibility.
boolean
Flag that indicates whether to return Clusters with retain backups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_SEARCH_INDEXReturn All Atlas Search Indexes for One Collection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Read Only, Project Data Access Read Write, Project Search Index Editor, Project Stream Processing Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Name of the cluster that contains the collection with one or more Atlas Search indexes.
string
required
Label that identifies the database that contains the collection with one or more Atlas Search indexes.
string
required
Name of the collection that contains one or more Atlas Search indexes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CLUSTER_SEARCH_INDEXESReturn All Atlas Search Indexes for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Read Only, Project Data Access Read Write, Project Search Index Editor, Project Stream Processing Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Name of the cluster that contains the collection with one or more Atlas Search indexes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_COLL_STAT_METRICSReturn collection statistics latency metric names and units for one project using the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CONTAINER_ALLReturn a Page of Network Peering Containers in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CONTAINERSReturn a Page of Network Peering Containers in One Project for One Cloud Provider. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
string ("AWS" | "AZURE" | "GCP")
required
Cloud service provider that serves the desired network peering containers.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_CUSTOM_DB_ROLE_ROLESReturn All Custom Roles in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_DATABASE_USER_CERTSReturn a Page of X.509 Certificates Assigned to One Database User. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that represents the MongoDB database user account whose certificates you want to return.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_DATABASE_USERSReturn a Page of Database Users in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_DATA_FEDERATIONReturn federated database instances of a selected type in one project, defaulting to USER. Uses the MongoDB Atlas Administration API; required Atlas role: Project Read Only.

Input Parameters

string ("USER" | "ONLINE_ARCHIVE")
Type of Federated Database Instances to return.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_DATA_FEDERATION_LIMITSReturn All Query Limits for One Federated Database Instance. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the federated database instance for which you want to retrieve query limits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_ENCRYPTION_AT_REST_PRIVATE_ENDPOINTSReturn a page of private endpoints for encryption at rest using customer key management for one cloud provider in one project. Uses the MongoDB Atlas Administration API and requires the Project Owner role.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
string ("AZURE" | "AWS")
required
Human-readable label that identifies the cloud provider for the private endpoints to return.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_EVENTSReturn a page of events from one project using the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

string
Cursor returned by the previous page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.
string
Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.
array
Category of incident recorded at this moment in time. IMPORTANT: The complete list of event type values changes frequently.
boolean
Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.
array
Human-readable label that identifies the cluster.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.
array
Category of event that you would like to exclude from query results, such as CLUSTER_CREATED. IMPORTANT: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_FLEX_CLUSTER_BACKUP_RESTORE_JOBSReturn a Page of Restore Jobs for One Flex Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
required
Human-readable label that identifies the flex cluster.
string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_FLEX_CLUSTER_BACKUP_SNAPSHOTSReturn a Page of Snapshots for One Flex Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
required
Human-readable label that identifies the flex cluster.
string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_FLEX_CLUSTERSReturn a Page of Flex Clusters from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_HOST_FTS_METRIC_INDEX_MEASUREMENTSReturn selected Atlas Search index metrics for a namespace on one MongoDB process. Uses the MongoDB Atlas Administration API and requires the Project Read Only role.

Input Parameters

string
Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.
array
required
List that contains the measurements that MongoDB Atlas reports for the associated data series.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.
string
required
Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.
string
required
Human-readable label that identifies the database.
string
required
Human-readable label that identifies the collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_HOST_FTS_METRIC_MEASUREMENTSReturn Atlas Search Hardware and Status Metrics. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.
array
required
List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don’t set this parameter, this resource returns all hardware and status metrics for the associated data series.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.
string
required
Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_HOST_FTS_METRICSReturn All Atlas Search Metric Types for One Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_INTEGRATIONSReturn a Page of Active Third-Party Service Integrations. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_LIMITSReturn All Limits for One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_LOG_INTEGRATIONSReturn a Page of Active Log Integrations. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.
string
Optional filter by integration type (e.g., S3_LOG_EXPORT).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_MCP_CONFIGSReturn a Page of MCP Configurations for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_MCP_CONFIG_SECRETSReturn a Page of Secrets for One Project MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
string
required
Unique identifier of the MCP configuration.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_METRIC_INTEGRATIONSReturn a Page of Active Metric Integrations. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
string
Optional filter by provider type (e.g., CUSTOM). When specified, integrationType must also be specified.
integer
Number of items that the response returns per page.
string
Optional filter by integration type (e.g., OTEL).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_PEERSReturn a page of network peering connections for one provider in one project, defaulting to AWS, using the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
string ("AWS" | "AZURE" | "GCP")
Cloud service provider to use for this VPC peering connection.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_PRIVATE_ENDPOINT_ENDPOINT_SERVICEReturn All Private Endpoint Services for One Provider. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string ("AWS" | "AZURE" | "GCP")
required
Cloud service provider that manages this private endpoint service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_PRIVATE_NETWORK_SETTING_ENDPOINT_IDSReturn a Page of Federated Database Instance and Online Archive Private Endpoints in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_PROCESS_COLL_STAT_MEASUREMENTSReturn host-level query latency measurements for one collection on a MongoDB process using the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

string
Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
string
Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.
array
List that contains the metrics that you want to retrieve for the associated data series. If you don’t set this parameter, this resource returns data series for all Coll Stats Latency metrics.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.
string
required
Human-readable label that identifies the database.
string
required
Human-readable label that identifies the collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_PROCESS_DATABASESReturn Available Databases for One MongoDB Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod). The port must be the IANA port on which the MongoDB process listens for requests.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_PROCESS_DISKSReturn Available Disks for One MongoDB Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_PROCESSESReturn a Page of MongoDB Processes in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_PROCESS_PERFORMANCE_ADVISOR_NAMESPACESReturn All Namespaces for One Host. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

integer
Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the UNIX epoch. - If you don’t specify the duration parameter, the endpoint returns data covering from the since value and the current time. - If you specify neither the duration nor the since parameters, the endpoint returns data from the previous 24 hours.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
integer
Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. - If you don’t specify the since parameter, the endpoint returns data covering the duration before the current time. - If you specify neither the duration nor since parameters, the endpoint returns data from the previous 24 hours.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_PROCESS_PERFORMANCE_ADVISOR_SLOW_QUERY_LOGSReturn Slow Queries. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin, Project Data Access Read Only, Project Data Access Read Write, Project Observability Viewer, Project Stream Processing Owner

Input Parameters

integer
Date and time from which the query retrieves the slow queries. This parameter expresses its value in the number of milliseconds that have elapsed since the UNIX epoch. - If you don’t specify the duration parameter, the endpoint returns data covering from the since value and the current time. - If you specify neither the duration nor the since parameters, the endpoint returns data from the previous 24 hours.
integer
Maximum number of lines from the log to return.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
integer
Length of time expressed during which the query finds slow queries among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. - If you don’t specify the since parameter, the endpoint returns data covering the duration before the current time. - If you specify neither the duration nor since parameters, the endpoint returns data from the previous 24 hours.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
array
Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as .: <database>.<collection>. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (&) between each namespace. Omit this parameter to return results for all namespaces.
string
required
Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.
boolean
Whether or not to include metrics extracted from the slow query log as separate fields.
boolean
Whether or not to include the operation type (read/write/command) extracted from the slow query log as a separate field.
boolean
Whether or not to include the replica state of the host when the slow query log was generated as a separate field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_PROCESS_PERFORMANCE_ADVISOR_SUGGESTED_INDEXESReturn a Page of Suggested Indexes. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

integer
Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the UNIX epoch. - If you don’t specify the duration parameter, the endpoint returns data covering from the since value and the current time. - If you specify neither the duration nor the since parameters, the endpoint returns data from the previous 24 hours.
string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
integer
Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. - If you don’t specify the since parameter, the endpoint returns data covering the duration before the current time. - If you specify neither the duration nor since parameters, the endpoint returns data from the previous 24 hours.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
integer
Number that indicates the maximum indexes to suggest.
integer
Maximum number of example queries that benefit from the suggested index.
array
Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as .: <database>.<collection>. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (&) between each namespace. Omit this parameter to return results for all namespaces.
string
required
Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUPSReturn a Page of Projects. Uses the MongoDB Atlas Administration API.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_SERVICE_ACCOUNT_ACCESS_LISTReturn a Page of Access List Entries for One Project Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
The Client ID of the Service Account.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_SERVICE_ACCOUNTSReturn a Page of Project Service Accounts. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
integer
Number of items that the response returns per page.
boolean
Flag that indicates whether system-managed Service Accounts (such as those used for MCP ingress/egress integrations) are included in the response. When false, only user-managed Service Accounts are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_STREAM_ACTIVE_VPC_PEERING_CONNECTIONSReturn a Page of Active Incoming VPC Peering Connections. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_STREAM_CONNECTION_FAILOVER_CONNECTIONSReturn a Page of Stream Failover Connections. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace.
integer
Number of items that the response returns per page.
string
required
Label that identifies the stream connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_STREAM_CONNECTIONSReturn a Page of Connections of the Stream Workspaces. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Data Access Admin, Project Data Access Read Only, Project Data Access Read Write, Project Stream Processing Manager

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_STREAMS_WORKSPACE_PRIVATE_ENDPOINTSReturn a Page of Workspace Private Endpoints for Atlas Stream Processing. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Owner

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_STREAM_VPC_PEERING_CONNECTIONSReturn a page of stream VPC peering connections for a project and requester account using the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
integer
Number of items that the response returns per page.
string
required
The Account ID of the VPC Peering connection/s.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_STREAM_WORKSPACESReturn a Page of Stream Workspaces in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_TEAMSReturn a Page of Teams in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_GROUP_USERSReturn a Page of MongoDB Cloud Users in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
Email address to filter users by. Not supported in deprecated versions.
boolean
Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If "flattenTeams" : false, this resource returns only users with a role in the project. If "flattenTeams" : true, this resource returns both users with roles in the project and users who belong to teams with roles in the project.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.
boolean
Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If "includeOrgUsers": false, this resource returns only users with a role in the project. If "includeOrgUsers": true, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role.
string
Deprecated: Use orgMembershipStatuses instead. Organization membership status to filter users by. Allowed values: ACTIVE, PENDING, INVITATION_EXPIRED, INVITATION_REJECTED. If you exclude this parameter, this resource returns ACTIVE and PENDING users. Not supported in deprecated versions.
array
Organization membership status to filter users by. You can supply this parameter multiple times. Allowed values: ACTIVE, PENDING, INVITATION_EXPIRED, INVITATION_REJECTED. Replaces the deprecated orgMembershipStatus parameter. If you exclude this parameter, this resource returns ACTIVE and PENDING users. Cannot be combined with orgMembershipStatus. Not supported in deprecated versions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ORG_AI_MODEL_API_KEYSReturn a page of AI model API keys for one organization using the MongoDB Atlas Administration API. Required Atlas role: Organization Read Only.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ORG_API_KEY_ACCESS_LIST_ENTRIESReturn a Page of Access List Entries for One Organization API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ORG_API_KEYSReturn a Page of Organization API Keys. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ORG_EVENTSReturn a page of events from one organization using the MongoDB Atlas Administration API. Required Atlas role: Organization Member.

Input Parameters

string
Cursor returned by the previous page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.
string
Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.
array
Category of incident recorded at this moment in time. IMPORTANT: The complete list of event type values changes frequently.
boolean
Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ORG_INVOICE_PENDINGReturn All Pending Invoices for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ORG_INVOICE_REPORTSReturn a Page of Invoice Reports for One Invoice. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique string that identifies the invoice to list reports for.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ORG_INVOICESReturn a Page of Invoices for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string ("START_DATE" | "END_DATE")
Field used to sort the returned invoices by. Use in combination with orderBy parameter to control the order of the result.
string
Retrieve the invoices the endDates of which are smaller than or equal to the toDate. If omit, the invoices return will go further to latest endDate.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string ("desc" | "asc")
Field used to order the returned invoices by. Use in combination of sortBy parameter to control the order of the result.
string
Retrieve the invoices the startDates of which are greater than or equal to the fromDate. If omit, the invoices return will go back to earliest startDate.
array
Statuses of the invoice to be retrieved. Omit to return invoices of all statuses.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.
boolean
Flag that indicates whether to return linked invoices in the linkedInvoices field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ORG_LIVE_MIGRATION_AVAILABLE_PROJECTSReturn All Projects Available for Migration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ORG_LOG_INTEGRATIONSReturn a Page of Organization Log Integrations. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ORG_MCP_CONFIGSReturn a Page of MCP Configurations for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ORG_MCP_CONFIG_SECRETSReturn a Page of Secrets for One Organization MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
string
required
Unique identifier of the MCP configuration.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ORG_RESOURCE_POLICIESReturn All Atlas Resource Policies. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ORGSReturn a Page of Organizations. Uses the MongoDB Atlas Administration API. Required Atlas roles: No specific Atlas role is documented.

Input Parameters

string
Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name.
string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ORG_SANDBOX_CONFIGReturn Sandbox Configuration IDs for an Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Project Creator.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ORG_SERVICE_ACCOUNT_ACCESS_LISTReturn a Page of Access List Entries for One Organization Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
The Client ID of the Service Account.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ORG_SERVICE_ACCOUNTSReturn a Page of Organization Service Accounts. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only.

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
integer
Number of items that the response returns per page.
boolean
Flag that indicates whether system-managed Service Accounts (such as those used for MCP ingress/egress integrations) are included in the response. When false, only user-managed Service Accounts are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ORG_TEAMSReturn a Page of Teams in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ORG_TEAM_USERSReturn a Page of MongoDB Cloud Users Assigned to One Team. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the team whose application users you want to return.
string
Unique 24-hexadecimal digit string to filter users by. Not supported in deprecated versions.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
Email address to filter users by. Not supported in deprecated versions.
integer
Number of items that the response returns per page.
string
Deprecated: Use orgMembershipStatuses instead. Organization membership status to filter users by. Allowed values: ACTIVE, PENDING, INVITATION_EXPIRED, INVITATION_REJECTED. If you exclude this parameter, this resource returns ACTIVE and PENDING users. Not supported in deprecated versions.
array
Organization membership status to filter users by. You can supply this parameter multiple times. Allowed values: ACTIVE, PENDING, INVITATION_EXPIRED, INVITATION_REJECTED. Replaces the deprecated orgMembershipStatus parameter. If you exclude this parameter, this resource returns ACTIVE and PENDING users. Cannot be combined with orgMembershipStatus. Not supported in deprecated versions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_ORG_USERSReturn a Page of MongoDB Cloud Users in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
Email address to filter users by. Not supported in deprecated versions.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.
string
Deprecated: Use orgMembershipStatuses instead. Organization membership status to filter users by. Allowed values: ACTIVE, PENDING, INVITATION_EXPIRED, INVITATION_REJECTED. If you exclude this parameter, this resource returns ACTIVE and PENDING users. Not supported in deprecated versions.
array
Organization membership status to filter users by. You can supply this parameter multiple times. Allowed values: ACTIVE, PENDING, INVITATION_EXPIRED, INVITATION_REJECTED. Replaces the deprecated orgMembershipStatus parameter. If you exclude this parameter, this resource returns ACTIVE and PENDING users. Cannot be combined with orgMembershipStatus. Not supported in deprecated versions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_RATE_LIMITSReturn a Page of Rate Limits. Uses the MongoDB Atlas Administration API. Required Atlas roles: No specific Atlas role is documented.

Input Parameters

string
Filters the returned endpoint sets by the provided endpoint set name. Multiple names may be provided, for example /rateLimits?name=Name1&name=Name2. For names that use spaces, replace the space with its URL-encoded value (%20).
string
Opaque continuation cursor from the preceding page; omit for the first page.
string
Unique 24-hexadecimal digit string that identifies the Atlas Organization to request rate limits for. When this parameter is provided, only organization scoped endpoint sets are returned and the limits returned are applicable to the specified organization. The requesting user must have the Organization Read Only role for the specified organization.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
A string that identifies the Atlas user to request rate limits for. The ID can for example be the Service Account Client ID or the API Public Key. When this parameter is provided, only user scoped endpoint sets are returned and the limits returned are applicable to the specified user. The requesting user must be the same as the specified user.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
Unique 24-hexadecimal digit string that identifies the Atlas Project to request rate limits for. When this parameter is provided, only group scoped endpoint sets are returned and the limits returned are applicable to the specified project. The requesting user must have the Project Read Only role for the specified project.
string
An IP address to request rate limits for. When this parameter is provided, only IP scoped endpoint sets are returned and the limits returned are applicable to the specified IP address. The requesting user must have the same IP address as the one provided in the request.
string
Filters the returned endpoint sets by the provided endpoint path. Multiple paths may be provided, for example /rateLimits?endpointPath=%2Fapi%2Fatlas%2Fv2%2Fclusters&endpointPath=%2Fapi%2Fatlas%2Fv2%2Fgroups%2F%7BgroupId%7D%2F. Replace /, { and } with their URL-encoded values (%2F, %7B and %7D respectively).
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_LIST_SKUSReturn a Page of Stock Keeping Units. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member, Project Read Only

Input Parameters

string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_MIGRATE_GROUPMigrate One Project to Another Organization. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

Input Parameters

object
required
Migrates a project from its current organization to another organization.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_PIN_GROUP_CLUSTER_COLL_STAT_PINNED_NAMESPACESPin Namespaces. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster to pin namespaces to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_PIN_GROUP_CLUSTER_FEATURE_COMPATIBILITY_VERSIONPin Feature Compatibility Version for One Cluster in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

object
Documented request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies this cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_REJECT_GROUP_STREAM_VPC_PEERING_CONNECTIONReject One Incoming VPC Peering Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Owner

Input Parameters

string
required
The VPC Peering Connection id.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_REMOVE_FEDERATION_SETTING_CONNECTED_ORG_CONFIGRemove One Organization Configuration from One Federation. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your federation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_REMOVE_GROUP_API_KEYUnassign One Organization API Key from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_REMOVE_GROUP_TEAMRemove One Team from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_REMOVE_GROUP_USERRemove One MongoDB Cloud User from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user’s userId or verify a user’s status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_REMOVE_GROUP_USER_ROLERemove One Project Role from One MongoDB Cloud User. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the pending or active user in the project. If you need to lookup a user’s userId or verify a user’s status in the organization, use the Return All MongoDB Cloud Users in One Project resource and filter by username.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_REMOVE_ORG_TEAM_USERRemove One MongoDB Cloud User from One Team. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the team to remove the MongoDB user from.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_REMOVE_ORG_USERRemove One MongoDB Cloud User from One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user’s userId or verify a user’s status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_REMOVE_ORG_USER_ROLERemove One Organization Role from One MongoDB Cloud User. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user’s userId or verify a user’s status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_RENAME_ORG_TEAMRename One Team. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the team that you want to rename.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_REQUEST_GROUP_ENCRYPTION_AT_REST_PRIVATE_ENDPOINT_DELETIONDelete One Private Endpoint for Encryption at Rest Using Customer Key Management for One Cloud Provider from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the private endpoint to delete.
string ("AZURE" | "AWS")
required
Human-readable label that identifies the cloud provider of the private endpoint to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_REQUEST_GROUP_SAMPLE_DATASET_LOADLoad Sample Dataset into One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

string
required
Human-readable label that identifies the cluster into which you load the sample dataset.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_RESET_GROUP_AI_MODEL_API_CLOUD_GEOGRAPHY_MODEL_GROUP_NAME_RATE_LIMITSReset the AI model rate limit for one model group in a project using the MongoDB Atlas Administration API; cloud and geography scopes must both be ANY. Required Atlas role: Project Model Owner.

Input Parameters

string
required
Cloud provider scope. Must be “ANY”. Additional values will be supported in future API versions.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Geography scope. Must be “ANY”. Additional values will be supported in future API versions.
string
required
The name of the model group to be reset to default rate limits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_RESET_GROUP_AI_MODEL_API_RATE_LIMITSReset AI Model Rate Limits for Group. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Model Owner.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_RESET_GROUP_MAINTENANCE_WINDOWReset One Maintenance Window for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_RESET_ORG_MAINTENANCE_SETTINGSReset Maintenance Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_RESTART_GROUP_CLUSTER_PRIMARIESTest Failover for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_REVOKE_FEDERATION_SETTING_IDENTITY_PROVIDER_JWKSRevoke JWKS from One OIDC Identity Provider. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies the identity provider to connect.
string
required
Unique 24-hexadecimal digit string that identifies your federation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_REVOKE_GROUP_CLUSTER_MONGO_DB_EMPLOYEE_ACCESSRevoke MongoDB Employee Cluster Access for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Support Access Manager.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies this cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_SEARCH_ORG_INVOICE_LINE_ITEMSReturn a Page of Line Items for One Invoice by Invoice ID. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing Viewer

Input Parameters

object
required
Request body for an Invoice Usage Details query with filtering, pagination, and sort.
string
Opaque continuation cursor from the preceding page; omit for the first page.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_SET_GROUP_DATA_FEDERATION_LIMITConfigure One Query Limit for One Federated Database Instance. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

object
required
Details of a tenant-level query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string ("bytesProcessed.query" | "bytesProcessed.daily" | "bytesProcessed.weekly" | "bytesProcessed.monthly")
required
Human-readable label that identifies this data federation instance limit. | Limit Name | Description | Default | | --- | --- | --- | | bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A | | bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A | | bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A | | bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |.
string
required
Human-readable label that identifies the federated database instance to which the query limit applies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_SET_GROUP_LIMITSet One Project Limit. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Owner.

Input Parameters

object
required
Limit to update.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string ("atlas.project.security.databaseAccess.users" | "atlas.project.deployment.clusters" | "atlas.project.deployment.serverlessMTMs" | "atlas.project.security.databaseAccess.customRoles" | "atlas.project.security.networkAccess.entries" | "atlas.project.security.networkAccess.crossRegionEntries" | "atlas.project.deployment.nodesPerPrivateLinkRegion" | "dataFederation.bytesProcessed.query" | "dataFederation.bytesProcessed.daily" | "dataFederation.bytesProcessed.weekly" | "dataFederation.bytesProcessed.monthly" | "atlas.project.deployment.privateServiceConnectionsPerRegionGroup" | "atlas.project.deployment.privateServiceConnectionsSubnetMask")
required
Human-readable label that identifies this project limit. | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 100 | | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on AWS PrivateLink addressable target nodes per region in this project. For sharded clusters using optimized (load-balanced) connection strings, currentUsage doesn’t grow with the number of mongos — the load balancer is counted as a single addressable target regardless of how many mongos sit behind it. | 50 | 90 | | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | | dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100| | atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_START_GROUP_CLUSTER_OUTAGE_SIMULATIONStart One Outage Simulation. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager, Project Cluster Resilience Tester, Project Replica Set Manager

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster to undergo an outage simulation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_START_GROUP_STREAM_PROCESSORStart One Stream Processor. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace.
string
required
Label that identifies the stream processor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_START_GROUP_STREAM_PROCESSOR_WITHStart One Stream Processor With Options. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

Input Parameters

object
A request to start a stream processor.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace.
string
required
Label that identifies the stream processor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_STOP_GROUP_STREAM_PROCESSORStop One Stream Processor. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace.
string
required
Label that identifies the stream processor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_TAKE_GROUP_CLUSTER_BACKUP_SNAPSHOTSTake One On-Demand Snapshot. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Creator

Input Parameters

object
required
Takes one on-demand snapshot.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_TENANT_GROUP_FLEX_CLUSTER_UPGRADEUpgrade One Flex Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_TOGGLE_GROUP_ALERT_CONFIGToggle State of One Alert Configuration in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Alerts Manager.

Input Parameters

object
required
Documented request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_TOGGLE_GROUP_AWS_CUSTOM_DNSUpdate State of One Custom DNS Configuration for Atlas Clusters on AWS. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_TOGGLE_GROUP_MAINTENANCE_WINDOW_AUTO_DEFERToggle Automatic Deferral of Maintenance for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_TOGGLE_GROUP_PRIVATE_ENDPOINT_REGIONAL_MODEToggle Regionalized Private Endpoint Status. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

object
required
Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UNPIN_GROUP_CLUSTER_COLL_STAT_UNPIN_NAMESPACESUnpin Namespaces. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster to unpin namespaces from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UNPIN_GROUP_CLUSTER_FEATURE_COMPATIBILITY_VERSIONUnpin Feature Compatibility Version for One Cluster in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies this cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_FEDERATION_SETTING_CONNECTED_ORG_CONFIGUpdate One Organization Configuration in One Federation. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

Input Parameters

object
required
The connected organization configuration that you want to update.
string
required
Unique 24-hexadecimal digit string that identifies the connected organization configuration to update.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your federation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_FEDERATION_SETTING_CONNECTED_ORG_CONFIG_ROLE_MAPPINGUpdate One Role Mapping in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

Input Parameters

string
required
Unique 24-hexadecimal digit string that identifies the role mapping that you want to update.
object
required
The role mapping that you want to update.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your federation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_FEDERATION_SETTING_IDENTITY_PROVIDERUpdate One Identity Provider. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.

Input Parameters

string
required
The identity provider that you want to update.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.
string
required
Unique 24-hexadecimal digit string that identifies your federation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUPUpdate One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Owner.

Input Parameters

object
required
Project to update.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_AI_MODEL_API_CLOUD_GEOGRAPHY_MODEL_GROUP_NAME_RATE_LIMITSUpdate AI Model Rate Limit. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Model Owner.

Input Parameters

object
required
A request containing the new rate limits for the given model group.
string
required
Cloud provider scope. Must be “ANY”. Additional values will be supported in future API versions.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Geography scope. Must be “ANY”. Additional values will be supported in future API versions.
string
required
The name of the model group to be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_AI_MODEL_API_KEYUpdate the name of an existing AI Model API Key in one project using the MongoDB Atlas Administration API. Required Atlas role: Project Model Owner.

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
The id of the API key to be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_ALERT_CONFIGUpdate One Alert Configuration in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Alerts Manager.

Input Parameters

string
required
Documented request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the alert configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_API_KEY_ROLESUpdate Organization API Key Roles for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

Input Parameters

object
required
Operation-specific request body.
string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_AUDIT_LOGUpdate auditing configuration for one project using the MongoDB Atlas Administration API; requires the Project Owner role. Omitted auditing-enabled and successful-authorization-auditing flags are sent as false.

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_BACKUP_COMPLIANCE_POLICYUpdate a project’s Backup Compliance Policy settings using the MongoDB Atlas Administration API; requires the Project Owner role. By default, the request asks Atlas to overwrite noncomplying backup policies with the new settings.

Input Parameters

object
required
The new Backup Compliance Policy settings.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_BACKUP_EXPORT_BUCKETUpdate One Export Bucket Private Networking Settings. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

Input Parameters

object
required
Updates the private networking requirement for the snapshot export bucket.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal character string that identifies the snapshot export bucket.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_CLUSTERUpdate One Cluster in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager, Project Cluster Resilience Tester, Project Replica Set Manager.

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.
boolean
Controls how hardware specification fields are returned in the response after cluster updates. When set to true, returns the original client-specified values and provides separate effective fields showing current operational values. When false (default), hardware specification fields show current operational values directly. Note: When using this header with autoscaling enabled, MongoDB ignores replicationSpecs changes during updates. To intentionally override the replicationSpecs, disable this header.
boolean
Controls how replicationSpecs fields are returned in the response. When set to true, stores the client’s view of replicationSpecs and returns it in replicationSpecs, while the actual cluster state (including auto-scaled hardware and auto-added shards) is returned in effectiveReplicationSpecs. When false (default), replicationSpecs contains the actual cluster state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_CLUSTER_ADAPTIVE_SETTINGSUpdate Adaptive Settings for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

object
required
Documented request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_CLUSTER_BACKUP_SCHEDULEUpdate Cloud Backup Schedule for One Cluster. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_CLUSTER_BACKUP_SNAPSHOTUpdate Expiration Date for One Cloud Backup. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Manager

Input Parameters

object
required
Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the desired snapshot.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_CLUSTER_COLL_STAT_PINNED_NAMESPACESAdd Pinned Namespaces. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster to pin namespaces to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_CLUSTER_ONLINE_ARCHIVEUpdate One Online Archive. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the online archive to update.
string
required
Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_CLUSTER_PROCESS_ARGSUpdate Advanced Configuration Options for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager.

Input Parameters

object
required
Documented request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_CLUSTER_QUERY_SHAPEUpdate Query Shape Rejection Status. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access Admin, Project Real Time Performance Operator

Input Parameters

object
required
Request body for modifying the rejection status of a query shape.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.
string
required
A SHA256 hash of a query shape, output by MongoDB commands like $queryStats and $explain or slow query logs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_CLUSTER_SEARCH_DEPLOYMENTUpdate Search Nodes. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the cluster to update the Search Nodes for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_CLUSTER_SEARCH_INDEXUpdate One Atlas Search Index by ID. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Search Index Editor

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the Get All Atlas Search Indexes for a Collection API endpoint to find the IDs of all Atlas Search indexes.
string
required
Name of the cluster that contains the collection whose Atlas Search index you want to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_CLUSTER_SEARCH_INDEX_BY_NAMEUpdate One Atlas Search Index by Name. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Search Index Editor

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Name of the Atlas Search index to update.
string
required
Name of the cluster that contains the collection whose Atlas Search index you want to update.
string
required
Label that identifies the database that contains the collection with one or more Atlas Search indexes.
string
required
Name of the collection that contains one or more Atlas Search indexes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_CLUSTER_SQL_INTERFACEUpdate SQL Interface Status. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager, Project Replica Set Manager.

Input Parameters

object
required
Documented request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the cluster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_CONTAINERUpdate One Network Peering Container. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

string
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_CUSTOM_DB_ROLE_ROLEUpdate One Custom Role in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Database Access Admin, Project Stream Processing Owner

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_DATABASE_USERUpdate one database user in an Atlas project, with role names in the required request body restricted to the listed built-in choices or the literal custom-role placeholder. Uses the MongoDB Atlas Administration API; required Atlas roles: Project Database Access Admin, Project Stream Processing Owner.

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsIAMType | ROLE | <abbr title=“Amazon Resource Name”>ARN</abbr> | | AWS IAM | awsIAMType | USER | <abbr title=“Amazon Resource Name”>ARN</abbr> | | x.509 | x509Type | CUSTOMER | RFC 2253 Distinguished Name | | x.509 | x509Type | MANAGED | RFC 2253 Distinguished Name | | LDAP | ldapAuthType | USER | RFC 2253 Distinguished Name | | LDAP | ldapAuthType | GROUP | RFC 2253 Distinguished Name | | OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a ’/’, followed by the IdP group name | | OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a ’/’, followed by the IdP user name | | SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |.
string
required
The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be $external. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be admin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_DATA_FEDERATIONUpdate One Federated Database Instance in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Human-readable label that identifies the federated database instance to update.
boolean
required
Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_ENCRYPTION_AT_RESTUpdate Encryption at Rest Configuration in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_FLEX_CLUSTERUpdate one flex cluster in one project using the MongoDB Atlas Administration API, requiring the Project Owner role. The request sends termination protection as disabled when omitted.

Input Parameters

object
required
Settings that you can specify when you update a flex cluster.
string
required
Human-readable label that identifies the flex cluster.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_INTEGRATIONUpdate One Third-Party Service Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

string
required
Collection of settings that describe third-party integrations.
string
Opaque continuation cursor from the preceding page; omit for the first page.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
boolean
Flag that indicates whether MongoDB Cloud calculates the total number of items for the response. When set to false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.
integer
Number of items that the response returns per page.
string ("PAGER_DUTY" | "SLACK" | "DATADOG" | "NEW_RELIC" | "OPS_GENIE" | "VICTOR_OPS" | "WEBHOOK" | "HIP_CHAT" | "PROMETHEUS" | "MICROSOFT_TEAMS")
required
Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_LOG_INTEGRATIONUpdate One Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

string
required
Unique identifier of the log integration configuration.
string
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_MAINTENANCE_WINDOWUpdate One Maintenance Window for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_MCP_CONFIGUpdate One MCP Configuration for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique identifier of the MCP configuration to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_METRIC_INTEGRATIONUpdate One Metric Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

object
required
Updated metric integration configuration.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique identifier of the metric integration configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_PEERUpdate One Network Peering Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Network Access Manager

Input Parameters

string
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_PRIVATE_ENDPOINT_ENDPOINT_SERVICEUpdate an AWS private endpoint service’s supported remote regions using the MongoDB Atlas Administration API. Required Atlas role: Project Owner.

Input Parameters

object
required
Updates to apply to the private endpoint service.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_SERVICE_ACCOUNTUpdate One Project Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.

Input Parameters

object
required
The new details for the Service Account.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
The Client ID of the Service Account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_SETTINGSUpdate Project Settings. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Owner.

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_STREAM_CONNECTIONUpdate One Stream Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

Input Parameters

string
required
Settings that define a connection to an external data store.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace.
string
required
Label that identifies the stream connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_STREAM_CONNECTION_FAILOVER_CONNECTIONUpdate One Stream Failover Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

Input Parameters

string
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace.
string
required
Label that identifies the stream connection.
string
required
Label that identifies the stream failover connection id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_STREAM_PROCESSORUpdate One Stream Processor. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager

Input Parameters

object
required
A request to modify an existing stream processor.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace.
string
required
Label that identifies the stream processor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_STREAM_WORKSPACEUpdate one stream workspace and optionally request a status change for its processors, including bulk regional failover, using the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Data Access Admin, Project Stream Processing Manager.

Input Parameters

object
required
Details to update a stream tenant, optionally accompanied by a processor status change (for example, triggering bulk regional failover).
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
string
required
Label that identifies the stream workspace to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_TEAMUpdate Team Roles in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access Manager

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the team for which you want to update roles.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_GROUP_USER_SECURITYUpdate LDAP or X.509 Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_ORGUpdate One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Details that describe the organization.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_ORG_API_KEYUpdate One Organization API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies this organization API key you want to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_ORG_DELEGATION_SETTINGSUpdate Delegation Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_ORG_LOG_INTEGRATIONUpdate One Organization Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique identifier of the log integration configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_ORG_MAINTENANCE_SETTINGSUpdate Maintenance Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_ORG_MCP_CONFIGUpdate One MCP Configuration for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique identifier of the MCP configuration to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_ORG_RESOURCE_POLICYUpdate One Atlas Resource Policy. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies an atlas resource policy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_ORG_SANDBOX_CONFIGUpdate an Existing Sandbox Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

Input Parameters

object
required
Settings to update the sandbox configuration for an organization.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies the sandbox configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_ORG_SERVICE_ACCOUNTUpdate One Organization Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.

Input Parameters

object
required
The new details for the Service Account.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
The Client ID of the Service Account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_ORG_SETTINGSUpdate settings for one organization using the MongoDB Atlas Administration API, with the Organization Owner role. Omitted generative AI settings are sent as enabled, and null settings are omitted from the request.

Input Parameters

object
required
Collection of settings that configures the organization.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPDATE_ORG_USERUpdate One MongoDB Cloud User in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
string
required
Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user’s userId or verify a user’s status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_UPGRADE_GROUP_CLUSTER_TENANT_UPGRADEUpgrade One Shared-Tier Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager.

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_VALIDATE_GROUP_LIVE_MIGRATIONSValidate One Migration Request. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_VALIDATE_ORG_RESOURCE_POLICIESValidate One Atlas Resource Policy. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner

Input Parameters

object
required
Operation-specific request body.
string
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_VERIFY_GROUP_USER_SECURITY_LDAPVerify LDAP Configuration in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner

Input Parameters

object
required
Request information needed to verify an Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration. The response does not return the bindPassword.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MONGODB_WITH_GROUP_STREAM_SAMPLE_CONNECTIONSCreate One Stream Workspace with Sample Connections. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Data Access Admin, Project Stream Processing Manager

Input Parameters

object
required
Operation-specific request body.
boolean
Flag that indicates whether the response body should be in the prettyprint format.
boolean
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
string
required
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not