Create a Deployment Draft

POST /groups/{groupId}/apps/{appId}/drafts
Token auth

Create a new application deployment draft, if none exists.

Path parameters

Responses

  • 201 application/json

    Successfully created draft.

    Hide response attributes Show response attributes object
    • _id string

      The unique ID of the draft.

    • user_id string

      The unique _id value of the MongoDB Cloud user that created the draft.

    • app object

      A specific, existing application.

      Hide app attributes Show app attributes object
      • name string

        The name of the application. Must begin with a letter and may only contain ASCII letters, numbers, underscores, and hyphens.

      • 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.

      • location string

        An identifier of the location where an app server is physically deployed to, regardless of the cloud provider that hosts the app.

        Values are US-VA, US-OR, DE-FF, IE, AU, IN-MB, SG, or BR-SP.

      • deployment_model string

        An application deployment model.

        Values are GLOBAL or LOCAL.

      • The application's environment.

        Values are development, testing, qa, or production.

      • _id string

        The application's unique internal ID.

      • client_app_id string

        The application's public App ID.

      • domain_id string

        The application's associated domain ID.

      • group_id string

        The application's Atlas Project/Group ID.

      • last_used integer

        The time this app was last used in UNIX time (i.e. the number of seconds since Jan 1, 1970).

      • last_modified integer

        The time this app was last modified in UNIX time (i.e. the number of seconds since Jan 1, 1970).

      • product string

        The product this app is for.

        Values are standard, atlas, data-api, or device-sync.
  • 409 application/json

    Draft already exists

    Hide response attributes Show response attributes object
    • error string

      A message that describes the error.

    • error_code string

      The error type.
POST /groups/{groupId}/apps/{appId}/drafts 
curl \
 --request POST 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/drafts' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (201) 
{
  "_id": "string",
  "user_id": "string",
  "app": {
    "name": "MyApp",
    "provider_region": "aws-us-east-1",
    "location": "US-VA",
    "deployment_model": "GLOBAL",
    "": "production",
    "_id": "633209ffd3bd3478005d1bac",
    "client_app_id": "myapp-abcde",
    "domain_id": "63320a2b5f9de9a6e0a213e8",
    "group_id": "5b2ec991973129243223a114",
    "last_used": 1664224746,
    "last_modified": 1656440824,
    "product": "standard"
  }
}
Response examples (409) 
{
  "error": "string",
  "error_code": "string"
}