Get a Deployment Migration

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

Get metadata and status for the current deployment migration, if one exists.

Path parameters

Responses

  • 200 application/json

    Ok

    Hide response attributes Show response attributes object
    • status string

      Values are started, downtime, enabling_event_subscriptions, cleanup, successful, or failed.

    • message string

      A description of the current migration status.

    • updated_at string

      A timestamp of the most recent update to the deployment migration.

    • from object
      Hide from attributes Show from attributes object
      • 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.

    • to object
      Hide to attributes Show to attributes object
      • 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.
  • 404

    App not found

GET /groups/{groupId}/apps/{appId}/deployment_migration 
curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/deployment_migration' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "status": "started",
  "message": "string",
  "updated_at": "string",
  "from": {
    "deployment_model": "GLOBAL",
    "": "aws-us-east-1"
  },
  "to": {
    "deployment_model": "GLOBAL",
    "": "aws-us-east-1"
  }
}