MOmongodb
Organizations

Update Maintenance Settings for One Organization

Updates maintenance settings for the specified organization. Omit optional fields from the request body to leave their current values unchanged. Specify null on an optional field to reset it to its default value.

patch/api/atlas/v2/orgs/{orgId}/maintenanceSettings

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/maintenanceSettings
  • 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.

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

waveAssignmentMode'MANUAL' | 'ENV_TAG_MAPPING'

Mode configured for this organization that determines how maintenance waves are assigned to projects. Possible values are MANUAL and ENV_TAG_MAPPING. Defaults to MANUAL when unset. Set the organization to ENV_TAG_MAPPING mode to have Atlas derive the maintenance wave from each project's environment tag. The tag key must be environment. The tag value determines the wave: development or test maps to Wave 1, staging maps to Wave 2, and production maps to Wave 3. Only this field can be updated; Atlas derives read-only effectiveWaveAssignmentMode on GET responses and uses that value for scheduling when it differs from waveAssignmentMode. Omit this field to leave the current value unchanged. Specify null to reset to the default value (MANUAL).

Response

OK

Changes

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