mongodb
MongoDB Atlas Admin API
API documentation clarifications for user management endpoints
Three MongoDB Atlas API endpoint descriptions have been updated to clarify behavior around expired/rejected user invitations: POST /api/atlas/v2/groups/{groupId}/users (add group users), POST /api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser (add team user), and POST /api/atlas/v2/orgs/{orgId}/users (create org user). The changes document how the API handles replacing users with expired or rejected invitations, with specifics on conflict detection and re-invitation requirements.
Alert history
- Informational
API documentation clarifications for user management endpoints
Three MongoDB Atlas API endpoint descriptions have been updated to clarify behavior around expired/rejected user invitations:
POST /api/atlas/v2/groups/{groupId}/users(add group users),POST /api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser(add team user), andPOST /api/atlas/v2/orgs/{orgId}/users(create org user). The changes document how the API handles replacing users with expired or rejected invitations, with specifics on conflict detection and re-invitation requirements. - Additive
Add OAuth audit event types to event type enums
The MongoDB Atlas Admin API now includes 11 new OAuth-related audit event types in the event type enumerations:
OAUTH_CLIENT_CREATED,OAUTH_CLIENT_UPDATED,OAUTH_CLIENT_DELETED,OAUTH_CLIENT_SECRET_CREATED,OAUTH_CLIENT_SECRET_DELETED,OAUTH_AUTHORIZATION_GRANTED,OAUTH_AUTHORIZATION_DENIED,OAUTH_TOKEN_ISSUED,OAUTH_TOKEN_REVOKED,OAUTH_USER_CONSENT_GRANTED, andOAUTH_USER_CONSENT_REVOKED. These are additive enum values that extend the existing event type definitions without removing or breaking existing event types. - Additive
New stream processor failover configuration and endpoints
MongoDB Atlas added new failover-related fields and endpoints to the Streams API. New fields:
failoverEnabled(request/response),eligibleForFailover(response), andfailoverRegions(response) added to stream processor and workspace schemas; New region:SEOUL_KORadded as supported region enum; New endpoints:GETandPATCHoperations added to manage failover connections at/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}/failoverConnections/{failoverConnectionId}. These are entirely additive and will not break existing clients. - Additive
Add external documentation link to maintenance window defer endpoint
The POST
/api/atlas/v2/groups/{groupId}/maintenanceWindow/deferendpoint's description was enhanced with clarification about deferral time windows, and a newexternalDocsfield was added linking to MongoDB's official documentation on responding to maintenance. This is purely additive—the API behavior and request/response shapes remain unchanged. - Additive
Add Search Deployment and maintenance settings endpoints and schemas
The API adds several new schemas (
AdditionalData,ApiSearchDeploymentEffectiveSpecView) and introduces new optional request/response fields for Search Deployment APIs (cloudProvider,regionName,defaultNodeCount,effectiveSpecs). Additionally, two new organization maintenance settings endpoints are added (GET/PATCH /orgs/{orgId}/maintenanceSettings), and the disk warming enum is expanded with a newENHANCED_FULLY_WARMEDoption. The existingspecsfield inApiSearchDeploymentResponseViewis marked deprecated in favor of the neweffectiveSpecsfield. - Breaking
Remove effectiveWaveAssignment and waveAssignment fields from maintenance window
The
effectiveWaveAssignment(read-only) andwaveAssignment(writable) fields have been removed from the maintenance window schema. Clients that readeffectiveWaveAssignmentor writewaveAssignmentto control cross-organization maintenance sequencing will break — the writable field removal is especially impactful as there is no longer a documented way to set a manual wave assignment. - Additive
Add HIGH_PERFORMANCE EBS volume type option
The
volumeTypeandebsVolumeTypefields now accept a new enum valueHIGH_PERFORMANCEalongside the existingSTANDARDandPROVISIONEDoptions. The updated documentation clarifies thatHIGH_PERFORMANCEuses IO2 EBS volumes and that NVMe clusters require eitherPROVISIONEDorHIGH_PERFORMANCE. This is a purely additive change that allows clients to specify this new storage option while existing integrations continue to work unchanged. - Informational
Update TLS cipher config field descriptions for clarity
Updated descriptions for
customOpensslCipherConfigTls12andcustomOpensslCipherConfigTls13fields across multiple schema definitions to clarify that these fields support automatic mode inference whentlsCipherConfigModeis omitted. The behavior itself remains unchanged; this is a documentation clarification. - Breaking
Remove CLUSTER_APPLY_CONNECTION_RATE_LIMIT_REQUESTED enum value from audit types
The enum value
CLUSTER_APPLY_CONNECTION_RATE_LIMIT_REQUESTEDhas been removed from the Atlas Audit Types string enum in two locations in the spec. Any client code that sends or validates this value — e.g. filtering audit events or constructing alert configurations using this event type — will break or fail validation against the updated schema. - Additive
MongoDB Atlas API: new schemas and audit event types
This update adds three new schemas for cluster configuration validation (
ClusterConfigurationValidation,ClusterConfigurationValidationError,ClusterConfigurationValidationResult), enhances existing schemas with descriptions, introduces new audit event types for Charts dashboards and log streaming, and adds aserviceUnavailable(503) response component. The changes also replace generic "This endpoint does not return a response body" descriptions with clearer "No Content" labels on 204 responses, though this is a documentation improvement. All changes are backward-compatible and do not modify existing endpoint signatures or required parameters. - Breaking
Lifecycle Management API endpoints and schemas removed
The entire Lifecycle Management tag and all associated endpoints and schemas have been removed from the MongoDB Atlas Admin API spec. This includes the CRUD endpoints under
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/lifecycleManagementPoliciesand all related schemas (ApiCustomCriteria,ApiDailySchedule,ApiDateCriteria,ApiDefaultSchedule,ApiLifecycleManagementAction,ApiLifecycleManagementCriteria,ApiLifecycleManagementPolicyCreateRequest,ApiLifecycleManagementPolicyResponse,ApiTransitionDataAction, etc.). Any client integrating with the lifecycle management preview API will break immediately as these endpoints no longer exist in the spec. - Additive
New event type enums added to MongoDB Atlas API
Three new event type enum values were added to the MongoDB Atlas Admin API:
PROJECT_COLLECT_DATABASE_STATISTICS_UPDATED,SEARCH_HOST_PAUSE_ALL_INITIAL_SYNCS, andSEARCH_HOST_DISABLE_FTS. These are additive changes to response schemas that allow the API to report additional event types without breaking existing integrations that handle unknown values gracefully. - Breaking
DeprecatedStreamProcessorMetricThreshold schema removed, replaced by StreamProcessorMetricThreshold
The
DeprecatedStreamProcessorMetricThresholdschema has been fully removed from the OpenAPI spec. Thethresholdfield in the stream processor alert configuration (previously referencingDeprecatedStreamProcessorMetricThreshold) now referencesStreamProcessorMetricThresholdinstead. Any clients or generated SDKs that reference the old schema name or depend on its specific shape may break ifStreamProcessorMetricThresholdhas a different structure. - Additive
Add search process throttling event types to Atlas API
Added three new event type enum values to the MongoDB Atlas Admin API:
HOST_SEARCH_PROCESS_THROTTLING,HOST_SEARCH_PROCESS_NOT_THROTTLING, and an additional occurrence ofHOST_SEARCH_PROCESS_THROTTLING. These new event types expand the set of alert and event states that can be reported by the API without removing or changing existing values, making this a purely additive change that does not affect existing integrations.