- Category: databases
- Auth: S2S_OAUTH2
- Composio-managed OAuth available? No
- Tools: 496
- Triggers: 0
- Slug:
MONGODB - Version: 20261101_00
Tools
Accept Group Stream Vpc Peering Connection
Accept Group Stream Vpc Peering Connection
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Acknowledge Group Alert
Acknowledge Group Alert
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
acknowledgeUntil date and optional comment or unacknowledgeAlert boolean.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Add Group API Key
Add Group API Key
MONGODB_ADD_GROUP_API_KEYAssign One Organization API Key to One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Add Group Teams
Add Group Teams
MONGODB_ADD_GROUP_TEAMSAdd Multiple Teams to One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Add Group User Role
Add Group User Role
MONGODB_ADD_GROUP_USER_ROLEAdd One Project Role to One MongoDB Cloud User. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access ManagerInput Parameters
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.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Add Group Users
Add Group Users
MONGODB_ADD_GROUP_USERSAdd One MongoDB Cloud User to One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Add Org Team User
Add Org Team User
MONGODB_ADD_ORG_TEAM_USERAdd One MongoDB Cloud User to One Team. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Add Org User Role
Add Org User Role
MONGODB_ADD_ORG_USER_ROLEAdd One Organization Role to One MongoDB Cloud User. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.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.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Cancel Group Cluster Backup Restore Job
Cancel Group Cluster Backup Restore Job
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 OperatorInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Ephemeral Cluster
Create Ephemeral Cluster
Create Federation Setting Connected Org Config Role Mapping
Create Federation Setting Connected Org Config Role Mapping
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Federation Setting Identity Provider
Create Federation Setting Identity Provider
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group
Create Group
MONGODB_CREATE_GROUPCreate One Project. Uses the MongoDB Atlas Administration API.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Access List Entry
Create Group Access List Entry
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
Create Group Ai Model API Key
Create Group Ai Model API Key
MONGODB_CREATE_GROUP_AI_MODEL_API_KEYCreate New AI Model API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Model OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Alert Config
Create Group Alert Config
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group API Key
Create Group API Key
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Backup Export Bucket
Create Group Backup Export Bucket
MONGODB_CREATE_GROUP_BACKUP_EXPORT_BUCKETCreate One Snapshot Export Bucket. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Backup Private Endpoint
Create Group Backup Private Endpoint
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Cloud Provider Access
Create Group Cloud Provider Access
MONGODB_CREATE_GROUP_CLOUD_PROVIDER_ACCESSCreate One Cloud Provider Access Role. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Cluster
Create Group Cluster
MONGODB_CREATE_GROUP_CLUSTERCreate One Cluster in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Creator.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.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
Create Group Cluster Backup Export
Create Group Cluster Backup Export
MONGODB_CREATE_GROUP_CLUSTER_BACKUP_EXPORTCreate One Snapshot Export Job. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Export OperatorInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Cluster Backup Restore Job
Create Group Cluster Backup Restore Job
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 OperatorInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Cluster Collection Restore Job
Create Group Cluster Collection Restore Job
MONGODB_CREATE_GROUP_CLUSTER_COLLECTION_RESTORE_JOBCreate One Collection Restore Job. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup Recovery OperatorInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Cluster Global Write Custom Zone Mapping
Create Group Cluster Global Write Custom Zone Mapping
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Cluster Global Write Managed Namespace
Create Group Cluster Global Write Managed Namespace
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 AdminInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Cluster Index Rolling Index
Create Group Cluster Index Rolling Index
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Cluster Online Archive
Create Group Cluster Online Archive
MONGODB_CREATE_GROUP_CLUSTER_ONLINE_ARCHIVECreate One Online Archive. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access AdminInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Cluster Overload Simulation
Create Group Cluster Overload Simulation
MONGODB_CREATE_GROUP_CLUSTER_OVERLOAD_SIMULATIONCreate One Overload Protection Simulation. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Cluster Search Deployment
Create Group Cluster Search Deployment
MONGODB_CREATE_GROUP_CLUSTER_SEARCH_DEPLOYMENTCreate Search Nodes. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Cluster Search Index
Create Group Cluster Search Index
MONGODB_CREATE_GROUP_CLUSTER_SEARCH_INDEXCreate One Atlas Search Index. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Search Index EditorInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Container
Create Group Container
MONGODB_CREATE_GROUP_CONTAINERCreate One Network Peering Container. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Custom Db Role Role
Create Group Custom Db Role Role
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Database User
Create Group Database User
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Database User Cert
Create Group Database User Cert
MONGODB_CREATE_GROUP_DATABASE_USER_CERTCreate One X.509 Certificate for One Database User. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Data Federation
Create Group Data Federation
MONGODB_CREATE_GROUP_DATA_FEDERATIONCreate One Federated Database Instance in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Encryption At Rest Private Endpoint
Create Group Encryption At Rest Private Endpoint
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Flex Cluster
Create Group Flex Cluster
MONGODB_CREATE_GROUP_FLEX_CLUSTERCreate One Flex Cluster in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Flex Cluster Backup Restore Job
Create Group Flex Cluster Backup Restore Job
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 OperatorInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Integration
Create Group Integration
MONGODB_CREATE_GROUP_INTEGRATIONCreate One Third-Party Service Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
Create Group Live Migration
Create Group Live Migration
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Log Integration
Create Group Log Integration
MONGODB_CREATE_GROUP_LOG_INTEGRATIONCreate One Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group MCP Config
Create Group MCP Config
MONGODB_CREATE_GROUP_MCP_CONFIGCreate One MCP Configuration for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
Output
Create Group MCP Config Secret
Create Group MCP Config Secret
MONGODB_CREATE_GROUP_MCP_CONFIG_SECRETCreate One Secret for One Project MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
Output
Create Group Metric Integration
Create Group Metric Integration
MONGODB_CREATE_GROUP_METRIC_INTEGRATIONCreate One Metric Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Peer
Create Group Peer
MONGODB_CREATE_GROUP_PEERCreate One Network Peering Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Network Access ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Private Endpoint Endpoint Service
Create Group Private Endpoint Endpoint Service
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Private Endpoint Endpoint Service Endpoint
Create Group Private Endpoint Endpoint Service Endpoint
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Private Network Setting Endpoint Id
Create Group Private Network Setting Endpoint Id
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Service Account
Create Group Service Account
MONGODB_CREATE_GROUP_SERVICE_ACCOUNTCreate One Project Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Service Account Access List
Create Group Service Account Access List
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
Create Group Service Account Secret
Create Group Service Account Secret
MONGODB_CREATE_GROUP_SERVICE_ACCOUNT_SECRETCreate One Project Service Account Secret. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Standby Link
Create Group Standby Link
Create Group Standby Link Failover
Create Group Standby Link Failover
Create Group Stream Connection
Create Group Stream Connection
MONGODB_CREATE_GROUP_STREAM_CONNECTIONCreate One Stream Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Stream Connection Failover Connection
Create Group Stream Connection Failover Connection
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Stream Private Link Connection
Create Group Stream Private Link Connection
MONGODB_CREATE_GROUP_STREAM_PRIVATE_LINK_CONNECTIONCreate One Private Link Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Stream Processor
Create Group Stream Processor
MONGODB_CREATE_GROUP_STREAM_PROCESSORCreate One Stream Processor. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Streams Workspace Private Endpoint
Create Group Streams Workspace Private Endpoint
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Group Stream Workspace
Create Group Stream Workspace
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Org
Create Org
MONGODB_CREATE_ORGCreate One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: No specific Atlas role is documented.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Org API Key
Create Org API Key
MONGODB_CREATE_ORG_API_KEYCreate One Organization API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Org API Key Access List Entry
Create Org API Key Access List Entry
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
Create Org Billing Cost Explorer Usage Process
Create Org Billing Cost Explorer Usage Process
MONGODB_CREATE_ORG_BILLING_COST_EXPLORER_USAGE_PROCESSCreate One Cost Explorer Query Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing ViewerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Org Invoice Report
Create Org Invoice Report
MONGODB_CREATE_ORG_INVOICE_REPORTCreate One Invoice Report. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing ViewerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.Output
Create Org Live Migration Link Token
Create Org Live Migration Link Token
MONGODB_CREATE_ORG_LIVE_MIGRATION_LINK_TOKENCreate One Link-Token. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Org Log Integration
Create Org Log Integration
MONGODB_CREATE_ORG_LOG_INTEGRATIONCreate One Organization Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Org MCP Config
Create Org MCP Config
MONGODB_CREATE_ORG_MCP_CONFIGCreate One MCP Configuration for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.Output
Create Org MCP Config Secret
Create Org MCP Config Secret
MONGODB_CREATE_ORG_MCP_CONFIG_SECRETCreate One Secret for One Organization MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.Output
Create Org Resource Policy
Create Org Resource Policy
MONGODB_CREATE_ORG_RESOURCE_POLICYCreate One Atlas Resource Policy. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Org Sandbox Config
Create Org Sandbox Config
MONGODB_CREATE_ORG_SANDBOX_CONFIGCreate One Sandbox Configuration for an Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.Input Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Org Service Account
Create Org Service Account
MONGODB_CREATE_ORG_SERVICE_ACCOUNTCreate One Organization Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.Input Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Org Service Account Access List
Create Org Service Account Access List
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
Create Org Service Account Secret
Create Org Service Account Secret
MONGODB_CREATE_ORG_SERVICE_ACCOUNT_SECRETCreate One Organization Service Account Secret. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.Input Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Org Team
Create Org Team
MONGODB_CREATE_ORG_TEAMCreate One Team in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Create Org User
Create Org User
MONGODB_CREATE_ORG_USERAdd One MongoDB Cloud User to One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Cutover Group Live Migration
Cutover Group Live Migration
MONGODB_CUTOVER_GROUP_LIVE_MIGRATIONCut Over One Migrated Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Defer Group Maintenance Window
Defer Group Maintenance Window
MONGODB_DEFER_GROUP_MAINTENANCE_WINDOWDefer One Maintenance Window for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Federation Setting
Delete Federation Setting
Delete Federation Setting Connected Org Config Role Mapping
Delete Federation Setting Connected Org Config Role Mapping
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Federation Setting Identity Provider
Delete Federation Setting Identity Provider
MONGODB_DELETE_FEDERATION_SETTING_IDENTITY_PROVIDERDelete One Identity Provider. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group
Delete Group
MONGODB_DELETE_GROUPRemove One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Access List Entry
Delete Group Access List Entry
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body./) 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
Delete Group Ai Model API Key
Delete Group Ai Model API Key
MONGODB_DELETE_GROUP_AI_MODEL_API_KEYDelete Existing AI Model API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Model OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Alert Config
Delete Group Alert Config
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Backup Export Bucket
Delete Group Backup Export Bucket
MONGODB_DELETE_GROUP_BACKUP_EXPORT_BUCKETDelete One Snapshot Export Bucket. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Backup Private Endpoint
Delete Group Backup Private Endpoint
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Cluster
Delete Group Cluster
MONGODB_DELETE_GROUP_CLUSTERRemove One Cluster from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Cluster Backup Schedule
Delete Group Cluster Backup Schedule
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Cluster Backup Snapshot
Delete Group Cluster Backup Snapshot
MONGODB_DELETE_GROUP_CLUSTER_BACKUP_SNAPSHOTRemove One Replica Set Cloud Backup. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Cluster Backup Snapshot Sharded Cluster
Delete Group Cluster Backup Snapshot Sharded Cluster
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Cluster Global Write Custom Zone Mapping
Delete Group Cluster Global Write Custom Zone Mapping
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Cluster Global Write Managed Namespaces
Delete Group Cluster Global Write Managed Namespaces
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 AdminInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Cluster Online Archive
Delete Group Cluster Online Archive
MONGODB_DELETE_GROUP_CLUSTER_ONLINE_ARCHIVERemove One Online Archive. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access AdminInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Cluster Overload Simulation
Delete Group Cluster Overload Simulation
MONGODB_DELETE_GROUP_CLUSTER_OVERLOAD_SIMULATIONDelete One Overload Protection Simulation. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Cluster Private Endpoint Connection String
Delete Group Cluster Private Endpoint Connection String
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Cluster Search Deployment
Delete Group Cluster Search Deployment
MONGODB_DELETE_GROUP_CLUSTER_SEARCH_DEPLOYMENTDelete Search Nodes. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Cluster Search Index
Delete Group Cluster Search Index
MONGODB_DELETE_GROUP_CLUSTER_SEARCH_INDEXRemove One Atlas Search Index by ID. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Search Index EditorInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Cluster Search Index By Name
Delete Group Cluster Search Index By Name
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 EditorInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Container
Delete Group Container
MONGODB_DELETE_GROUP_CONTAINERRemove One Network Peering Container. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Custom Db Role Role
Delete Group Custom Db Role Role
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Database User
Delete Group Database User
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.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 |.$external. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be admin.Output
Delete Group Data Federation
Delete Group Data Federation
MONGODB_DELETE_GROUP_DATA_FEDERATIONRemove One Federated Database Instance from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Data Federation Limit
Delete Group Data Federation Limit
MONGODB_DELETE_GROUP_DATA_FEDERATION_LIMITDelete One Query Limit for One Federated Database Instance. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.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 |.Output
Delete Group Flex Cluster
Delete Group Flex Cluster
MONGODB_DELETE_GROUP_FLEX_CLUSTERRemove One Flex Cluster from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Integration
Delete Group Integration
MONGODB_DELETE_GROUP_INTEGRATIONRemove One Third-Party Service Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Limit
Delete Group Limit
MONGODB_DELETE_GROUP_LIMITRemove One Project Limit. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.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
Delete Group Log Integration
Delete Group Log Integration
MONGODB_DELETE_GROUP_LOG_INTEGRATIONRemove One Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group MCP Config
Delete Group MCP Config
MONGODB_DELETE_GROUP_MCP_CONFIGDelete One MCP Configuration for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
Output
Delete Group MCP Config Secret
Delete Group MCP Config Secret
MONGODB_DELETE_GROUP_MCP_CONFIG_SECRETDelete One Secret for One Project MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
Output
Delete Group Metric Integration
Delete Group Metric Integration
MONGODB_DELETE_GROUP_METRIC_INTEGRATIONRemove One Metric Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Peer
Delete Group Peer
MONGODB_DELETE_GROUP_PEERRemove One Network Peering Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Network Access ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Private Endpoint Endpoint Service
Delete Group Private Endpoint Endpoint Service
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Private Endpoint Endpoint Service Endpoint
Delete Group Private Endpoint Endpoint Service Endpoint
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.endpointId parameter differs for AWS and Azure. You must URL encode the endpointId for Azure private endpoints.Output
Delete Group Private Network Setting Endpoint Id
Delete Group Private Network Setting Endpoint Id
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Service Account
Delete Group Service Account
MONGODB_DELETE_GROUP_SERVICE_ACCOUNTRemove One Project Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Service Account Access List Entry
Delete Group Service Account Access List Entry
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Service Account Secret
Delete Group Service Account Secret
MONGODB_DELETE_GROUP_SERVICE_ACCOUNT_SECRETDelete One Project Service Account Secret. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Standby Link
Delete Group Standby Link
Delete Group Stream Connection
Delete Group Stream Connection
MONGODB_DELETE_GROUP_STREAM_CONNECTIONDelete One Stream Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Stream Connection Failover Connection
Delete Group Stream Connection Failover Connection
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Stream Private Link Connection
Delete Group Stream Private Link Connection
MONGODB_DELETE_GROUP_STREAM_PRIVATE_LINK_CONNECTIONDelete One Private Link Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Stream Processor
Delete Group Stream Processor
MONGODB_DELETE_GROUP_STREAM_PROCESSORDelete One Stream Processor. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Stream Vpc Peering Connection
Delete Group Stream Vpc Peering Connection
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group Stream Workspace
Delete Group Stream Workspace
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Group User Security LDAP User To Dn Mapping
Delete Group User Security LDAP User To Dn Mapping
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Org
Delete Org
MONGODB_DELETE_ORGRemove One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Org API Key
Delete Org API Key
MONGODB_DELETE_ORG_API_KEYRemove One Organization API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Org API Key Access List Entry
Delete Org API Key Access List Entry
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Org Live Migration Link Tokens
Delete Org Live Migration Link Tokens
MONGODB_DELETE_ORG_LIVE_MIGRATION_LINK_TOKENSRemove One Link-Token. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Org Log Integration
Delete Org Log Integration
MONGODB_DELETE_ORG_LOG_INTEGRATIONRemove One Organization Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Org MCP Config
Delete Org MCP Config
MONGODB_DELETE_ORG_MCP_CONFIGDelete One MCP Configuration for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.Output
Delete Org MCP Config Secret
Delete Org MCP Config Secret
MONGODB_DELETE_ORG_MCP_CONFIG_SECRETDelete One Secret for One Organization MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.Output
Delete Org Resource Policy
Delete Org Resource Policy
MONGODB_DELETE_ORG_RESOURCE_POLICYDelete One Atlas Resource Policy. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Org Sandbox Config
Delete Org Sandbox Config
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.Output
Delete Org Service Account
Delete Org Service Account
MONGODB_DELETE_ORG_SERVICE_ACCOUNTDelete One Organization Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.Input Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Org Service Account Access List Entry
Delete Org Service Account Access List Entry
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Org Service Account Secret
Delete Org Service Account Secret
MONGODB_DELETE_ORG_SERVICE_ACCOUNT_SECRETDelete One Organization Service Account Secret. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.Input Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Delete Org Team
Delete Org Team
MONGODB_DELETE_ORG_TEAMRemove One Team from One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Disable Group Backup Compliance Policy
Disable Group Backup Compliance Policy
MONGODB_DISABLE_GROUP_BACKUP_COMPLIANCE_POLICYDisable Backup Compliance Policy Settings. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Disable Group Managed Slow Ms
Disable Group Managed Slow Ms
MONGODB_DISABLE_GROUP_MANAGED_SLOW_MSDisable Managed Slow Operation Threshold. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Disable Group User Security Customer X.509
Disable Group User Security Customer X.509
MONGODB_DISABLE_GROUP_USER_SECURITY_CUSTOMER_X509Disable Customer-Managed X.509. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Download Group Cluster Log
Download Group Cluster Log
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Download Group Cluster Online Archive Query Logs
Download Group Cluster Online Archive Query Logs
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Download Group Data Federation Query Logs
Download Group Data Federation Query Logs
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 OwnerInput Parameters
Output
Download Group Flex Cluster Backup
Download Group Flex Cluster Backup
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Download Group Stream Audit Logs
Download Group Stream Audit Logs
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Download Group Stream Operational Logs
Download Group Stream Operational Logs
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Enable Group Managed Slow Ms
Enable Group Managed Slow Ms
MONGODB_ENABLE_GROUP_MANAGED_SLOW_MSEnable Managed Slow Operation Threshold. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
End Group Cluster Outage Simulation
End Group Cluster Outage Simulation
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Generate Group Sandbox Cluster Description
Generate Group Sandbox Cluster Description
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Generate Org Invoice And Download Report
Generate Org Invoice And Download Report
MONGODB_GENERATE_ORG_INVOICE_AND_DOWNLOAD_REPORTGenerate and Download Invoice Report. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing ViewerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.Output
Get Default Group Limit
Get Default Group Limit
MONGODB_GET_DEFAULT_GROUP_LIMITReturn One User-Configurable Project Limit and Description. Uses the MongoDB Atlas Administration API.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Ephemeral Cluster
Get Ephemeral Cluster
Get Federation Setting Connected Org Config
Get Federation Setting Connected Org Config
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Federation Setting Connected Org Config Role Mapping
Get Federation Setting Connected Org Config Role Mapping
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Federation Setting Identity Provider
Get Federation Setting Identity Provider
MONGODB_GET_FEDERATION_SETTING_IDENTITY_PROVIDERReturn One Identity Provider by ID. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Federation Setting Identity Provider Metadata
Get Federation Setting Identity Provider Metadata
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
Output
Get Group
Get Group
MONGODB_GET_GROUPReturn One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Access List Entry
Get Group Access List Entry
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body./) with its URL-encoded value (%2F).Output
Get Group Access List Status
Get Group Access List Status
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Activity Feed
Get Group Activity Feed
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
Output
Get Group Ai Model API Cloud Geography Model Group Name Rate Limits
Get Group Ai Model API Cloud Geography Model Group Name Rate Limits
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Ai Model API Key
Get Group Ai Model API Key
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Ai Model API Rate Limits
Get Group Ai Model API Rate Limits
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Alert
Get Group Alert
MONGODB_GET_GROUP_ALERTReturn One Alert from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Alert Alert Configs
Get Group Alert Alert Configs
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
Get Group Alert Config
Get Group Alert Config
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Alert Config Alerts
Get Group Alert Config Alerts
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
Get Group Audit Log
Get Group Audit Log
MONGODB_GET_GROUP_AUDIT_LOGReturn Auditing Configuration for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group AWS Custom DNS
Get Group AWS Custom DNS
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Backup Compliance Policy
Get Group Backup Compliance Policy
MONGODB_GET_GROUP_BACKUP_COMPLIANCE_POLICYReturn Backup Compliance Policy Settings. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Backup Export Bucket
Get Group Backup Export Bucket
MONGODB_GET_GROUP_BACKUP_EXPORT_BUCKETReturn One Snapshot Export Bucket. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Backup Private Endpoint
Get Group Backup Private Endpoint
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group By Name
Get Group By Name
MONGODB_GET_GROUP_BY_NAMEReturn One Project by Name. Uses the MongoDB Atlas Administration API.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cloud Provider Access
Get Group Cloud Provider Access
MONGODB_GET_GROUP_CLOUD_PROVIDER_ACCESSReturn One Cloud Provider Access Role. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read OnlyInput Parameters
roleId. Azure Service Principals return it as _id.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster
Get Group Cluster
MONGODB_GET_GROUP_CLUSTERReturn One Cluster from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.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
Get Group Cluster Adaptive Settings
Get Group Cluster Adaptive Settings
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Backup Export
Get Group Cluster Backup Export
MONGODB_GET_GROUP_CLUSTER_BACKUP_EXPORTReturn One Snapshot Export Job. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Backup Restore Job
Get Group Cluster Backup Restore Job
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Backup Schedule
Get Group Cluster Backup Schedule
MONGODB_GET_GROUP_CLUSTER_BACKUP_SCHEDULEReturn One Cloud Backup Schedule. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Backup Snapshot
Get Group Cluster Backup Snapshot
MONGODB_GET_GROUP_CLUSTER_BACKUP_SNAPSHOTReturn One Replica Set Cloud Backup. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Backup Snapshot Database
Get Group Cluster Backup Snapshot Database
MONGODB_GET_GROUP_CLUSTER_BACKUP_SNAPSHOT_DATABASEReturn One Database in One Snapshot. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Backup Snapshot Database Collection
Get Group Cluster Backup Snapshot Database Collection
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Backup Snapshot Sharded Cluster
Get Group Cluster Backup Snapshot Sharded Cluster
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Collection Restore Job
Get Group Cluster Collection Restore Job
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Collection Restore Job Collection
Get Group Cluster Collection Restore Job Collection
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Coll Stat Namespaces
Get Group Cluster Coll Stat Namespaces
MONGODB_GET_GROUP_CLUSTER_COLL_STAT_NAMESPACESReturn Ranked Namespaces from One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Global Writes
Get Group Cluster Global Writes
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Online Archive
Get Group Cluster Online Archive
MONGODB_GET_GROUP_CLUSTER_ONLINE_ARCHIVEReturn One Online Archive. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Outage Simulation
Get Group Cluster Outage Simulation
MONGODB_GET_GROUP_CLUSTER_OUTAGE_SIMULATIONReturn One Outage Simulation. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager, Project Cluster Resilience TesterInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Overload Simulation
Get Group Cluster Overload Simulation
MONGODB_GET_GROUP_CLUSTER_OVERLOAD_SIMULATIONReturn One Overload Protection Simulation. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Private Endpoint Connection String
Get Group Cluster Private Endpoint Connection String
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Process Args
Get Group Cluster Process Args
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Query Shape
Get Group Cluster Query Shape
MONGODB_GET_GROUP_CLUSTER_QUERY_SHAPEReturn One Query Shape. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.$queryStats and $explain or slow query logs.Output
Get Group Cluster Query Shape Insight Details
Get Group Cluster Query Shape Insight Details
MONGODB_GET_GROUP_CLUSTER_QUERY_SHAPE_INSIGHT_DETAILSReturn Query Shape Details. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.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.$queryStats and $explain or slow query logs.Output
Get Group Cluster Search Deployment
Get Group Cluster Search Deployment
MONGODB_GET_GROUP_CLUSTER_SEARCH_DEPLOYMENTReturn All Search Nodes. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Search Index
Get Group Cluster Search Index
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Search Index By Name
Get Group Cluster Search Index By Name
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster SQL Interface
Get Group Cluster SQL Interface
MONGODB_GET_GROUP_CLUSTER_SQL_INTERFACEReturn SQL Interface Status. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Cluster Status
Get Group Cluster Status
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Container
Get Group Container
MONGODB_GET_GROUP_CONTAINERReturn One Network Peering Container. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Custom Db Role Role
Get Group Custom Db Role Role
MONGODB_GET_GROUP_CUSTOM_DB_ROLE_ROLEReturn One Custom Role in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Database User
Get Group Database User
MONGODB_GET_GROUP_DATABASE_USERReturn One Database User from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.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 |.$external. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be admin.Output
Get Group Data Federation
Get Group Data Federation
MONGODB_GET_GROUP_DATA_FEDERATIONReturn One Federated Database Instance in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Data Federation Limit
Get Group Data Federation Limit
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.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 |.Output
Get Group Db Access History Cluster
Get Group Db Access History Cluster
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 AdminInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Db Access History Process
Get Group Db Access History Process
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 AdminInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Encryption At Rest
Get Group Encryption At Rest
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Encryption At Rest Private Endpoint
Get Group Encryption At Rest Private Endpoint
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Event
Get Group Event
MONGODB_GET_GROUP_EVENTReturn One Event from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Flex Cluster
Get Group Flex Cluster
MONGODB_GET_GROUP_FLEX_CLUSTERReturn One Flex Cluster from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Flex Cluster Backup Restore Job
Get Group Flex Cluster Backup Restore Job
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Flex Cluster Backup Snapshot
Get Group Flex Cluster Backup Snapshot
MONGODB_GET_GROUP_FLEX_CLUSTER_BACKUP_SNAPSHOTReturn One Snapshot for One Flex Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Host Fts Metric Index Measurements
Get Group Host Fts Metric Index Measurements
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Integration
Get Group Integration
MONGODB_GET_GROUP_INTEGRATIONReturn One Third-Party Service Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group IP Addresses
Get Group IP Addresses
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Limit
Get Group Limit
MONGODB_GET_GROUP_LIMITReturn One Limit for One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.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
Get Group Live Migration
Get Group Live Migration
MONGODB_GET_GROUP_LIVE_MIGRATIONReturn One Migration Job. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization MemberInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Live Migration Validate Status
Get Group Live Migration Validate Status
MONGODB_GET_GROUP_LIVE_MIGRATION_VALIDATE_STATUSReturn One Migration Validation Job. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Log Integration
Get Group Log Integration
MONGODB_GET_GROUP_LOG_INTEGRATIONReturn One Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Maintenance Window
Get Group Maintenance Window
MONGODB_GET_GROUP_MAINTENANCE_WINDOWReturn One Maintenance Window for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Managed Slow Ms
Get Group Managed Slow Ms
MONGODB_GET_GROUP_MANAGED_SLOW_MSReturn Managed Slow Operation Threshold Status. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group MCP Config
Get Group MCP Config
MONGODB_GET_GROUP_MCP_CONFIGReturn One MCP Configuration for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group MCP Config Secret
Get Group MCP Config Secret
MONGODB_GET_GROUP_MCP_CONFIG_SECRETReturn One Secret for One Project MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Metric Integration
Get Group Metric Integration
MONGODB_GET_GROUP_METRIC_INTEGRATIONReturn One Metric Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Mongo Db Versions
Get Group Mongo Db Versions
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Peer
Get Group Peer
MONGODB_GET_GROUP_PEERReturn One Network Peering Connection in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Private Endpoint Endpoint Service
Get Group Private Endpoint Endpoint Service
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Private Endpoint Endpoint Service Endpoint
Get Group Private Endpoint Endpoint Service Endpoint
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.endpointId parameter differs for AWS and Azure. You must URL encode the endpointId for Azure private endpoints.Output
Get Group Private Endpoint Regional Mode
Get Group Private Endpoint Regional Mode
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Private Network Setting Endpoint Id
Get Group Private Network Setting Endpoint Id
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Process
Get Group Process
MONGODB_GET_GROUP_PROCESSReturn One MongoDB Process by ID. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.Output
Get Group Process Coll Stat Namespaces
Get Group Process Coll Stat Namespaces
MONGODB_GET_GROUP_PROCESS_COLL_STAT_NAMESPACESReturn Ranked Namespaces from One Host. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Process Database
Get Group Process Database
MONGODB_GET_GROUP_PROCESS_DATABASEReturn One Database for One MongoDB Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.Output
Get Group Process Database Measurements
Get Group Process Database Measurements
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.Output
Get Group Process Disk
Get Group Process Disk
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.Output
Get Group Process Disk Measurements
Get Group Process Disk Measurements
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.Output
Get Group Process Measurements
Get Group Process Measurements
MONGODB_GET_GROUP_PROCESS_MEASUREMENTSReturn Measurements for One MongoDB Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.Output
Get Group Sample Dataset Load
Get Group Sample Dataset Load
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Service Account
Get Group Service Account
MONGODB_GET_GROUP_SERVICE_ACCOUNTReturn One Project Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read Only.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Settings
Get Group Settings
MONGODB_GET_GROUP_SETTINGSReturn Project Settings. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Standby Link
Get Group Standby Link
Get Group Standby Link Failover
Get Group Standby Link Failover
Get Group Stream Account Details
Get Group Stream Account Details
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Stream Connection
Get Group Stream Connection
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Stream Connection Failover Connection
Get Group Stream Connection Failover Connection
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Stream Private Link Connection
Get Group Stream Private Link Connection
MONGODB_GET_GROUP_STREAM_PRIVATE_LINK_CONNECTIONReturn One Private Link Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Stream Processor
Get Group Stream Processor
MONGODB_GET_GROUP_STREAM_PROCESSORReturn One Stream Processor. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Stream Processors
Get Group Stream Processors
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
Get Group Streams Workspace Private Endpoint
Get Group Streams Workspace Private Endpoint
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Stream Workspace
Get Group Stream Workspace
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group Team
Get Group Team
MONGODB_GET_GROUP_TEAMReturn One Team in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group User
Get Group User
MONGODB_GET_GROUP_USERReturn One MongoDB Cloud User in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
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.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.ACTIVE, PENDING, INVITATION_EXPIRED, INVITATION_REJECTED. If you exclude this parameter, this resource returns ACTIVE and PENDING users. Not supported in deprecated versions.Output
Get Group User Security
Get Group User Security
MONGODB_GET_GROUP_USER_SECURITYReturn LDAP or X.509 Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Group User Security LDAP Verify
Get Group User Security LDAP Verify
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org
Get Org
MONGODB_GET_ORGReturn One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization MemberInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org Activity Feed
Get Org Activity Feed
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.Output
Get Org Ai Model API Cloud Geography Model Group Name Rate Limits
Get Org Ai Model API Cloud Geography Model Group Name Rate Limits
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org Ai Model API Key
Get Org Ai Model API Key
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 OnlyInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org Ai Model API Rate Limits
Get Org Ai Model API Rate Limits
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org API Key
Get Org API Key
MONGODB_GET_ORG_API_KEYReturn One Organization API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization MemberInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org API Key Access List Entry
Get Org API Key Access List Entry
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 MemberInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org Associated Invoices
Get Org Associated Invoices
MONGODB_GET_ORG_ASSOCIATED_INVOICESReturn Associated Invoices. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing ViewerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.Output
Get Org Billing Cost Explorer Usage
Get Org Billing Cost Explorer Usage
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 ViewerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org Delegation Settings
Get Org Delegation Settings
MONGODB_GET_ORG_DELEGATION_SETTINGSReturn Delegation Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization MemberInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org Event
Get Org Event
MONGODB_GET_ORG_EVENTReturn One Event from One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member.Input Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org Federation Settings
Get Org Federation Settings
MONGODB_GET_ORG_FEDERATION_SETTINGSReturn Federation Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.Input Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org Groups
Get Org Groups
MONGODB_GET_ORG_GROUPSReturn a Page of Projects in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization MemberInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
Get Org Invoice
Get Org Invoice
MONGODB_GET_ORG_INVOICEReturn One Invoice for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing ViewerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org Invoice Csv
Get Org Invoice Csv
MONGODB_GET_ORG_INVOICE_CSVReturn One Invoice as CSV for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing ViewerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org Invoice Report
Get Org Invoice Report
MONGODB_GET_ORG_INVOICE_REPORTReturn One Invoice Report. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing ViewerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.Output
Get Org Log Integration
Get Org Log Integration
MONGODB_GET_ORG_LOG_INTEGRATIONReturn One Organization Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org Maintenance Settings
Get Org Maintenance Settings
MONGODB_GET_ORG_MAINTENANCE_SETTINGSReturn Maintenance Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization MemberInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org MCP Config
Get Org MCP Config
MONGODB_GET_ORG_MCP_CONFIGReturn One MCP Configuration for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read OnlyInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org MCP Config Secret
Get Org MCP Config Secret
MONGODB_GET_ORG_MCP_CONFIG_SECRETReturn One Secret for One Organization MCP Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read OnlyInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org Non Compliant Resources
Get Org Non Compliant Resources
MONGODB_GET_ORG_NON_COMPLIANT_RESOURCESReturn All Non-Compliant Resources. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization MemberInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org Resource Policy
Get Org Resource Policy
MONGODB_GET_ORG_RESOURCE_POLICYReturn One Atlas Resource Policy. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization MemberInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org Sandbox Config
Get Org Sandbox Config
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org Service Account
Get Org Service Account
MONGODB_GET_ORG_SERVICE_ACCOUNTReturn One Organization Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read Only.Input Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org Service Account Groups
Get Org Service Account Groups
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org Settings
Get Org Settings
MONGODB_GET_ORG_SETTINGSReturn Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization MemberInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org Team
Get Org Team
MONGODB_GET_ORG_TEAMReturn One Team by ID. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization MemberInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org Team By Name
Get Org Team By Name
MONGODB_GET_ORG_TEAM_BY_NAMEReturn One Team by Name. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization MemberInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Org User
Get Org User
MONGODB_GET_ORG_USERReturn One MongoDB Cloud User in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization MemberInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.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.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.ACTIVE, PENDING, INVITATION_EXPIRED, INVITATION_REJECTED. If you exclude this parameter, this resource returns ACTIVE and PENDING users. Not supported in deprecated versions.Output
Get Rate Limit
Get Rate Limit
MONGODB_GET_RATE_LIMITReturn One Rate Limit. Uses the MongoDB Atlas Administration API. Required Atlas roles: No specific Atlas role is documented.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get Sku
Get Sku
MONGODB_GET_SKUReturn One Stock Keeping Unit. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member, Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Get System Status
Get System Status
MONGODB_GET_SYSTEM_STATUSReturn the Status of This MongoDB Application. Uses the MongoDB Atlas Administration API.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Grant Group Cluster Mongo Db Employee Access
Grant Group Cluster Mongo Db Employee Access
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Inspect Group Standby Link Failover Readiness
Inspect Group Standby Link Failover Readiness
Invite Group Service Account
Invite Group Service Account
MONGODB_INVITE_GROUP_SERVICE_ACCOUNTAssign One Service Account to One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Alert Config Matcher Field Names
List Alert Config Matcher Field Names
MONGODB_LIST_ALERT_CONFIG_MATCHER_FIELD_NAMESReturn All Alert Configuration Matchers Field Names. Uses the MongoDB Atlas Administration API.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Cluster Details
List Cluster Details
MONGODB_LIST_CLUSTER_DETAILSReturn a Page of Authorized Clusters in All Projects. Uses the MongoDB Atlas Administration API.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Control Plane IP Addresses
List Control Plane IP Addresses
MONGODB_LIST_CONTROL_PLANE_IP_ADDRESSESReturn All Control Plane IP Addresses. Uses the MongoDB Atlas Administration API.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Default Group Limits
List Default Group Limits
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Event Types
List Event Types
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Federation Setting Connected Org Config Role Mappings
List Federation Setting Connected Org Config Role Mappings
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Federation Setting Connected Org Configs
List Federation Setting Connected Org Configs
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Federation Setting Identity Providers
List Federation Setting Identity Providers
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Access List Entries
List Group Access List Entries
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Ai Model API Keys
List Group Ai Model API Keys
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Alert Configs
List Group Alert Configs
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Alerts
List Group Alerts
MONGODB_LIST_GROUP_ALERTSReturn a Page of Alerts from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group API Keys
List Group API Keys
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Backup Export Buckets
List Group Backup Export Buckets
MONGODB_LIST_GROUP_BACKUP_EXPORT_BUCKETSReturn a Page of Snapshot Export Buckets. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Backup Private Endpoints
List Group Backup Private Endpoints
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Cloud Provider Access
List Group Cloud Provider Access
MONGODB_LIST_GROUP_CLOUD_PROVIDER_ACCESSReturn All Cloud Provider Access Roles. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Cluster Backup Exports
List Group Cluster Backup Exports
MONGODB_LIST_GROUP_CLUSTER_BACKUP_EXPORTSReturn a Page of Snapshot Export Jobs. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Cluster Backup Restore Jobs
List Group Cluster Backup Restore Jobs
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Cluster Backup Snapshot Database Collections
List Group Cluster Backup Snapshot Database Collections
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Cluster Backup Snapshot Databases
List Group Cluster Backup Snapshot Databases
MONGODB_LIST_GROUP_CLUSTER_BACKUP_SNAPSHOT_DATABASESReturn Databases in One Snapshot. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Cluster Backup Snapshots
List Group Cluster Backup Snapshots
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.oplogInc. Mutually exclusive with pointInTimeUtcSeconds.oplogTs. Mutually exclusive with pointInTimeUtcSeconds.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.oplogTs and oplogInc.Output
List Group Cluster Backup Snapshot Sharded Clusters
List Group Cluster Backup Snapshot Sharded Clusters
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Cluster Collection Restore Job Collections
List Group Cluster Collection Restore Job Collections
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Cluster Collection Restore Jobs
List Group Cluster Collection Restore Jobs
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Cluster Coll Stat Measurements
List Group Cluster Coll Stat Measurements
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Cluster Coll Stat Pinned Namespaces
List Group Cluster Coll Stat Pinned Namespaces
MONGODB_LIST_GROUP_CLUSTER_COLL_STAT_PINNED_NAMESPACESReturn Pinned Namespaces. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Cluster Online Archives
List Group Cluster Online Archives
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Cluster Overload Simulations
List Group Cluster Overload Simulations
MONGODB_LIST_GROUP_CLUSTER_OVERLOAD_SIMULATIONSReturn a Page of Overload Protection Simulations. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Cluster Performance Advisor Drop Index Suggestions
List Group Cluster Performance Advisor Drop Index Suggestions
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Cluster Performance Advisor Schema Advice
List Group Cluster Performance Advisor Schema Advice
MONGODB_LIST_GROUP_CLUSTER_PERFORMANCE_ADVISOR_SCHEMA_ADVICEReturn Schema Advice. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Cluster Performance Advisor Suggested Indexes
List Group Cluster Performance Advisor Suggested Indexes
MONGODB_LIST_GROUP_CLUSTER_PERFORMANCE_ADVISOR_SUGGESTED_INDEXESReturn All Suggested Indexes. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body..: <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.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.Output
List Group Cluster Private Endpoint Connection Strings
List Group Cluster Private Endpoint Connection Strings
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Cluster Provider Regions
List Group Cluster Provider Regions
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Cluster Query Shape Insight Summaries
List Group Cluster Query Shape Insight Summaries
MONGODB_LIST_GROUP_CLUSTER_QUERY_SHAPE_INSIGHT_SUMMARIESReturn Query Statistic Summaries. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
&) 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.&) 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.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body..: <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.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.$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
List Group Cluster Query Shapes
List Group Cluster Query Shapes
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Clusters
List Group Clusters
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Cluster Search Index
List Group Cluster Search Index
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Cluster Search Indexes
List Group Cluster Search Indexes
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Coll Stat Metrics
List Group Coll Stat Metrics
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Container All
List Group Container All
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Containers
List Group Containers
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Custom Db Role Roles
List Group Custom Db Role Roles
MONGODB_LIST_GROUP_CUSTOM_DB_ROLE_ROLESReturn All Custom Roles in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Database User Certs
List Group Database User Certs
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Database Users
List Group Database Users
MONGODB_LIST_GROUP_DATABASE_USERSReturn a Page of Database Users in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Data Federation
List Group Data Federation
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Data Federation Limits
List Group Data Federation Limits
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Encryption At Rest Private Endpoints
List Group Encryption At Rest Private Endpoints
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Events
List Group Events
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.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
List Group Flex Cluster Backup Restore Jobs
List Group Flex Cluster Backup Restore Jobs
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Flex Cluster Backup Snapshots
List Group Flex Cluster Backup Snapshots
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Flex Clusters
List Group Flex Clusters
MONGODB_LIST_GROUP_FLEX_CLUSTERSReturn a Page of Flex Clusters from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Host Fts Metric Index Measurements
List Group Host Fts Metric Index Measurements
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Host Fts Metric Measurements
List Group Host Fts Metric Measurements
MONGODB_LIST_GROUP_HOST_FTS_METRIC_MEASUREMENTSReturn Atlas Search Hardware and Status Metrics. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Host Fts Metrics
List Group Host Fts Metrics
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Integrations
List Group Integrations
MONGODB_LIST_GROUP_INTEGRATIONSReturn a Page of Active Third-Party Service Integrations. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Limits
List Group Limits
MONGODB_LIST_GROUP_LIMITSReturn All Limits for One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Read Only.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Log Integrations
List Group Log Integrations
MONGODB_LIST_GROUP_LOG_INTEGRATIONSReturn a Page of Active Log Integrations. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group MCP Configs
List Group MCP Configs
MONGODB_LIST_GROUP_MCP_CONFIGSReturn a Page of MCP Configurations for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group MCP Config Secrets
List Group MCP Config Secrets
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Metric Integrations
List Group Metric Integrations
MONGODB_LIST_GROUP_METRIC_INTEGRATIONSReturn a Page of Active Metric Integrations. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.CUSTOM). When specified, integrationType must also be specified.Output
List Group Peers
List Group Peers
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Private Endpoint Endpoint Service
List Group Private Endpoint Endpoint Service
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Private Network Setting Endpoint Ids
List Group Private Network Setting Endpoint Ids
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Process Coll Stat Measurements
List Group Process Coll Stat Measurements
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Process Databases
List Group Process Databases
MONGODB_LIST_GROUP_PROCESS_DATABASESReturn Available Databases for One MongoDB Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.mongod). The port must be the IANA port on which the MongoDB process listens for requests.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Process Disks
List Group Process Disks
MONGODB_LIST_GROUP_PROCESS_DISKSReturn Available Disks for One MongoDB Process. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Processes
List Group Processes
MONGODB_LIST_GROUP_PROCESSESReturn a Page of MongoDB Processes in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Process Performance Advisor Namespaces
List Group Process Performance Advisor Namespaces
MONGODB_LIST_GROUP_PROCESS_PERFORMANCE_ADVISOR_NAMESPACESReturn All Namespaces for One Host. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.Output
List Group Process Performance Advisor Slow Query Logs
List Group Process Performance Advisor Slow Query Logs
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body..: <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.mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.Output
List Group Process Performance Advisor Suggested Indexes
List Group Process Performance Advisor Suggested Indexes
MONGODB_LIST_GROUP_PROCESS_PERFORMANCE_ADVISOR_SUGGESTED_INDEXESReturn a Page of Suggested Indexes. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body..: <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.mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Groups
List Groups
MONGODB_LIST_GROUPSReturn a Page of Projects. Uses the MongoDB Atlas Administration API.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Service Account Access List
List Group Service Account Access List
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Service Accounts
List Group Service Accounts
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Standby Link Failovers
List Group Standby Link Failovers
MONGODB_LIST_GROUP_STANDBY_LINK_FAILOVERSReturn a Page of Standby Link Failovers. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Standby Links
List Group Standby Links
MONGODB_LIST_GROUP_STANDBY_LINKSReturn a Page of Standby Links for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Stream Active Vpc Peering Connections
List Group Stream Active Vpc Peering Connections
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 OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Stream Connection Failover Connections
List Group Stream Connection Failover Connections
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Stream Connections
List Group Stream Connections
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Stream Private Link Connections
List Group Stream Private Link Connections
MONGODB_LIST_GROUP_STREAM_PRIVATE_LINK_CONNECTIONSReturn a Page of Private Link Connections. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Streams Workspace Private Endpoints
List Group Streams Workspace Private Endpoints
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Stream Vpc Peering Connections
List Group Stream Vpc Peering Connections
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Stream Workspaces
List Group Stream Workspaces
MONGODB_LIST_GROUP_STREAM_WORKSPACESReturn a Page of Stream Workspaces in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Group Teams
List Group Teams
MONGODB_LIST_GROUP_TEAMSReturn a Page of Teams in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Group Users
List Group Users
MONGODB_LIST_GROUP_USERSReturn a Page of MongoDB Cloud Users in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body."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.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation."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.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.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
List Org Ai Model API Keys
List Org Ai Model API Keys
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Org API Key Access List Entries
List Org API Key Access List Entries
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 MemberInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Org API Keys
List Org API Keys
MONGODB_LIST_ORG_API_KEYSReturn a Page of Organization API Keys. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization MemberInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Org Events
List Org Events
MONGODB_LIST_ORG_EVENTSReturn a page of events from one organization using the MongoDB Atlas Administration API. Required Atlas role: Organization Member.Input Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Org Invoice Pending
List Org Invoice Pending
MONGODB_LIST_ORG_INVOICE_PENDINGReturn All Pending Invoices for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing ViewerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Org Invoice Reports
List Org Invoice Reports
MONGODB_LIST_ORG_INVOICE_REPORTSReturn a Page of Invoice Reports for One Invoice. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing ViewerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Org Invoices
List Org Invoices
MONGODB_LIST_ORG_INVOICESReturn a Page of Invoices for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Billing ViewerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.orderBy parameter to control the order of the result.endDates of which are smaller than or equal to the toDate. If omit, the invoices return will go further to latest endDate.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.sortBy parameter to control the order of the result.startDates of which are greater than or equal to the fromDate. If omit, the invoices return will go back to earliest startDate.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Org Live Migration Available Projects
List Org Live Migration Available Projects
MONGODB_LIST_ORG_LIVE_MIGRATION_AVAILABLE_PROJECTSReturn All Projects Available for Migration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Org Log Integrations
List Org Log Integrations
MONGODB_LIST_ORG_LOG_INTEGRATIONSReturn a Page of Organization Log Integrations. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Org MCP Configs
List Org MCP Configs
MONGODB_LIST_ORG_MCP_CONFIGSReturn a Page of MCP Configurations for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Read OnlyInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Org MCP Config Secrets
List Org MCP Config Secrets
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 OnlyInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Org Resource Policies
List Org Resource Policies
MONGODB_LIST_ORG_RESOURCE_POLICIESReturn All Atlas Resource Policies. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization MemberInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Orgs
List Orgs
MONGODB_LIST_ORGSReturn a Page of Organizations. Uses the MongoDB Atlas Administration API. Required Atlas roles: No specific Atlas role is documented.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Org Sandbox Config
List Org Sandbox Config
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Org Service Account Access List
List Org Service Account Access List
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Org Service Accounts
List Org Service Accounts
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
List Org Teams
List Org Teams
MONGODB_LIST_ORG_TEAMSReturn a Page of Teams in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization MemberInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
List Org Team Users
List Org Team Users
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 MemberInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.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.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
List Org Users
List Org Users
MONGODB_LIST_ORG_USERSReturn a Page of MongoDB Cloud Users in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization MemberInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.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.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
List Rate Limits
List Rate Limits
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
/rateLimits?name=Name1&name=Name2. For names that use spaces, replace the space with its URL-encoded value (%20).envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body./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).Output
List Skus
List Skus
MONGODB_LIST_SKUSReturn a Page of Stock Keeping Units. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Member, Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
Migrate Group
Migrate Group
MONGODB_MIGRATE_GROUPMigrate One Project to Another Organization. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Pin Group Cluster Coll Stat Pinned Namespaces
Pin Group Cluster Coll Stat Pinned Namespaces
MONGODB_PIN_GROUP_CLUSTER_COLL_STAT_PINNED_NAMESPACESPin Namespaces. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Pin Group Cluster Feature Compatibility Version
Pin Group Cluster Feature Compatibility Version
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Reject Group Stream Vpc Peering Connection
Reject Group Stream Vpc Peering Connection
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Remove Federation Setting Connected Org Config
Remove Federation Setting Connected Org Config
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Remove Group API Key
Remove Group API Key
MONGODB_REMOVE_GROUP_API_KEYUnassign One Organization API Key from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Remove Group Team
Remove Group Team
MONGODB_REMOVE_GROUP_TEAMRemove One Team from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Remove Group User
Remove Group User
MONGODB_REMOVE_GROUP_USERRemove One MongoDB Cloud User from One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access ManagerInput Parameters
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.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Remove Group User Role
Remove Group User Role
MONGODB_REMOVE_GROUP_USER_ROLERemove One Project Role from One MongoDB Cloud User. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access ManagerInput Parameters
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.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Remove Org Team User
Remove Org Team User
MONGODB_REMOVE_ORG_TEAM_USERRemove One MongoDB Cloud User from One Team. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Remove Org User
Remove Org User
MONGODB_REMOVE_ORG_USERRemove One MongoDB Cloud User from One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.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.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Remove Org User Role
Remove Org User Role
MONGODB_REMOVE_ORG_USER_ROLERemove One Organization Role from One MongoDB Cloud User. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.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.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Rename Org Team
Rename Org Team
MONGODB_RENAME_ORG_TEAMRename One Team. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Request Group Encryption At Rest Private Endpoint Deletion
Request Group Encryption At Rest Private Endpoint Deletion
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Request Group Sample Dataset Load
Request Group Sample Dataset Load
MONGODB_REQUEST_GROUP_SAMPLE_DATASET_LOADLoad Sample Dataset into One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Reset Group Ai Model API Cloud Geography Model Group Name Rate Limits
Reset Group Ai Model API Cloud Geography Model Group Name Rate Limits
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Reset Group Ai Model API Rate Limits
Reset Group Ai Model API Rate Limits
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Reset Group Maintenance Window
Reset Group Maintenance Window
MONGODB_RESET_GROUP_MAINTENANCE_WINDOWReset One Maintenance Window for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Reset Org Maintenance Settings
Reset Org Maintenance Settings
MONGODB_RESET_ORG_MAINTENANCE_SETTINGSReset Maintenance Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Restart Group Cluster Primaries
Restart Group Cluster Primaries
MONGODB_RESTART_GROUP_CLUSTER_PRIMARIESTest Failover for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Revoke Federation Setting Identity Provider Jwks
Revoke Federation Setting Identity Provider Jwks
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Revoke Group Cluster Mongo Db Employee Access
Revoke Group Cluster Mongo Db Employee Access
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Search Org Invoice Line Items
Search Org Invoice Line Items
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 ViewerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Set Group Data Federation Limit
Set Group Data Federation Limit
MONGODB_SET_GROUP_DATA_FEDERATION_LIMITConfigure One Query Limit for One Federated Database Instance. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.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 |.Output
Set Group Limit
Set Group Limit
MONGODB_SET_GROUP_LIMITSet One Project Limit. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.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
Start Group Cluster Outage Simulation
Start Group Cluster Outage Simulation
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Start Group Stream Processor
Start Group Stream Processor
MONGODB_START_GROUP_STREAM_PROCESSORStart One Stream Processor. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Start Group Stream Processor With
Start Group Stream Processor With
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Stop Group Stream Processor
Stop Group Stream Processor
MONGODB_STOP_GROUP_STREAM_PROCESSORStop One Stream Processor. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Managerenvelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.Take Group Cluster Backup Snapshots
Take Group Cluster Backup Snapshots
MONGODB_TAKE_GROUP_CLUSTER_BACKUP_SNAPSHOTSTake One On-Demand Snapshot. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup CreatorInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Tenant Group Flex Cluster Upgrade
Tenant Group Flex Cluster Upgrade
MONGODB_TENANT_GROUP_FLEX_CLUSTER_UPGRADEUpgrade One Flex Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Toggle Group Alert Config
Toggle Group Alert Config
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Toggle Group AWS Custom DNS
Toggle Group AWS Custom DNS
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Toggle Group Maintenance Window Auto Defer
Toggle Group Maintenance Window Auto Defer
MONGODB_TOGGLE_GROUP_MAINTENANCE_WINDOW_AUTO_DEFERToggle Automatic Deferral of Maintenance for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Toggle Group Private Endpoint Regional Mode
Toggle Group Private Endpoint Regional Mode
MONGODB_TOGGLE_GROUP_PRIVATE_ENDPOINT_REGIONAL_MODEToggle Regionalized Private Endpoint Status. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Unpin Group Cluster Coll Stat Unpin Namespaces
Unpin Group Cluster Coll Stat Unpin Namespaces
MONGODB_UNPIN_GROUP_CLUSTER_COLL_STAT_UNPIN_NAMESPACESUnpin Namespaces. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Unpin Group Cluster Feature Compatibility Version
Unpin Group Cluster Feature Compatibility Version
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Federation Setting Connected Org Config
Update Federation Setting Connected Org Config
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Federation Setting Connected Org Config Role Mapping
Update Federation Setting Connected Org Config Role Mapping
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Federation Setting Identity Provider
Update Federation Setting Identity Provider
MONGODB_UPDATE_FEDERATION_SETTING_IDENTITY_PROVIDERUpdate One Identity Provider. Uses the MongoDB Atlas Administration API. Required Atlas role: Organization Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group
Update Group
MONGODB_UPDATE_GROUPUpdate One Project. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Ai Model API Cloud Geography Model Group Name Rate Limits
Update Group Ai Model API Cloud Geography Model Group Name Rate Limits
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Ai Model API Key
Update Group Ai Model API Key
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Alert Config
Update Group Alert Config
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group API Key Roles
Update Group API Key Roles
MONGODB_UPDATE_GROUP_API_KEY_ROLESUpdate Organization API Key Roles for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
Update Group Audit Log
Update Group Audit Log
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Backup Compliance Policy
Update Group Backup Compliance Policy
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Backup Export Bucket
Update Group Backup Export Bucket
MONGODB_UPDATE_GROUP_BACKUP_EXPORT_BUCKETUpdate One Export Bucket Private Networking Settings. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Cluster
Update Group Cluster
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.replicationSpecs changes during updates. To intentionally override the replicationSpecs, disable this header.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
Update Group Cluster Adaptive Settings
Update Group Cluster Adaptive Settings
MONGODB_UPDATE_GROUP_CLUSTER_ADAPTIVE_SETTINGSUpdate Adaptive Settings for One Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Cluster Backup Schedule
Update Group Cluster Backup Schedule
MONGODB_UPDATE_GROUP_CLUSTER_BACKUP_SCHEDULEUpdate Cloud Backup Schedule for One Cluster. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Cluster Backup Snapshot
Update Group Cluster Backup Snapshot
MONGODB_UPDATE_GROUP_CLUSTER_BACKUP_SNAPSHOTUpdate Expiration Date for One Cloud Backup. Uses the MongoDB Atlas Administration API.; required Atlas role(s): Project Backup ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Cluster Coll Stat Pinned Namespaces
Update Group Cluster Coll Stat Pinned Namespaces
MONGODB_UPDATE_GROUP_CLUSTER_COLL_STAT_PINNED_NAMESPACESAdd Pinned Namespaces. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Read OnlyInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Cluster Online Archive
Update Group Cluster Online Archive
MONGODB_UPDATE_GROUP_CLUSTER_ONLINE_ARCHIVEUpdate One Online Archive. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Data Access AdminInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Cluster Process Args
Update Group Cluster Process Args
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Cluster Query Shape
Update Group Cluster Query Shape
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 OperatorInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.$queryStats and $explain or slow query logs.Output
Update Group Cluster Search Deployment
Update Group Cluster Search Deployment
MONGODB_UPDATE_GROUP_CLUSTER_SEARCH_DEPLOYMENTUpdate Search Nodes. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Cluster Search Index
Update Group Cluster Search Index
MONGODB_UPDATE_GROUP_CLUSTER_SEARCH_INDEXUpdate One Atlas Search Index by ID. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Search Index EditorInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Cluster Search Index By Name
Update Group Cluster Search Index By Name
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 EditorInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Cluster SQL Interface
Update Group Cluster SQL Interface
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Container
Update Group Container
MONGODB_UPDATE_GROUP_CONTAINERUpdate One Network Peering Container. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Custom Db Role Role
Update Group Custom Db Role Role
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 OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Database User
Update Group Database User
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.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 |.$external. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be admin.Output
Update Group Data Federation
Update Group Data Federation
MONGODB_UPDATE_GROUP_DATA_FEDERATIONUpdate One Federated Database Instance in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Encryption At Rest
Update Group Encryption At Rest
MONGODB_UPDATE_GROUP_ENCRYPTION_AT_RESTUpdate Encryption at Rest Configuration in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Flex Cluster
Update Group Flex Cluster
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Integration
Update Group Integration
MONGODB_UPDATE_GROUP_INTEGRATIONUpdate One Third-Party Service Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.false, MongoDB Cloud may skip an additional count operation. The response may still include totalCount when the count is available without additional calculation.Output
Update Group Log Integration
Update Group Log Integration
MONGODB_UPDATE_GROUP_LOG_INTEGRATIONUpdate One Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Maintenance Window
Update Group Maintenance Window
MONGODB_UPDATE_GROUP_MAINTENANCE_WINDOWUpdate One Maintenance Window for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group MCP Config
Update Group MCP Config
MONGODB_UPDATE_GROUP_MCP_CONFIGUpdate One MCP Configuration for One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
Output
Update Group Metric Integration
Update Group Metric Integration
MONGODB_UPDATE_GROUP_METRIC_INTEGRATIONUpdate One Metric Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Peer
Update Group Peer
MONGODB_UPDATE_GROUP_PEERUpdate One Network Peering Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Network Access ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Private Endpoint Endpoint Service
Update Group Private Endpoint Endpoint Service
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Service Account
Update Group Service Account
MONGODB_UPDATE_GROUP_SERVICE_ACCOUNTUpdate One Project Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Settings
Update Group Settings
MONGODB_UPDATE_GROUP_SETTINGSUpdate Project Settings. Uses the MongoDB Atlas Administration API. Required Atlas role: Project Owner.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Stream Connection
Update Group Stream Connection
MONGODB_UPDATE_GROUP_STREAM_CONNECTIONUpdate One Stream Connection. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Stream Connection Failover Connection
Update Group Stream Connection Failover Connection
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Stream Private Link Connection
Update Group Stream Private Link Connection
MONGODB_UPDATE_GROUP_STREAM_PRIVATE_LINK_CONNECTIONUpdate the DNS domain of a stream Private Link connection using the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing Manager.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Stream Processor
Update Group Stream Processor
MONGODB_UPDATE_GROUP_STREAM_PROCESSORUpdate One Stream Processor. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Stream Processing Admin, Project Stream Processing ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Stream Workspace
Update Group Stream Workspace
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
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group Team
Update Group Team
MONGODB_UPDATE_GROUP_TEAMUpdate Team Roles in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Access ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Group User Security
Update Group User Security
MONGODB_UPDATE_GROUP_USER_SECURITYUpdate LDAP or X.509 Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Org
Update Org
MONGODB_UPDATE_ORGUpdate One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Org API Key
Update Org API Key
MONGODB_UPDATE_ORG_API_KEYUpdate One Organization API Key. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Org Delegation Settings
Update Org Delegation Settings
MONGODB_UPDATE_ORG_DELEGATION_SETTINGSUpdate Delegation Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Org Log Integration
Update Org Log Integration
MONGODB_UPDATE_ORG_LOG_INTEGRATIONUpdate One Organization Log Integration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Org Maintenance Settings
Update Org Maintenance Settings
MONGODB_UPDATE_ORG_MAINTENANCE_SETTINGSUpdate Maintenance Settings for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Org MCP Config
Update Org MCP Config
MONGODB_UPDATE_ORG_MCP_CONFIGUpdate One MCP Configuration for One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.Output
Update Org Resource Policy
Update Org Resource Policy
MONGODB_UPDATE_ORG_RESOURCE_POLICYUpdate One Atlas Resource Policy. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Org Sandbox Config
Update Org Sandbox Config
MONGODB_UPDATE_ORG_SANDBOX_CONFIGUpdate an Existing Sandbox Configuration. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.Input Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Org Service Account
Update Org Service Account
MONGODB_UPDATE_ORG_SERVICE_ACCOUNTUpdate One Organization Service Account. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization Owner.Input Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Org Settings
Update Org Settings
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
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Update Org User
Update Org User
MONGODB_UPDATE_ORG_USERUpdate One MongoDB Cloud User in One Organization. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.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.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Upgrade Group Cluster Tenant Upgrade
Upgrade Group Cluster Tenant Upgrade
MONGODB_UPGRADE_GROUP_CLUSTER_TENANT_UPGRADEUpgrade One Shared-Tier Cluster. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project Cluster Manager.Input Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Validate Group Live Migrations
Validate Group Live Migrations
MONGODB_VALIDATE_GROUP_LIVE_MIGRATIONSValidate One Migration Request. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Validate Org Resource Policies
Validate Org Resource Policies
MONGODB_VALIDATE_ORG_RESOURCE_POLICIESValidate One Atlas Resource Policy. Uses the MongoDB Atlas Administration API. Required Atlas roles: Organization OwnerInput Parameters
/orgs endpoint to retrieve all organizations to which the authenticated user has access.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
Verify Group User Security LDAP
Verify Group User Security LDAP
MONGODB_VERIFY_GROUP_USER_SECURITY_LDAPVerify LDAP Configuration in One Project. Uses the MongoDB Atlas Administration API. Required Atlas roles: Project OwnerInput Parameters
bindPassword.envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the 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
With Group Stream Sample Connections
With Group Stream Sample Connections
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 ManagerInput Parameters
envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.