Start a new Deployment.

POST {{baseUrl}}/orgs/:orgId/apps/:appId/envs/:envId/deploys

At Humanitec, Deployments are defined as changes to the state of the Environment. The state can be changed by defining a set of desired changes to the current state via a Deployment Delta or by resetting the current state after a previous Deployment. (See Environment Rebase.) Both types of changes can be combined into a single Deployment during which the Delta is applied to the Rebased state.

When specifying a Delta, a Delta ID must be used. That Delta must have been committed to the Delta store prior to the Deployment.

A Set ID can also be defined in the deployment to force the state of the environment to a particular state. This will be ignored if the Delta is specified.

NOTE:

Directly setting a set_id in a deployment is not recommended as it will not record history of where the set came from. If the intention is to replicate an existing environment, use the environment rebasing approach described above.

Request Body

{"comment"=>"Updated version of module-one to v0.3.1", "delta_id"=>"df1ad41807b0390a9b0eaf8688e1f5baece9d764"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: Created

{"comment":"Updated version of module-one to v0.3.1","created_at":"2020-05-22T14:58:07Z","created_by":"a.user@example.com","delta_id":"df1ad41807b0390a9b0eaf8688e1f5baece9d764","env_id":"my-env","from_id":"42d4b302fd3c","status":"in progress","status_changed_at":"2020-05-22T14:59:01Z"}