MOmongodb
Clusters

Update Advanced Configuration Options for One Cluster

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. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters.

patch/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

groupIdstring required
Example:32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project. Use the /groups 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.

clusterNamestring required

Human-readable label that identifies the cluster.

Query parameters

envelopeboolean

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.

prettyboolean

Flag that indicates whether the response body should be in the prettyprint format.

Request body

changeStreamOptionsPreAndPostImagesExpireAfterSecondsinteger

The minimum pre- and post-image retention time in seconds.

chunkMigrationConcurrencyinteger

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.

customOpensslCipherConfigTls12string[]

The custom OpenSSL cipher suite list for TLS 1.2. Requires tlsCipherConfigMode = CUSTOM; when tlsCipherConfigMode is omitted, supplying a non-empty list infers CUSTOM.

customOpensslCipherConfigTls13string[]

The custom OpenSSL cipher suite list for TLS 1.3. Requires tlsCipherConfigMode = CUSTOM; when tlsCipherConfigMode is omitted, supplying a non-empty list infers CUSTOM.

defaultMaxTimeMSinteger

Default time limit in milliseconds for individual read operations to complete.

defaultReadConcern'local' | 'available'

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.

defaultWriteConcernstring

Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.

failIndexKeyTooLongboolean

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 writes documents that exceed this limit but doesn't index them. This parameter has been removed as of MongoDB 4.4.

javascriptEnabledboolean

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'TLS1_0' | 'TLS1_1' | 'TLS1_2' | 'TLS1_3'

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.

noTableScanboolean

Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.

oplogMinRetentionHoursnumber double nullable

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.

oplogSizeMBinteger nullable

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.

queryStatsLogVerbosityinteger

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.

sampleRefreshIntervalBIConnectorinteger

Interval in seconds at which the mongosqld process re-samples data to create its relational schema.

sampleSizeBIConnectorinteger

Number of documents per database to sample when gathering schema information.

tlsCipherConfigMode'CUSTOM' | 'DEFAULT'

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.

transactionLifetimeLimitSecondsinteger

Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic clean-up process.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.