Update One Serverless Instance in One Project
Updates one serverless instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role.
This API can also be used on Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset in January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect on these clusters. Please use the updateFlexCluster endpoint instead.
Path parameters
-
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.
Format should match the following pattern:
^([a-f0-9]{24})$. -
Human-readable label that identifies the serverless instance.
Format should match the following pattern:
^[a-zA-Z0-9][a-zA-Z0-9-]*$.
Query parameters
-
Flag that indicates whether Application wraps the response in an
envelopeJSON 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.Default value is
false. -
Flag that indicates whether the response body should be in the prettyprint format.
Default value is
false.Prettyprint
Body Required
Update One Serverless Instance in One Project.
-
Group of settings that configure serverless backup.
-
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 tofalse, MongoDB Cloud will delete the serverless instance.Default value is
false.
curl \ --request PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/serverless/{name}' \ --header "Authorization: Bearer $ACCESS_TOKEN" \ --header "Content-Type: application/json" \ --data '{"serverlessBackupOptions":{"serverlessContinuousBackupEnabled":true},"tags":[{"key":"string","value":"string"}],"terminationProtectionEnabled":false}'{ "serverlessBackupOptions": { "serverlessContinuousBackupEnabled": true }, "tags": [ { "key": "string", "value": "string" } ], "terminationProtectionEnabled": false }{ "connectionStrings": { "privateEndpoint": [ { "endpoints": [ { "endpointId": "string", "providerName": "AWS", "region": "string" } ], "srvConnectionString": "string", "type": "MONGOS" } ], "standardSrv": "string" }, "createDate": "2025-05-04T09:42:00Z", "groupId": "32b6e34b3d91647abb20e7b8", "id": "32b6e34b3d91647abb20e7b8", "links": [ { "href": "https://cloud.mongodb.com/api/atlas", "rel": "self" } ], "mongoDBVersion": "string", "name": "string", "providerSettings": { "backingProviderName": "AWS", "effectiveDiskSizeGBLimit": 42, "": "M10", "effectiveProviderName": "string", "providerName": "SERVERLESS", "regionName": "string" }, "serverlessBackupOptions": { "serverlessContinuousBackupEnabled": true }, "stateName": "IDLE", "tags": [ { "key": "string", "value": "string" } ], "terminationProtectionEnabled": false }{ "error": 400, "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.", "reason": "Bad Request", "errorCode": "VALIDATION_ERROR" }{ "error": 401, "detail": "(This is just an example, the exception may not be related to this endpoint)", "reason": "Unauthorized", "errorCode": "NOT_ORG_GROUP_CREATOR" }{ "error": 402, "detail": "(This is just an example, the exception may not be related to this endpoint)", "reason": "Payment Required", "errorCode": "NO_PAYMENT_INFORMATION_FOUND" }{ "error": 403, "detail": "(This is just an example, the exception may not be related to this endpoint)", "reason": "Forbidden", "errorCode": "CANNOT_CHANGE_GROUP_NAME" }{ "error": 404, "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS", "reason": "Not Found", "errorCode": "RESOURCE_NOT_FOUND" }{ "error": 409, "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554", "reason": "Conflict", "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK" }