Moogsoft Docs

getRecipes

A Graze API GET request that returns all the Recipes in Moogsoft AIOps.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint getRecipes takes the following request arguments:

Name

Type

Required

Description

auth_token

String

Yes

A valid auth_token returned from the authenticate request. See the authenticate endpoint for more information.

cookbook

String

No

Name of the Cookbook that you want to return the Recipes for. Do not specify to return all Recipes.

Response

Endpoint getRecipes 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 AIOps and all their details.

Examples

The following examples demonstrate typical use of endpoint getRecipes:

Request example

Example cURL request to return all the Recipes in Moogsoft AIOps:

curl -X GET -u graze:graze -k -v "https://localhost/graze/v1/getRecipes"

Response example

Example response returning all the Recipes in Moogsoft AIOps:

[
    {
        "seed_alert_filter": "{}",
        "chef": "CValueRecipeV2",
        "description": "Alerts with a similar description",
        "recipe_alert_threshold": 2,
        "matcher": {
            "components": [
                {
                    "similarity": 1,
                    "name": "agent",
                    "shingle_size": -1
                },
                {
                    "similarity": 0.75,
                    "name": "description",
                    "shingle_size": -1
                }
            ]
        },
        "exclusion_filter": "{}",
        "cook_for": null,
        "max_sample_size": 10,
        "rate": 0,
        "min_sample_size": 5,
        "cook_for_extension": 0,
        "name": "Description",
        "trigger_filter": "{ \"column\": \"severity\", \"op\": 5, \"value\": 3, \"type\": \"LEAF\" }",
        "cookbooks": [
            "Default Cookbook"
        ]
    },
    {
        "seed_alert_filter": "{}",
        "chef": "CValueRecipeV2",
        "description": "Alerts from a similar source",
        "recipe_alert_threshold": 2,
        "matcher": {
            "components": [
                {
                    "similarity": 1,
                    "name": "agent",
                    "shingle_size": -1
                },
                {
                    "similarity": 0.75,
                    "name": "source",
                    "shingle_size": 3
                }
            ]
        },
        "exclusion_filter": "{}",
        "cook_for": null,
        "max_sample_size": 10,
        "rate": 0,
        "min_sample_size": 5,
        "cook_for_extension": 0,
        "name": "Source",
        "trigger_filter": "{ \"column\": \"severity\", \"op\": 5, \"value\": 3, \"type\": \"LEAF\" }",
        "cookbooks": [
            "Default Cookbook"
        ]
    },
    {
        "seed_alert_filter": "{}",
        "chef": "CValueRecipeV2",
        "description": "Remaining critical alerts",
        "recipe_alert_threshold": 1,
        "matcher": {
            "components": [
                {
                    "similarity": 1,
                    "name": "agent",
                    "shingle_size": -1
                },
                {
                    "similarity": 0.75,
                    "name": "source",
                    "shingle_size": 3
                }
            ]
        },
        "exclusion_filter": "{}",
        "cook_for": null,
        "max_sample_size": 10,
        "rate": 0,
        "min_sample_size": 5,
        "cook_for_extension": 0,
        "name": "Criticals",
        "trigger_filter": "{ \"column\": \"severity\", \"op\": 0, \"value\": 5, \"type\": \"LEAF\" }",
        "cookbooks": [
            "Default Cookbook"
        ]
    }
]