- API >
- API Resources >
- Clusters
Get Advanced Configuration Options for One Cluster¶
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.
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.
Request¶
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
GET /groups/{PROJECT-ID}/clusters/{CLUSTER-NAME}/processArgs
Request Path Parameters¶
Path Parameter | Type | Necessity | Description |
---|---|---|---|
PROJECT-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. |
Request Query Parameters¶
The following query parameters are optional:
Query Parameter | 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¶
This endpoint does not use HTTP request body parameters.
Response¶
Name | Type | Description |
---|---|---|
failIndexKeyTooLong | boolean | When This option corresponds to the
|
javascriptEnabled | boolean | When
|
minimumEnabledTlsProtocol | string | 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
|
noTableScan | boolean | When This option corresponds to the
|
oplogSizeMB | integer | The custom oplog size of the cluster. A value of You can check the oplog size by connecting to your cluster
via the This option corresponds to the
|
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 |
Example Request¶
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"
Example Response¶
Response Header¶
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}
Response Body¶
1 { 2 "failIndexKeyTooLong": true, 3 "javascriptEnabled": true, 4 "minimumEnabledTlsProtocol": "TLS1_1", 5 "noTableScan": false, 6 "oplogSizeMB": 1000 7 }