# Update Advanced Configuration Options for One Cluster

**PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/processArgs**

Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. This feature isn't available for `M0` free clusters, `M2` and `M5` shared-tier clusters, flex clusters, or serverless clusters.

[Global Clusters](https://www.mongodb.com/ko-kr/docs/atlas/global-clusters/)

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


## Authentication methods
- Service accounts
- Digest auth


## Parameters

#### 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 parameters
Content-type: application/json
Advanced configuration details to add for one cluster in the specified project.
- **changeStreamOptionsPreAndPostImagesExpireAfterSeconds** (integer(int32))
  The minimum pre- and post-image retention time in seconds.
- **chunkMigrationConcurrency** (integer(int32))
  Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.
- **customOpensslCipherConfigTls12** (array[string])
  The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when `tlsCipherConfigMode` is set to `CUSTOM`.
- **customOpensslCipherConfigTls13** (array[string])
  The custom OpenSSL cipher suite list for TLS 1.3. This field is only valid when `tlsCipherConfigMode` is set to `CUSTOM`.
- **defaultMaxTimeMS** (integer(int32))
  Default time limit in milliseconds for individual read operations to complete.
- **defaultReadConcern** (string)
  Default level of acknowledgment requested from MongoDB for read operations set for this cluster.

MongoDB 4.4 clusters default to `available`. MongoDB 5.0 and later clusters default to `local`.
- **defaultWriteConcern** (string)
  Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.
- **failIndexKeyTooLong** (boolean)
  Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, [mongod](https://docs.mongodb.com/upcoming/reference/program/mongod/#mongodb-binary-bin.mongod) writes documents that exceed this limit but doesn't index them. This parameter has been removed as of [MongoDB 4.4](https://www.mongodb.com/ko-kr/docs/manual/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong).
- **javascriptEnabled** (boolean)
  Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript. When using 8.0+, we recommend disabling server-side JavaScript and using operators of aggregation pipeline as more performant alternative.
- **minimumEnabledTlsProtocol** (string)
  Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.
- **noTableScan** (boolean)
  Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.
- **oplogMinRetentionHours** (number(double) | null)
  Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- **oplogSizeMB** (integer(int32) | null)
  Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.
- **queryStatsLogVerbosity** (integer(int32))
  May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.
- **sampleRefreshIntervalBIConnector** (integer(int32))
  Interval in seconds at which the mongosqld process re-samples data to create its relational schema.
- **sampleSizeBIConnector** (integer(int32))
  Number of documents per database to sample when gathering schema information.
- **tlsCipherConfigMode** (string)
  The TLS cipher suite configuration mode. The default mode uses the default cipher suites. The custom mode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3.
- **transactionLifetimeLimitSeconds** (integer(int64))
  Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.

## Responses
### 200: OK

#### Body Parameters: application/json (object)
- **changeStreamOptionsPreAndPostImagesExpireAfterSeconds** (integer(int32))
  The minimum pre- and post-image retention time in seconds.
- **chunkMigrationConcurrency** (integer(int32))
  Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.
- **customOpensslCipherConfigTls12** (array[string])
  The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when `tlsCipherConfigMode` is set to `CUSTOM`.
- **customOpensslCipherConfigTls13** (array[string])
  The custom OpenSSL cipher suite list for TLS 1.3. This field is only valid when `tlsCipherConfigMode` is set to `CUSTOM`.
- **defaultMaxTimeMS** (integer(int32))
  Default time limit in milliseconds for individual read operations to complete.
- **defaultReadConcern** (string)
  Default level of acknowledgment requested from MongoDB for read operations set for this cluster.

MongoDB 4.4 clusters default to `available`. MongoDB 5.0 and later clusters default to `local`.
- **defaultWriteConcern** (string)
  Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.
- **failIndexKeyTooLong** (boolean)
  Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, [mongod](https://docs.mongodb.com/upcoming/reference/program/mongod/#mongodb-binary-bin.mongod) writes documents that exceed this limit but doesn't index them. This parameter has been removed as of [MongoDB 4.4](https://www.mongodb.com/ko-kr/docs/manual/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong).
- **javascriptEnabled** (boolean)
  Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript. When using 8.0+, we recommend disabling server-side JavaScript and using operators of aggregation pipeline as more performant alternative.
- **minimumEnabledTlsProtocol** (string)
  Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.
- **noTableScan** (boolean)
  Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.
- **oplogMinRetentionHours** (number(double) | null)
  Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- **oplogSizeMB** (integer(int32) | null)
  Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.
- **queryStatsLogVerbosity** (integer(int32))
  May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.
- **sampleRefreshIntervalBIConnector** (integer(int32))
  Interval in seconds at which the mongosqld process re-samples data to create its relational schema.
- **sampleSizeBIConnector** (integer(int32))
  Number of documents per database to sample when gathering schema information.
- **tlsCipherConfigMode** (string)
  The TLS cipher suite configuration mode. The default mode uses the default cipher suites. The custom mode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3.
- **transactionLifetimeLimitSeconds** (integer(int64))
  Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.

### 400: Bad Request.

#### Body Parameters: 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 Parameters: 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 Parameters: 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 Parameters: 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 Parameters: 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)