MongoDB/generateGroupSandboxClusterDescription

Online calls unavailable · details below

MongoDBMongoDB Atlas Administration API v2

GET/api/atlas/v2/groups/{groupId}/sandbox/{sandboxConfigId}:generateClusterDescription

Read generate Group Sandbox Cluster Description.

Contract-preserving GET endpoint for generate Group Sandbox Cluster Description in the MongoDB Atlas Administration API. Resource-specific values are supplied by the caller at runtime.

All 540 MongoDB Atlas administration endpoints from a fixed Apache-2.0 OpenAPI revision. Hub provides documentation and an independent SDK/CLI, but never proxies account, organization, project, network, backup, or operational data; callers connect directly with local credentials.

Request

operationId: generateGroupSandboxClusterDescription
Server: https://cloud.mongodb.com
Authentication: ServiceAccounts, DigestAuth

Request parameters

`envelope`

queryboolean

envelope value in the Atlas Administration API contract.

`pretty`

queryboolean

pretty value in the Atlas Administration API contract.

`groupId`

pathstringrequired

group Id value in the Atlas Administration API contract.

32b6e34b3d91647abb20e7b8

`sandboxConfigId`

pathstringrequired

sandbox Config Id value in the Atlas Administration API contract.

507f1f77bcf86cd799439011

Responses

`200`

ClusterDescription20240805application/vnd.atlas.preview+json

Successful supplier response.

Properties: acceptDataRisksAndForceReplicaSetReconfigadaptiveCapacityadvancedConfigurationbackupEnabledbiConnectorclusterTypeconfigServerManagementModeconfigServerTypeconnectionStringscreateDatediskWarmingModeeffectiveReplicationSpecsencryptionAtRestProviderfeatureCompatibilityVersionfeatureCompatibilityVersionExpirationDateglobalClusterSelfManagedShardinggroupIdidinternalClusterRolelabelslinksmongoDBEmployeeAccessGrantmongoDBMajorVersionmongoDBVersionnamepausedpitEnabledredactClientLogDatareplicaSetScalingStrategyreplicationSpecsretainBackupsrootCertTypestateNametagsterminationProtectionEnableduseAwsTimeBasedSnapshotCopyForFastInitialSyncversionReleaseSystem

`401`

ApiErrorapplication/json

Supplier response with HTTP status 401.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

`403`

ApiErrorapplication/json

Supplier response with HTTP status 403.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

`404`

ApiErrorapplication/json

Supplier response with HTTP status 404.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

`500`

ApiErrorapplication/json

Supplier response with HTTP status 500.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

{
  "adaptiveCapacity": "ENABLED",
  "advancedConfiguration": {
    "customOpensslCipherConfigTls12": [
      "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
    ],
    "customOpensslCipherConfigTls13": [
      "TLS_AES_256_GCM_SHA384"
    ],
    "minimumEnabledTlsProtocol": "TLS1_0",
    "tlsCipherConfigMode": "CUSTOM"
  },
  "backupEnabled": false,
  "biConnector": {
    "enabled": false,
    "readPreference": "PRIMARY"
  },
  "clusterType": "REPLICASET",
  "configServerManagementMode": "ATLAS_MANAGED",
  "configServerType": "DEDICATED"
}