Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Children Display
alltrue
styleh3
pageSuperb Cloud API

PUT /recipes/:recipe_id 

Edits specified recipe

Sections:

Table of Contents
maxLevel4
minLevel2
includeResponse.*|JSON.*|XML.*

Request Parameters

label - recipe label

description - recipe description

compatible_with - recipe compatibility: windows or unix

script_type - script type for Windows-compatible recipes:

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

This parameter is for Windows recipes only.

Response Parameters

Info

204 status returned on success.

JSON Request example

Code Block
languagebash
themeRDark
 curl -i -X PUT -u user:userpass <api_url>/recipes/:recipe_id.json -d '{"recipe":{"label":"New Label","description":"New Description","compatible_with":"windows","script_type":"bat"}}' -H 'Accept: application/json' -H 'Content-type: application/json'

JSON Response

Code Block
 

XML Request example

Code Block
languagebash
themeRDark
 curl -i -X PUT -u user:userpass <api_url>/recipes/:recipe_id.xml -d '<recipe><label>New Label</label><description>New description</description><compatible_with>windows</compatible_with><script_type>bat</script_type></recipe>' -H 'Accept: application/xml' -H 'Content-type: application/xml'

XML Response example

Code Block
languagexml