MOmongodb
Sandbox

Update an Existing Sandbox Configuration

Update an existing sandbox configuration for an organization.

patch/api/atlas/v2/orgs/{orgId}/sandboxConfig/{sandboxConfigId}

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/sandboxConfig/{sandboxConfigId}
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

orgIdstring required
Example:4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.

sandboxConfigIdstring required
Example:507f1f77bcf86cd799439011

Unique 24-hexadecimal digit string that identifies the sandbox configuration.

Query parameters

envelopeboolean

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.

prettyboolean

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

Request body

enabledboolean nullable

Whether sandbox mode is enabled for the organization.

Example request

{
  "clusterTemplate": {
    "provider": "AWS",
    "region": "US_EAST_1",
    "tier": "M0"
  }
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.