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
`auth_token`	String	Yes	A valid `auth_token` returned from the `authenticate` request. Alternatively, basic authenticate headers can be used in place of this parameter. See the authenticate endpoint for more information and usage examples.
`name`	String	Yes	Name of the Cookbook that you want to update.
`description`	String	No	Description of the Cookbook.
`process_output_of`	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.si
`cluster_by`	String	No	Determines Cookbook's clustering behavior. Set to `first_match` so that Cookbook adds alerts to the first cluster over the similarity threshold value. Set to `closest_match` to add alerts to the cluster with the highest similarity greater than the similarity threshold value. This option may be less efficient because Cookbook needs to compare alerts against each cluster in a Recipe. If you set a different `cluster_by` value for a Recipe, it overrides the Cookbook value. Recipes without a `cluster_by` value inherit the value from the Cookbook.
`entropy_threshold`	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.
`threshold_type`	String	No	Type of entropy threshold you want Cookbook to use. One of: `global`: Use the global entropy threshold. This is a single entropy threshold that Cookbook applies to all alerts to eliminate noisy alerts with a lower entropy value. `manager`: Use entropy thresholds set up for individual managers. If the manager for an alert has an entropy threshold set, Cookbook uses this value to eliminate noisy alerts with a lower entropy value. If an alert's manager does not have an entropy threshold, Cookbook uses the global entropy threshold to filter out alerts. `explicit_value`: Use the value set in `entropy_threshold` to eliminate noisy alerts with a lower entropy value. `none`: Do not use entropy thresholds. Cookbook will not filter out any alerts based on their entropy value. If you do not specify an entropy threshold, the default is global. The default global entropy threshold is 0. This means that unless you actively set up a global threshold, Cookbook will not filter out any alerts based on entropy values. See Configure Entropy Thresholds with Alert Analyzer for more information on setting global and manager-specific entropy thresholds.
`cook_for`	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 `cook_for` time for a Recipe, it overrides the Cookbook value. Recipes without a `cook_for` time inherit the value from the Cookbook.
`cook_for_extension`	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 `max_cook_for` period is reached. Used in conjunction with the `max_cook_for` value, the `cook_for_extension` period helps to ensure that Cookbook continues to cluster alerts together that are related to the same failure. The `cook_for_extension` period only applies to new related alerts; it does not apply to existing alerts that are updated with new events. See Cookbook and Recipe Examples for more information. If you set a different `cook_for_extension` time for a Recipe, it overrides the Cookbook value. Recipes without a `cook_for_extension` time inherit the value from the Cookbook.
`max_cook_for`	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 `cook_for_extension` time to help ensure that Cookbook continues to cluster alerts together that are related to the same failure. This value is ignored unless the `cook_for_extension` time is specified. If `cook_for_extension` is set and this value is not set, the default is three times the `cook_for` value. See Cookbook and Recipe Examples for more information. If you set a different `max_cook_for` time for a Recipe, it overrides the Cookbook value. Recipes without a `max_cook_for` value inherit the value from the Cookbook.
`scale_by_severity`	Boolean	No	Determines whether Cookbook ignores alerts with a severity of 0 (Clear). Set to `true` if you want Cookbook to ignore alerts with a severity of 0 (Clear). Set to `false` if you want Cookbook to include alerts with a severity of 0 (Clear).
`first_recipe_match_only`	Boolean	No	Defines whether Cookbook treats Recipes in priority order. If set to `true`, Cookbook adds an alert to a cluster created by the highest priority Recipe that meets the clustering criteria. The priority order is defined by the order of the Recipes in the `recipes` list. If set to `false`, Cookbook adds an alert to clusters in all the Recipes that meet the clustering criteria.
`recipes`	Array of Strings	No	A list of the Recipes in this Cookbook. You must supply at least one Recipe. If you set `first_recipe_match_only` to `first_match`, Cookbook uses the order of the Recipes in this list to determine their priority. The first Recipe has the highest priority.
`run_on_startup`	Boolean	No	Whether Cookbook should start when Moogfarmd starts.
`moobot`	String	No	The Moobot you want Cookbook to use if there are any Bot Recipes. See Recipe Types for more information.Recipe Types

Response

Endpoint updateCookbook returns the following response:

Type	Description
HTTP Code	HTTP status or error code indicating request success or failure. See HTTP status code definitions for more information.

This endpoint returns an error code if the values of entropy_threshold and threshold_type are inconsistent. For example, if the entropy_threshold is set to 0.4 and threshold_type is set to global.

Examples

The following examples demonstrate typical use of endpoint updateCookbook:

Request examples

Example cURL request to update the run_on_startup and cook for auto-extension arguments for 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 \
}'

Example cURL request to update Cookbook 'Default Cookbook' to use entropy thresholds set up for individual managers:

curl -X POST -u graze:graze -k -v "https://localhost/graze/v1/updateCookbook" -H "Content-Type: application/json; charset=UTF-8" -d \
'{ \
"name" : "Default Cookbook", \
"threshold_type": "manager" \
}'

Example cURL request to update Cookbook 'GrazeCookbook1' to use an explicit entropy threshold for this Cookbook of 0.15:

curl -X POST -u graze:graze -k -v "https://localhost/graze/v1/updateCookbook" -H "Content-Type: application/json; charset=UTF-8" -d \
'{ \
"name" : "Default Cookbook", \
"entropy_threshold": 0.15, \
"threshold_type": "explicit_value" \
}'

Response example

In this section: