MOmongodb
Projects

Update Project Settings

Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request.

patch/api/atlas/v2/groups/{groupId}/settings

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

groupIdstring required
Example:32b6e34b3d91647abb20e7b8

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.

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

isClusterAiAssistantEnabledboolean

Flag that indicates whether the AI Cluster Assistant is enabled for the specified project.

isCollectDatabaseSpecificsStatisticsEnabledboolean

Flag that indicates whether to collect database-specific metrics for the specified project.

isDataExplorerEnabledboolean

Flag that indicates whether to enable the Data Explorer for the specified project.

isDataExplorerGenAIFeaturesEnabledboolean

Flag that indicates whether to enable the use of generative AI features which make requests to 3rd party services in Data Explorer for the specified project.

isDataExplorerGenAISampleDocumentPassingEnabledboolean

Flag that indicates whether to enable the passing of sample field values with the use of generative AI features in the Data Explorer for the specified project.

isDataValidationEnabledboolean

Flag that indicates whether data validation is enabled for all clusters in the specified project.

isExtendedStorageSizesEnabledboolean

Flag that indicates whether to enable extended storage sizes for the specified project.

isNativeRerankingEnabledboolean

Flag that indicates whether to enable Native Reranking with Voyage AI models in the Aggregation Pipeline for the specified project.

isPerformanceAdvisorEnabledboolean

Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project.

isRealtimePerformancePanelEnabledboolean

Flag that indicates whether to enable the Real Time Performance Panel for the specified project.

isSchemaAdvisorEnabledboolean

Flag that indicates whether to enable the Schema Advisor for the specified project.

Response

OK

Changes

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