Navigation

Get Advanced Configuration Options for One Cluster

Info With Circle IconCreated with Sketch.Note
Feature unavailable in Free and Shared-Tier Clusters

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

Info With Circle IconCreated with Sketch.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

GET /groups/{PROJECT-ID}/clusters/{CLUSTER-NAME}/processArgs
Path ParameterTypeNecessityDescription
PROJECT-IDstringRequiredUnique identifier for the project containing the cluster you want to retrieve.
CLUSTER-NAMEstringRequiredName of the cluster to retrieve.

The following query parameters are optional:

Query ParameterTypeDescriptionDefault
prettybooleanDisplays response in a prettyprint format.false
envelopebooleanSpecifies whether or not to wrap the response in an envelope.false

This endpoint does not use HTTP request body parameters.

NameTypeDescription
failIndexKeyTooLongboolean

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.

javascriptEnabledboolean

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

  • If your cluster runs a MongoDB version less than 4.4, this option corresponds to modifying the security.javascriptEnabled configuration file option for each mongod in the cluster.
  • If your cluster runs MongoDB version 4.4 or greater, this option corresponds to modifying the security.javascriptEnabled configuration file option for each mongod and mongos in the cluster.
minimumEnabledTlsProtocolstring

The minimum Transport Layer Security (TLS) version 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.

noTableScanboolean

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.

oplogSizeMBinteger

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.

sampleSizeBIConnectorinteger

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

This element corresponds to the sampleSize mongosqld option.

sampleRefreshIntervalBIConnectorinteger

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

This element corresponds to the sampleRefreshIntervalSecs mongosqld option.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \
--include --digest \
--header "Content-Type: application/json" \
--request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{PROJECT-ID}/clusters/LogData/processArgs"
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}
1{
2 "failIndexKeyTooLong": true,
3 "javascriptEnabled": true,
4 "minimumEnabledTlsProtocol": "TLS1_1",
5 "noTableScan": false,
6 "oplogSizeMB": 1000
7}
Give Feedback