getCookbooks
A Graze API GET request that returns all the Cookbooks in Moogsoft Onprem.
Back to Graze API EndPoint Reference.
Request arguments
Endpoint getCookbooks
takes the following request argument:
Endpoint getCookbooks
takes no other arguments because this endpoint returns data on all Cookbooks in Moogsoft Onprem.
Response
Endpoint getCookbooks
returns the following response:
Successful requests return an array of JSON objects containing the following:
Type | Description |
---|---|
List of JSON Objects | A list of all the Cookbooks in Moogsoft Onprem and all their details. |
Examples
The following examples demonstrate typical use of endpoint getCookbooks
:
Request example
Example cURL request to return all the Cookbooks in Moogsoft Onprem:
curl -X GET -u graze:graze -k -v "https://localhost/graze/v1/getCookbooks"
Response example
Example response returning the details of all Cookbooks in Moogsoft Onprem:
[ { "name": "Default Cookbook", "classname": "CCookbook", "metric_path_moolet": true, "description": null, "run_on_startup": true, "process_output_of": [ "MaintenanceWindowManager" ], "id": 1, "scale_by_severity": false, "entropy_threshold": 0.0, "first_recipe_match_only": true, "cluster_by": "first_match", "cook_for": 900, "cook_for_extension": 0, "max_cook_for": null, "moobot": "Cookbook.js", "recipes": [ "Criticals", "Description", "Source" ], "threshold_type": "global" }, { "name": "BotCookBook1", "classname": "CCookbook", "metric_path_moolet": true, "description": null, "run_on_startup": true, "process_output_of": [ "Alert Workflows" ], "id": 2, "scale_by_severity": false, "entropy_threshold": 0.25, "first_recipe_match_only": false, "cluster_by": "first_match", "cook_for": 3600, "cook_for_extension": 0, "max_cook_for": 0, "moobot": "Cookbook.js", "recipes": [ "BotRecipe1", "BotRecipe2" ], "threshold_type": "explicit_value" }, { "name": "GrazeCookbook3", "classname": "CCookbook", "metric_path_moolet": true, "description": null, "run_on_startup": true, "process_output_of": [ "Alert Workflows" ], "id": 3, "scale_by_severity": false, "entropy_threshold": 0.22, "first_recipe_match_only": false, "cluster_by": "first_match", "cook_for": 3600, "cook_for_extension": 0, "max_cook_for": 0, "moobot": "Cookbook.js", "recipes": [ "GrazeRecipe1", "GrazeRecipe2", "GrazeRecipe3" ], "threshold_type": "explicit_value" } ]