MongoDBMongoDB Atlas Administration API v2
PATCH/api/atlas/v2/groups/{groupId}/flexClusters/{name}
Manage update Group Flex Cluster.
Contract-preserving PATCH endpoint for update Group Flex Cluster in the MongoDB Atlas Administration API. Resource-specific values are supplied by the caller at runtime.
All 540 MongoDB Atlas administration endpoints from a fixed Apache-2.0 OpenAPI revision. Hub provides documentation and an independent SDK/CLI, but never proxies account, organization, project, network, backup, or operational data; callers connect directly with local credentials.
Request
- operationId
updateGroupFlexCluster- Server
https://cloud.mongodb.com- Authentication
- ServiceAccounts, DigestAuth
Request parameters
envelope
queryboolean
envelope value in the Atlas Administration API contract.
groupId
pathstringrequired
group Id value in the Atlas Administration API contract.
32b6e34b3d91647abb20e7b8
pretty
queryboolean
pretty value in the Atlas Administration API contract.
name
pathstringrequired
name value in the Atlas Administration API contract.
Request body
FlexClusterDescriptionUpdate20241113required
Content-Type: application/vnd.atlas.2024-11-13+json
Properties: linkstagsterminationProtectionEnabled
Responses
200
FlexClusterDescription20241113application/vnd.atlas.2024-11-13+json
Successful supplier response.
Properties: backupSettingsclusterTypeconnectionStringscreateDategroupIdidlinksmongoDBVersionnameproviderSettingsstateNametagsterminationProtectionEnabledversionReleaseSystem
400
ApiErrorapplication/json
Supplier response with HTTP status 400.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
401
ApiErrorapplication/json
Supplier response with HTTP status 401.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
402
ApiErrorapplication/json
Supplier response with HTTP status 402.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
403
ApiErrorapplication/json
Supplier response with HTTP status 403.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
404
ApiErrorapplication/json
Supplier response with HTTP status 404.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
409
ApiErrorapplication/json
Supplier response with HTTP status 409.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
429
ApiErrorapplication/json
Supplier response with HTTP status 429.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
{
"backupSettings": {
"enabled": true
},
"clusterType": "REPLICASET",
"connectionStrings": {},
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": {
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
}