updateCookbook
A Graze API POST request that updates a Cookbook.
If you change a Cookbook, see Cookbook Configuration Changes for information on how these changes affect the clusters that Cookbook creates.
Back to Graze API EndPoint Reference.
Request arguments
Endpoint updateCookbook
takes the following request arguments. You must
supply the name of the Cookbook plus at least one other argument that you want to change.
Name |
Type |
Required |
Description |
---|---|---|---|
|
String |
Yes |
A valid |
|
String |
Yes |
Name of the Cookbook that you want to update. |
|
Array of Strings |
No |
A list of the Recipes in this Cookbook. You must supply at least one Recipe. If you set
|
|
String |
No |
Description of the Cookbook. |
|
Array of Strings |
No |
Defines the source of the alerts that Cookbook processes. You can specify none, one or more Moolets. Typically Cookbook processes the output of its direct upstream neighbor in the processing chain. Usually this is "Alert Workflows" which are the output from the Alert Workflow Engine. See Data Processing Flow for the Moolet processing chain diagram. |
|
Boolean |
No |
Whether Cookbook should start when Moogfarmd starts. |
|
Boolean |
No |
Determines whether Cookbook ignores alerts with a severity of 0 (Clear). Set to |
|
Number |
No |
Minimum entropy value an alert must have in order for Cookbook to consider it for clustering it into a Situation. Cookbook does not include any alerts with an entropy value below the threshold in Situations. |
|
Boolean |
No |
Defines whether Cookbook treats Recipes in priority order. If set to |
|
String |
No |
Determines Cookbook's clustering behavior. Set to If you set a different |
|
Integer |
No |
Minimum time period, in seconds, that Cookbook clusters alerts for before the Recipe resets and starts a new cluster. See Cookbook and Recipe Examples for more information. If you set a different |
|
Integer |
No |
Time period that Cookbook can extend clustering alerts for before the Recipe resets and
starts a new cluster. Setting this value enables the cook for auto-extension feature for
this Cookbook. As Cookbook receives related alerts, it continues to extend the total
clustering time until the If you set a different |
|
Integer |
No |
Maximum time period that Cookbook clusters alerts for before the Recipe resets and
starts a new cluster. It works in conjunction with the If you set a different |
|
String |
No |
The Moobot you want Cookbook to use if there are any Bot Recipes. See Recipe Types for more information. |
Response
Endpoint updateCookbook
returns the following response:
Examples
The following examples demonstrate typical use of endpoint updateCookbook
:
Request example
Example cURL request to update Cookbook "GrazeCookBook1":
curl -X POST -u graze:graze -k -v "https://localhost/graze/v1/updateCookbook" -H "Content-Type: application/json; charset=UTF-8" -d '{"name" : "GrazeCookBook1", "run_on_startup":true, "cook_for_extension":7200, "max_cook_for":14400}'