- API >
- API Resources >
- Clusters >
- Get Advanced Configuration Options for One Cluster
Get Advanced Configuration Options for One Cluster¶
On this page
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.
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 a programmatic API public key and corresponding private 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¶
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¶
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.
HTTP Response Elements¶
Name | Type | Description |
---|---|---|
failIndexKeyTooLong |
boolean | When This option corresponds to the
|
javascriptEnabled |
boolean | When This option corresponds to the
|
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
|
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
|