Page tree
Skip to end of metadata
Go to start of metadata

API Essentials

API Key Generation

Autoscaling

Backups

Credit

DNS

Firewall Rules

Flex Cloud VM Control

Getting Started with Superb Flex Cloud

IP Addresses

Logs

Network Interfaces

Recipes

SSH Keys

Templates

Test Route

Troubleshooting API Issues

Viewing Activity Logs

Virtual Server Operating Systems

Virtual Servers

VS Disks

POST /recipes/:recipe_id/run 

Runs recipe on specified virtual machines

Sections:

Request Parameters

vm1_identifier - replace this with the identifier of a virtual server you want to run the recipe on.

When applying one recipe to several servers via API, there is possibility to run the recipe incompatible with the server type (Unix recipe on Windows server or vice versa). In this case the transaction will be scheduled and completed, but the recipe will not do anything.

Response Parameters

207 Multi-status is returned along with an array indicating the status of the individual requests

JSON Request example

 curl -i -X POST -H 'Accept: application/json' -H 'Content-type: application/json' -u user:password -d '{"virtual_machines":[":vm1_identifier",":vm2_identifier"]}' --url <api_url>/recipes/:recipe_id/run.json

JSON Response

 [{"virtual_machine":{"identifier":"x7fn5k7i5bhxn","run_recipe_status":"scheduled"}},{"virtual_machine":{"identifier":"yu6rqyii0p5u9","run_recipe_status":"failed"}}]

XML Request example

 curl -i -X POST -H 'Accept: application/xml' -H 'Content-type:application/xml' -u user:userpass -d '<virtual_machines type="array"><virtual_machine>vm1_identifier</virtual_machine><virtual_machine>vm2_identifier</virtual_machine></virtual_machines>'  --url <api_url>/recipes/:recipe_id/run.xml
  • No labels