Get the details of a specific recipe.
A recipe is a process, or processes, which performs a task; in this case, that task is deprovisioning. When the API returns a recipe, it gives the id and status information about that process and its current status. The recipe runs asynchronously and this endpoint allows applications to poll for the current status of any recipe.
Returned JSON
Key | Description |
|---|---|
id | The recipe id - it should be the same as the id in the request parameter. |
template | A reference name for the recipe being performed. This is configured by Compose engineering. |
status | The status of this recipe. It can be |
status_details | A descriptive string which provides further details of the current status, designed to be shown to the user. |
account_id | The id of the account associated with the running of this recipe. |
deployment_id | The id of the deployment that this recipe is working on. Recipes work on a single deployment. |
parent_id | The id of this recipe's parent, if this recipe is a sub-recipe. |
name | A short descriptive name of the recipe's purpose. |
recipes[] | An array of recipe objects, like this one, if the recipe has sub-recipes. |
created_at | Date & time when the recipe was created (ISO8601 format) |
updated_at | Date & time when the recipe was last updated (ISO8601 format) |
operations_complete | The number of recipe operations that have been completed (see below). |
operations_total | The total number of operations that this recipe will run (see below). |
Recipe Operations
Operations are the discrete steps that take place in the process of completing a recipe. Each operation will increment the operations_complete field and may update the status_detail field as it is run. The total number of expected operations to be run for completion of the recipe is available in operations_total.
These values, operations_complete and operations_total can be used as an approximate indicator of progress but note that completion of a recipe is only realized when the status field shows completed.
This is because sub-recipes may be included in the recipe. A recipes' sub-recipes will each have their own operations_complete and operations_total. Only when all sub-recipes are also complete - and the parent recipe has run all its operations - will the parent recipe be labelled as complete.