Deploy a deployment draft

POST /groups/{groupId}/apps/{appId}/drafts/{draftId}/deployment

Deploy the specified application deployment draft.

Path parameters

application/json

Body

  • name string Required

    The name of the deployment. To deploy a draft without a name, use an empty string.

Responses

  • 201 application/json

    The draft was successfully deployed.

    Hide response attributes Show response attributes object
    • _id string

      The unique ID of the deployment.

    • name string

      The name of the deployment. By default, this is the same value as _id.

    • app_id string

      The unique _id value of the Atlas App Services App.

    • draft_id string

      The unique _id value of the deployment draft associated with the deployment, if applicable.

    • user_id string

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

    • deployed_at integer

      The time at which the deployment was made. Represented as the number of seconds since January 1, 1970.

    • origin string

      The deployment method used to create the deployment.

    • commit string

      The commit hash of the deployment (Automatic GitHub Deployment)

    • status string

      A message that indicates whether or not the deployment was successful.

    • status_error_message string

      The error message of the error that caused the deployment to fail, if applicable.

    • diff_url string

      A link to the diff of changes in the deployment

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

POST /groups/{groupId}/apps/{appId}/drafts/{draftId}/deployment
curl \
 --request POST 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/drafts/{draftId}/deployment' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name":"string"}'
Request examples
{
  "name": "string"
}
Response examples (201)
{
  "_id": "string",
  "name": "string",
  "app_id": "string",
  "draft_id": "string",
  "user_id": "string",
  "deployed_at": 42,
  "origin": "string",
  "commit": "string",
  "status": "string",
  "status_error_message": "string",
  "diff_url": "string",
  "remote_location": "US-VA"
}