Get Virtualizor

Edit Recipe

Use the Edit Recipe API to update a recipe present on the Virtualizor panel. Recipes are predefined bash scripts that are created by admin for endusers. Only the activated recipes are visible to the enduser. These recipes can be executed on the VPS during their creation. Recipes can also be applied while the VPS is running, however you need to stop then start the VPS for the execution of the recipe to take place. The API response will contain "done" as "1" if the recipe has been successfully updated.

HTTP Request



actGETeditrecipeThe action will return done as 1 after the recipes has been editedYes
ridGETIntThe recipe IDYes
namePOSTtextThe name of the recipeYes
codePOSTtextThe code that will be executed by the recipe at the time of callYes
descPOSTtextThe description for the recipeNo
logoPOSTtextThe logo url for the recipeNo
shellPOSTtextProvide the shell type using which the recipe should be executed (Since 3.1.3 version)

Valid shell types (Since v3.1.3)

Value Description
Default(sh shell) #!/bin/sh
Bash #!/bin/bash
Ksh #!/bin/ksh
Zsh #!/bin/zsh

Sample Code



    $key =  'your_api_key';
    $pass = 'your_api_pass';
    $ip = 'your_server_ip';

    $admin = new Virtualizor_Admin_API($ip, $key, $pass);

    $post = array();
    $post['rid'] = 23;
    $post['name'] = 'test_recipe1';
    $post['code'] = 'This is your test recipe';
    $post['desc'] = 'This is the description for test recipe';
$post['shell'] = 'Bash'; $output = $admin->editrecipe($post); print_r(json_encode($output)); ?>


    "title": "Edit Recipe",
    "done": 1,
    "done_msg": "Recipe has been updated",
    "timenow": 1536159013,
    "time_taken": "0.204"
    Was this page helpful?
    Newsletter Subscription
    Subscribing you to the mailing list