MongoDBMongoDB Atlas Administration API v2
PATCH/api/atlas/v2/orgs/{orgId}/sandboxConfig/{sandboxConfigId}
Manage update Org Sandbox Config.
Contract-preserving PATCH endpoint for update Org Sandbox Config 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
updateOrgSandboxConfig- 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.
orgId
pathstringrequired
org Id value in the Atlas Administration API contract.
4888442a3354817a7320eb61
sandboxConfigId
pathstringrequired
sandbox Config Id value in the Atlas Administration API contract.
507f1f77bcf86cd799439011
Request body
SandboxConfigUpdateRequestrequired
Content-Type: application/vnd.atlas.preview+json
Properties: clusterTemplateenabled
Responses
200
SandboxConfigResponseapplication/vnd.atlas.preview+json
Successful supplier response.
Properties: clusterTemplateenabledid
400
ApiErrorapplication/json
Supplier response with HTTP status 400.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
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
{
"clusterTemplate": {
"provider": "AWS",
"region": "US_EAST_1",
"tier": "M0"
},
"enabled": false,
"id": "32b6e34b3d91647abb20e7b8"
}