addCookbook
A Graze API POST request that creates a new Cookbook.
Back to Graze API EndPoint Reference.
Request arguments
Endpoint addCookbook
takes the following request arguments:
Name |
Type |
Required |
Description |
---|---|---|---|
|
String |
Yes |
A valid |
|
String |
Yes |
Name of the Cookbook. Must be unique. |
|
List of Strings |
Yes |
A list of the Recipes in this Cookbook. You must supply at least one Recipe. If you set
|
|
String |
No |
Description of the Cookbook. |
|
List of Strings |
Yes |
Defines the source of the alerts that Cookbook processes. You can specify one or
multiple Moolets. Valid values are: |
|
Boolean |
No |
Whether Cookbook should start when Moogfarmd starts. Default is |
|
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. Default is 0.0 which means that Cookbook processes all alerts. |
|
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. Default is 3600 seconds (1 hour). 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. Default is |
Response
Endpoint addCookbook
returns the following response:
Examples
The following examples demonstrate typical use of endpoint addCookbook
:
Request example
Example cURL request to create a new Cookbook "GrazeCookBook1":
curl -X POST -u graze:graze -k -v "https://localhost/graze/v1/addCookbook" -H "Content-Type: application/json; charset=UTF-8" -d '{"name": "GrazeCookBook1", "process_output_of": ["Alert Workflows"], "recipes": ["Description","Source"], "run_on_startup":false, "first_recipe_match_only":true}'