/2016-07/deployments/:id/versions

Upgrades a deployment's software to a newer version.

Key

Description

id

ID of the recipe for the deployment upgrade job.

account_id

ID of the account that owns the deployment.

template

Template of the recipe that is being run.

status

Current status of the recipe.

status_detail

Further details about the recipe status.

created_at

Date and time when the recipe job started (ISO8601 format).

updated_at

Date and time when the recipe job was last updated (ISO8601 format).

deployment_id

ID of the deployment that is being upgraded.

name

Name of the recipe that is being run.

Will respond with information about the upgrade recipe that is being run.

A Recipe is a process, or processes, which performs a task; in this case, that task is upgrading. When the API returns a recipe, it gives the id and status information about that process and its current status. The recipe runs asynchronously.

By querying the recipe endpoint - /2016-07/recipes/:id with the returned id, you can get updates on the status of the task being performed. Completetion is denoted by the status field being returned as completed.

Language
Authentication
Header
Click Try It! to start a request and see the response here!