Navigation

Modify Advanced Configuration Options for One Cluster

Note

This feature is not available for M0 (Free Tier), M2, and M5 clusters. For more information, see Atlas M0 (Free Tier), 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 uses HTTP Digest Authentication. Provide your Atlas username and API key as the username and password when constructing the HTTP request.

For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.

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

Syntax

PATCH /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/processArgs

Request Path Parameters

Path Element Required/Optional Description
GROUP-ID Required. The unique identifier for the project containing the cluster you want to retrieve.
CLUSTER-NAME Required The name of the cluster to retrieve.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.

Name Type Description Default
pretty boolean Displays response in a prettyprint format. false
envelope boolean Specifies whether or not to wrap the response in an envelope. false

Request Body Parameters

Specify one or all of the following options.

Name Type Description
failIndexKeyTooLong boolean

When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

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

javascriptEnabled boolean

When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

Changing this option corresponds to modifying the security.javascriptEnabled configuration file option for each mongod in the cluster.

minimumEnabledTlsProtocol string

Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.

Valid values are:

  • TLS1_0
  • TLS1_1
  • TLS1_2

TLS 1.0 Deprecation

For users considering this option as a method for enabling the deprecated Transport Layer Security (TLS) 1.0 protocol version, please read What versions of TLS does Atlas support? before proceeding. Atlas deprecation of TLS 1.0 improves your security of data-in-transit and aligns with industry best practices. Enabling TLS 1.0 for any Atlas cluster carries security risks. Consider enabling TLS 1.0 only for as long as required to update your application stack to support TLS 1.1 or later.

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

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

The 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 the mongo shell 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.

To deploy the specified changes in clusters running MongoDB 3.4, 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?.

For clusters running MongoDB 3.6 and later, Atlas can deploy the specified changes without performing a rolling restart.

sampleSizeBIConnector integer

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.

sampleRefreshIntervalBIConnector integer

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.

HTTP Response Elements

Name Type Description
failIndexKeyTooLong boolean

When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that breach the limit but does not index them.

This option corresponds to the failIndexKeyTooLong mongod parameter.

javascriptEnabled boolean

When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

This option corresponds to the security.javascriptEnabled mongod configuration file option.

minimumEnabledTlsProtocol string

The minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.

Clusters using the deprecated TLS 1.0 protocol version should consider setting TLS 1.1 or later as the minimum TLS protocol version. To learn more about TLS 1.0 deprecation, see What versions of TLS does Atlas support?.

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

noTableScan boolean

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.

This option corresponds to the notablescan mongod parameter.

oplogSizeMB integer

The 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 the mongo shell and authenticating as a user with the Atlas admin role. 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 element 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 element corresponds to the sampleRefreshIntervalSecs mongosqld option.

Example

Request

curl --user "username:apiKey" --include --digest \
 --header "Content-Type: application/json" \
 --request PATCH "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794de37132bb7b/clusters/LogData/processArgs" \
 --data '
   {
     "failIndexKeyTooLong" : false,
     "javascriptEnabled" : false,
     "minimumEnabledTlsProtocol": "TLS1_2",
     "noTableScan" : true,
     "oplogSizeMB" : 2000,
     "sampleSizeBIConnector" : 5000,
     "sampleRefreshIntervalBIConnector" : 300
   }
 '

Response

{
  "failIndexKeyTooLong": false,
  "javascriptEnabled": false,
  "minimumEnabledTlsProtocol": "TLS1_2",
  "noTableScan": true,
  "oplogSizeMB": 2000,
  "sampleSizeBIConnector" : 5000,
  "sampleRefreshIntervalBIConnector" : 300
}