Get Recipe Steps

GET /recipes/:recipe_id/recipe_steps

Gets a list of recipe steps for specified recipe

Sections:

Response Parameters

compatible_with - recipe compatibility: windows or unix

created_at — the date when the recipe was created in the [YYYY][MM][DD]T[hh][mm][ss]Z format

description - recipe description

id - recipe ID

label - recipe label

script_type - script type for Windows-compatible recipes:

• bat 
• vbs 
• powershell (PowerShell v1.0)

updated_at — the date when the recipe was updated in the [YYYY][MM][DD]T[hh][mm][ss]Z format

use_on_hv_zones - true, if the recipe can be used on hypervisor zones, otherwise false

use_on_vms - true, if the recipe can be used on virtual servers, otherwise false

user_id — the ID of a recipe owner

recipe_steps - an array of recipe steps with the following details:

• created_at — the date when the step was created in the [YYYY][MM][DD]T[hh][mm][ss]Z format

• updated_at — the date when the step was updated in the [YYYY][MM][DD]T[hh][mm][ss]Z format

• fail_anything_else - set true, if you have specified the recipe pass value, otherwise set false
• fail_values - recipe fail value

• failure_goto_step - if the on_failure parameter = go to step, specify the step to proceed to. If you specify the nonexistent step, the recipe will be stopped.

• id - step ID

• number - step number

• on_failure - step behavior in case of failure:

  • proceed - proceed to the next step.
  • fail - terminate the recipe and mark it as failed.
  • stop - terminate the recipe and mark it as successful.
  • go_to_step - specify the step to proceed to. If you specify the nonexistent step, the recipe will be stopped.
    
    

• on_success - step behavior in case of success:

  • proceed - proceed to the next step.
  • fail - terminate the recipe and mark it as failed.
  • stop - terminate the recipe and mark it as successful.
  • go_to_step - specify the step to proceed to. If you specify the nonexistent step, the recipe will be stopped.
    
    

• pass_anything_else -  set true, if you have specified the recipe fail value, otherwise set false

• pass_values - recipe pass value

• recipe_id - ID of a recipe the step belongs to

• result_source - step result source:

  • exit_code - an exit status, e.g. 0 will be returned on success

  • std_out - standard output
  • std_err - standard error
  • std_out_and_std_err - standard output and standard error

• success_goto_step - if the on_success parameter = go to step, specify the step to proceed to. If you specify the nonexistent step, the recipe will be stopped.

JSON Request example

 curl -i -X GET -u user:userpass <api_url>/recipes/:recipe_id/recipe_steps.json -H 'Accept: application/json' -H 'Content-type: application/json'

XML Request example

 curl -i -X GET -u user:userpass <api_url>/recipes/:recipe_id/recipe_steps.xml -H 'Accept: application/xml' -H 'Content-type: application/xml'