Update Advanced Configuration Options for One Cluster Deprecated

PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs

Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters.

Global Clusters

Path parameters

  • groupId string Required

    Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

    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.

    Format should match the following pattern: ^([a-f0-9]{24})$.

  • clusterName string Required

    Human-readable label that identifies the cluster.

    Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

Query parameters

  • envelope boolean

    Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

    Default value is false.

  • pretty boolean

    Flag that indicates whether the response body should be in the prettyprint format.

    Default value is false.

    Prettyprint
application/vnd.atlas.2023-01-01+json

Body Required

Advanced configuration details to add for one cluster in the specified project.

  • changeStreamOptionsPreAndPostImagesExpireAfterSeconds integer(int32)

    The minimum pre- and post-image retention time in seconds.

    Default value is -1.

    This option corresponds to the...
  • chunkMigrationConcurrency integer(int32)

    Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.

    This option corresponds to the...
  • customOpensslCipherConfigTls12 array[string]

    The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when tlsCipherConfigMode is set to CUSTOM.

    Values are TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 or TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256.

  • defaultMaxTimeMS integer(int32)

    Default time limit in milliseconds for individual read operations to complete.

    This option corresponds to the...
  • defaultReadConcern string

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

    MongoDB 4.4 clusters default to available. MongoDB 5.0 and later clusters default to local.

    Values are local or available. Default value is available.

    This option corresponds to the...
  • defaultWriteConcern string

    Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.

    This option corresponds to the...
  • failIndexKeyTooLong boolean Deprecated

    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 parameter has been removed as of MongoDB 4.4.

    Default value is true.

    This option corresponds to the...
  • javascriptEnabled boolean

    Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript. When using 8.0+, we recommend disabling server-side JavaScript and using operators of aggregation pipeline as more performant alternative.

    This option corresponds to mod...
  • 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.

    Values are TLS1_0, TLS1_1, or TLS1_2.

    This option corresponds to the...
  • 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...
  • oplogMinRetentionHours number(double) | null

    Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.

    This option corresponds to the...
  • oplogSizeMB integer(int32) | null

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

    This option corresponds to the...
  • queryStatsLogVerbosity integer(int32)

    May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.

    This option corresponds to the...
  • sampleRefreshIntervalBIConnector integer(int32)

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

    Minimum value is 0. Default value is 0.

    This option corresponds to the...
  • sampleSizeBIConnector integer(int32)

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

    Minimum value is 0.

    This option corresponds to the...
  • tlsCipherConfigMode string

    The TLS cipher suite configuration mode. The default mode uses the default cipher suites. The custom mode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3.

    Values are CUSTOM or DEFAULT.

  • transactionLifetimeLimitSeconds integer(int64)

    Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.

    Minimum value is 1.

    This option corresponds to the...

Responses

  • 200 application/vnd.atlas.2023-01-01+json

    OK

    Hide response attributes Show response attributes object
    • changeStreamOptionsPreAndPostImagesExpireAfterSeconds integer(int32)

      The minimum pre- and post-image retention time in seconds.

      Default value is -1.

      This option corresponds to the...
    • chunkMigrationConcurrency integer(int32)

      Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.

      This option corresponds to the...
    • customOpensslCipherConfigTls12 array[string]

      The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when tlsCipherConfigMode is set to CUSTOM.

      Values are TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 or TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256.

    • defaultMaxTimeMS integer(int32)

      Default time limit in milliseconds for individual read operations to complete.

      This option corresponds to the...
    • defaultReadConcern string

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

      MongoDB 4.4 clusters default to available. MongoDB 5.0 and later clusters default to local.

      Values are local or available. Default value is available.

      This option corresponds to the...
    • defaultWriteConcern string

      Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.

      This option corresponds to the...
    • failIndexKeyTooLong boolean Deprecated

      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 parameter has been removed as of MongoDB 4.4.

      Default value is true.

      This option corresponds to the...
    • javascriptEnabled boolean

      Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript. When using 8.0+, we recommend disabling server-side JavaScript and using operators of aggregation pipeline as more performant alternative.

      This option corresponds to mod...
    • 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.

      Values are TLS1_0, TLS1_1, or TLS1_2.

      This option corresponds to the...
    • 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...
    • oplogMinRetentionHours number(double) | null

      Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.

      This option corresponds to the...
    • oplogSizeMB integer(int32) | null

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

      This option corresponds to the...
    • queryStatsLogVerbosity integer(int32)

      May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.

      This option corresponds to the...
    • sampleRefreshIntervalBIConnector integer(int32)

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

      Minimum value is 0. Default value is 0.

      This option corresponds to the...
    • sampleSizeBIConnector integer(int32)

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

      Minimum value is 0.

      This option corresponds to the...
    • tlsCipherConfigMode string

      The TLS cipher suite configuration mode. The default mode uses the default cipher suites. The custom mode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3.

      Values are CUSTOM or DEFAULT.

    • transactionLifetimeLimitSeconds integer(int64)

      Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.

      Minimum value is 1.

      This option corresponds to the...
  • 400 application/json

    Bad Request.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.

  • 401 application/json

    Unauthorized.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.

  • 403 application/json

    Forbidden.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.

  • 404 application/json

    Not Found.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.

  • 500 application/json

    Internal Server Error.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.

PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs
atlas api clusters updateGroupClusterProcessArgs --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20230101001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.UpdateGroupClusterProcessArgsApiParams{}
	sdkResp, httpResp, err := client.ClustersApi.
		UpdateGroupClusterProcessArgsWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" \
  -d '{ <Payload> }'
Request examples
{
  "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  "chunkMigrationConcurrency": 42,
  "customOpensslCipherConfigTls12": [
    "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
  ],
  "defaultMaxTimeMS": 42,
  "defaultReadConcern": "available",
  "defaultWriteConcern": "string",
  "failIndexKeyTooLong": true,
  "javascriptEnabled": true,
  "minimumEnabledTlsProtocol": "TLS1_0",
  "noTableScan": true,
  "oplogMinRetentionHours": 42.0,
  "oplogSizeMB": 42,
  "queryStatsLogVerbosity": 42,
  "sampleRefreshIntervalBIConnector": 0,
  "sampleSizeBIConnector": 42,
  "tlsCipherConfigMode": "CUSTOM",
  "transactionLifetimeLimitSeconds": 42
}
Response examples (200)
{
  "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  "chunkMigrationConcurrency": 42,
  "customOpensslCipherConfigTls12": [
    "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
  ],
  "defaultMaxTimeMS": 42,
  "defaultReadConcern": "available",
  "defaultWriteConcern": "string",
  "failIndexKeyTooLong": true,
  "javascriptEnabled": true,
  "minimumEnabledTlsProtocol": "TLS1_0",
  "noTableScan": true,
  "oplogMinRetentionHours": 42.0,
  "oplogSizeMB": 42,
  "queryStatsLogVerbosity": 42,
  "sampleRefreshIntervalBIConnector": 0,
  "sampleSizeBIConnector": 42,
  "tlsCipherConfigMode": "CUSTOM",
  "transactionLifetimeLimitSeconds": 42
}
Response examples (400)
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
Response examples (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Response examples (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Response examples (404)
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Response examples (500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}