deploy

Deploy a deployment draft

Changed on

Deploy the specified application deployment draft.

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

Request

  • Base URL
    https://services.cloud.mongodb.com/api/admin/v3.0
  • URL
    https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/drafts/{draftId}/deployment
  • Auth
    HTTP bearer

Request body

namestring required

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

Response

The draft was successfully deployed.

_idstring

The unique ID of the deployment.

namestring

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

app_idstring

The unique _id value of the Atlas App Services App.

draft_idstring

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

user_idstring

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

deployed_atinteger

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

originstring

The deployment method used to create the deployment.

commitstring

The commit hash of the deployment (Automatic GitHub Deployment)

statusstring

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

status_error_messagestring

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

diff_urlstring

A link to the diff of changes in the deployment

remote_location'US-VA' | 'US-OR' | 'DE-FF' | 'IE' | 'AU' | 'IN-MB' | 'SG' | 'BR-SP'

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

Changes