# Update One Cluster in One Project

**PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}**

Updates the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can update clusters with asymmetrically-sized shards. To update a cluster's termination protection, the requesting Service Account or API Key must have the Project Owner role. For all other updates, the requesting Service Account or API Key must have the Project Cluster Manager role. You can't modify a paused cluster (`paused : true`). You must call this endpoint to set `paused : false`. After this endpoint responds with `paused : false`, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters. Deprecated versions: v2-{2024-08-05}, v2-{2023-02-01}, v2-{2023-01-01}


## Servers
- https://cloud.mongodb.com: https://cloud.mongodb.com ()


## Authentication methods
- Service accounts
- Digest auth


## Parameters
### Headers
- **Use-Effective-Instance-Fields** (boolean)
  Controls how hardware specification fields are returned in the response after cluster updates. When set to true, returns the original client-specified values and provides separate effective fields showing current operational values. When false (default), hardware specification fields show current operational values directly. Note: When using this header with autoscaling enabled, MongoDB ignores replicationSpecs changes during updates. To intentionally override the replicationSpecs, disable this header.

### Path parameters
- **groupId** (string)
  Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.

  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
- **clusterName** (string)
  Human-readable label that identifies the cluster.

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

### Body: application/vnd.atlas.2024-10-23+json (object)
Cluster to update in the specified project.
- **acceptDataRisksAndForceReplicaSetReconfig** (string(date-time))
  If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- **advancedConfiguration** (object)
  Group of settings that configures a subset of the advanced configuration details.
- **backupEnabled** (boolean)
  Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups.
- **biConnector** (object)
  Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.
- **clusterType** (string)
  Configuration of nodes that comprise the cluster.
- **configServerManagementMode** (string)
  Config Server Management Mode for creating or updating a sharded cluster.

  When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.

  When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.
- **diskWarmingMode** (string)
  Disk warming mode selection.
- **encryptionAtRestProvider** (string)
  Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `"backupEnabled" : false` or omitted entirely.
- **globalClusterSelfManagedSharding** (boolean)
  Set this field to configure the Sharding Management Mode when creating a new Global Cluster.

  When set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.

  When set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.

  This setting cannot be changed once the cluster is deployed.
- **labels** (array[object])
  Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.

  Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use Resource Tags instead.
- **mongoDBEmployeeAccessGrant** (object)
  MongoDB employee granted access level and expiration for a cluster.
- **mongoDBMajorVersion** (string)
  MongoDB major version of the cluster. Set to the binary major version. 

  On creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLtsVersions).

   On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.
- **name** (string)
  Human-readable label that identifies the cluster.
- **paused** (boolean)
  Flag that indicates whether the cluster is paused.
- **pitEnabled** (boolean)
  Flag that indicates whether the cluster uses continuous cloud backups.
- **redactClientLogData** (boolean)
  Enable or disable log redaction.

  This setting configures the ``mongod`` or ``mongos`` to redact any document field contents from a message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs.

  Use ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements.

  *Note*: changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
- **replicaSetScalingStrategy** (string)
  Set this field to configure the replica set scaling mode for your cluster.

  By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.

  When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.

  When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.
- **replicationSpecs** (array[object])
  List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.
- **rootCertType** (string)
  Root Certificate Authority that MongoDB Atlas cluster uses. MongoDB Cloud supports Internet Security Research Group.
- **tags** (array[object])
  List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.
- **terminationProtectionEnabled** (boolean)
  Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster.
- **useAwsTimeBasedSnapshotCopyForFastInitialSync** (boolean)
  Flag that indicates whether AWS time-based snapshot copies will be used instead of slower standard snapshot copies during fast Atlas cross-region initial syncs. This flag is only relevant for clusters containing AWS nodes.
- **versionReleaseSystem** (string)
  Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.


## Responses
### 200
OK

#### Body: application/vnd.atlas.2024-10-23+json (object)
- **acceptDataRisksAndForceReplicaSetReconfig** (string(date-time))
  If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- **advancedConfiguration** (object)
  Group of settings that configures a subset of the advanced configuration details.
- **backupEnabled** (boolean)
  Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups.
- **biConnector** (object)
  Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.
- **clusterType** (string)
  Configuration of nodes that comprise the cluster.
- **configServerManagementMode** (string)
  Config Server Management Mode for creating or updating a sharded cluster.

  When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.

  When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.
- **configServerType** (string)
  Describes a sharded cluster's config server type.
- **connectionStrings** (object)
  Collection of Uniform Resource Locators that point to the MongoDB database.
- **createDate** (string(date-time))
  Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.
- **diskWarmingMode** (string)
  Disk warming mode selection.
- **encryptionAtRestProvider** (string)
  Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `"backupEnabled" : false` or omitted entirely.
- **featureCompatibilityVersion** (string)
  Feature compatibility version of the cluster. This will always appear regardless of whether FCV is pinned.
- **featureCompatibilityVersionExpirationDate** (string(date-time))
  Feature compatibility version expiration date. Will only appear if FCV is pinned. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- **globalClusterSelfManagedSharding** (boolean)
  Set this field to configure the Sharding Management Mode when creating a new Global Cluster.

  When set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.

  When set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.

  This setting cannot be changed once the cluster is deployed.
- **groupId** (string)
  Unique 24-hexadecimal character string that identifies the project.
- **id** (string)
  Unique 24-hexadecimal digit string that identifies the cluster.
- **internalClusterRole** (string)
  Internal classification of the cluster's role. Possible values: NONE (regular user cluster), SYSTEM_CLUSTER (system cluster for backup), INTERNAL_SHADOW_CLUSTER (internal use shadow cluster for testing).
- **labels** (array[object])
  Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.

  Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use Resource Tags instead.
- **links** (array[object])
  List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
- **mongoDBEmployeeAccessGrant** (object)
  MongoDB employee granted access level and expiration for a cluster.
- **mongoDBMajorVersion** (string)
  MongoDB major version of the cluster. Set to the binary major version. 

  On creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLtsVersions).

   On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.
- **mongoDBVersion** (string)
  Version of MongoDB that the cluster runs.
- **name** (string)
  Human-readable label that identifies the cluster.
- **paused** (boolean)
  Flag that indicates whether the cluster is paused.
- **pitEnabled** (boolean)
  Flag that indicates whether the cluster uses continuous cloud backups.
- **redactClientLogData** (boolean)
  Enable or disable log redaction.

  This setting configures the ``mongod`` or ``mongos`` to redact any document field contents from a message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs.

  Use ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements.

  *Note*: changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
- **replicaSetScalingStrategy** (string)
  Set this field to configure the replica set scaling mode for your cluster.

  By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.

  When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.

  When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.
- **replicationSpecs** (array[object])
  List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.
- **rootCertType** (string)
  Root Certificate Authority that MongoDB Atlas cluster uses. MongoDB Cloud supports Internet Security Research Group.
- **stateName** (string)
  Human-readable label that indicates any current activity being taken on this cluster by the Atlas control plane. With the exception of CREATING and DELETING states, clusters should always be available and have a Primary node even when in states indicating ongoing activity.

   - `IDLE`: Atlas is making no changes to this cluster and all changes requested via the UI or API can be assumed to have been applied.
   - `CREATING`: A cluster being provisioned for the very first time returns state CREATING until it is ready for connections. Ensure IP Access List and DB Users are configured before attempting to connect.
   - `UPDATING`: A change requested via the UI, API, AutoScaling, or other scheduled activity is taking place.
   - `DELETING`: The cluster is in the process of deletion and will soon be deleted.
   - `REPAIRING`: One or more nodes in the cluster are being returned to service by the Atlas control plane. Other nodes should continue to provide service as normal.
- **tags** (array[object])
  List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.
- **terminationProtectionEnabled** (boolean)
  Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster.
- **useAwsTimeBasedSnapshotCopyForFastInitialSync** (boolean)
  Flag that indicates whether AWS time-based snapshot copies will be used instead of slower standard snapshot copies during fast Atlas cross-region initial syncs. This flag is only relevant for clusters containing AWS nodes.
- **versionReleaseSystem** (string)
  Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.

### 400
Bad Request.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 401
Unauthorized.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 403
Forbidden.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 404
Not Found.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 409
Conflict.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 500
Internal Server Error.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.


[Powered by Bump.sh](https://bump.sh)