Create a Deployment Migration

PUT /groups/{groupId}/apps/{appId}/deployment_migration
Token auth

Start a new deployment migration.

Path parameters

application/json

Body Required

The deployment model and cloud provider region that the App should migrate to.

  • deployment_model string

    An application deployment model.

    Values are GLOBAL or LOCAL.

  • provider_region string

    One of:
    AwsDeploymentRegion string AzureDeploymentRegion string GcpDeploymentRegion string

    Values are aws-us-east-1, aws-us-west-2, aws-us-east-2, aws-eu-central-1, aws-eu-west-1, aws-eu-west-2, aws-ap-southeast-1, aws-ap-southeast-2, aws-ap-south-1, or aws-sa-east-1.

    Values are azure-eastus2, azure-westus, azure-westeurope, azure-eastasia, or azure-southeastasia.

    Values are gcp-us-central1, gcp-us-east4, gcp-us-west1, gcp-europe-west1, or gcp-asia-south1.

Responses

  • 204

    Migration started

  • 400

    Request is invalid, incomplete, or a no-op

  • 404

    App not found

PUT /groups/{groupId}/apps/{appId}/deployment_migration 
curl \
 --request PUT 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/deployment_migration' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"provider_region":"aws-us-east-1","deployment_model":"LOCAL"}'
Request example 
{
  "provider_region": "aws-us-east-1",
  "deployment_model": "LOCAL"
}