MOmongodb
Clusters

Upgrade One Shared-Tier Cluster to One Serverless Instance

This endpoint has been deprecated as of February 2025 as we no longer support the creation of new serverless instances. Please use the Upgrade Flex Cluster endpoint to upgrade Flex clusters.

Upgrades a shared-tier cluster to a serverless instance in the specified project.

post/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless
  • 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

createDatestring date-time

Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.

groupIdstring

Unique 24-hexadecimal character string that identifies the project.

idstring

Unique 24-hexadecimal digit string that identifies the serverless instance.

mongoDBVersionstring

Version of MongoDB that the serverless instance runs.

namestring

Human-readable label that identifies the serverless instance.

providerSettingsServerlessProviderSettings required(unresolved $ref)
stateName'IDLE' | 'CREATING' | 'UPDATING' | 'DELETING' | 'REPAIRING'

Human-readable label that indicates any current activity being taken on this cluster by the Atlas control plane. With the exception of CREATING and DELETING states, clusters should always be available and have a Primary node even when in states indicating ongoing activity.

  • IDLE: Atlas is making no changes to this cluster and all changes requested via the UI or API can be assumed to have been applied.
  • CREATING: A cluster being provisioned for the very first time returns state CREATING until it is ready for connections. Ensure IP Access List and DB Users are configured before attempting to connect.
  • UPDATING: A change requested via the UI, API, AutoScaling, or other scheduled activity is taking place.
  • DELETING: The cluster is in the process of deletion and will soon be deleted.
  • REPAIRING: One or more nodes in the cluster are being returned to service by the Atlas control plane. Other nodes should continue to provide service as normal.
terminationProtectionEnabledboolean

Flag that indicates whether termination protection is enabled on the serverless instance. If set to true, MongoDB Cloud won't delete the serverless instance. If set to false, MongoDB Cloud will delete the serverless instance.

Response

OK

Changes

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