Navigation

Modify Advanced Configuration Options for One Cluster

On this page

  • Resource
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Example Request
  • Example Response
  • Response Header
  • Response Body
Note
Feature unavailable in Free and Shared-Tier Clusters

This feature is not available for M0 free clusters, M2, and M5 clusters. To learn more about which features are unavailable, see Atlas M0 (Free Cluster), M2, and M5 Limitations.

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.

The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

PATCH /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/processArgs
Path Parameter
Type
Necessity
Description
GROUP-ID
string
Required
Unique identifier for the project containing the cluster you want to retrieve.
CLUSTER-NAME
string
Required
Name of the cluster to retrieve.

This endpoint might use any of the HTTP request query parameters available to all Atlas API resources. All of these are optional.

Name
Type
Necessity
Description
Default
pretty
boolean
Optional
Flag indicating whether the response body should be in a prettyprint format.
false
envelope
boolean
Optional

Flag indicating if Atlas should wrap the response in a JSON envelope.

This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

status
HTTP response code
envelope
Expected response body
false

Specify one or all of the following options.

Body Parameter
Type
Necessity
Description
defaultReadConcern
string
Optional
defaultWriteConcern
string
Optional

Default level of acknowledgment requested from MongoDB for write operations set for this cluster.

MongoDB 4.4 clusters default to 1.

failIndexKeyTooLong
boolean
Optional

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.

Changing this option corresponds to modifying the failIndexKeyTooLong parameter via the setParameter command for each mongod in the cluster.

Important
Index Key Limit

failIndexKeyTooLong was deprecated in MongoDB version 4.2 and is removed in MongoDB 4.4 and later.

javascriptEnabled
boolean
Optional

Enable or disable execution of operations that perform server-side execution of JavaScript.

Note

In MongoDB version 4.4 and later, security.javascriptEnabled applies to mongos' as well.

minimumEnabledTlsProtocol
string
Optional

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. Atlas accepts the following values: TLS1_0, TLS1_1, TLS1_2. Atlas sets the default value for all clusters to TLS1_2.

To learn more, see What versions of TLS does Atlas support?.

Note

If you consider this option to enable the deprecated TLS 1.0 protocol version, read What versions of TLS does Atlas support? before first. TLS 1.0 carries security risks for any Atlas cluster that uses it. Enable TLS 1.0 only until you to update your application stack to support TLS 1.2.

Changing this option corresponds to configuring the net.ssl.disabledProtocols configuration file option for each mongod in the cluster.

To deploy the specified changes, Atlas performs a rolling deployment upgrade to maintain high availability. For sharded clusters, this involves a rolling restart of all shards and the config server replica set. To learn more about how Atlas supports high availability during maintenance operations, see How does MongoDB Atlas deliver high availability?.

noTableScan
boolean
Optional

When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

Changing this option corresponds to modifying the notablescan parameter via the setParameter command for each mongod in the cluster.

oplogSizeMB
integer
Optional

Custom oplog size of the cluster. A value of null indicates that the cluster uses the default oplog size calculated by Atlas.

You can check the oplog size by connecting to your cluster via mongosh and authenticating as a user with the Atlas admin role. Run the rs.printReplicationInfo() method to view the current oplog size and time.

Changing this option corresponds to modifying the replication.oplogSizeMB configuration file option for each mongod in the cluster.

Atlas can deploy the specified changes without performing a rolling restart.

sampleSizeBIConnector
integer
Optional

Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

Tip
sampleRefreshIntervalBIConnector
integer
Optional

Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

Name
Type
Description
defaultReadConcern
string
defaultWriteConcern
string

Default level of acknowledgment requested from MongoDB for write operations set for this cluster.

MongoDB 4.4 clusters default to 1.

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 writes documents that exceed this limit but doesn't index them.

This option corresponds to the failIndexKeyTooLong mongod parameter.

javascriptEnabled
boolean

Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.

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.

To learn more, see What versions of TLS does Atlas support?.

This option corresponds to the net.ssl.disabledProtocols mongod configuration file option.

noTableScan
boolean

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

This option corresponds to the notablescan mongod parameter.

oplogSizeMB
integer

Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that Atlas calculates.

To check the oplog size:

  1. Connect to your cluster via mongosh.
  2. Authenticate as a user with the Atlas admin role.
  3. Run the rs.printReplicationInfo() method to view the current oplog size and time.

This option corresponds to the replication.oplogSizeMB mongod configuration file option.

sampleSizeBIConnector
integer

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

This parameter corresponds to the sampleSize mongosqld option.

sampleRefreshIntervalBIConnector
integer

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

This parameter corresponds to the sampleRefreshIntervalSecs mongosqld option.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --include --digest \
--header "Content-Type: application/json" \
--request PATCH "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/clusters/LogData/processArgs" \
--data '{
"defaultReadConcern": "available",
"defaultWriteConcern": "1",
"failIndexKeyTooLong" : false,
"javascriptEnabled" : false,
"minimumEnabledTlsProtocol": "TLS1_2",
"noTableScan" : true,
"oplogSizeMB" : 2000,
"sampleSizeBIConnector" : 5000,
"sampleRefreshIntervalBIConnector" : 300
}'
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
{
"defaultReadConcern": "available",
"defaultWriteConcern": "1",
"failIndexKeyTooLong": false,
"javascriptEnabled": false,
"minimumEnabledTlsProtocol": "TLS1_2",
"noTableScan": true,
"oplogSizeMB": 2000,
"sampleSizeBIConnector" : 5000,
"sampleRefreshIntervalBIConnector" : 300
}
Give Feedback

On this page

  • Resource
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Example Request
  • Example Response
  • Response Header
  • Response Body