Moogsoft Docs

getCookbooks

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

Back to Graze API EndPoint Reference.

Request arguments

Endpoint getCookbooks 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.

There are no other arguments because this endpoint returns data on all Cookbooks in Moogsoft AIOps.

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 AIOps 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 AIOps:

curl -X GET -u graze:graze -k -v "https://localhost/graze/v1/getCookbooks"
Response example

Example response returning the details of the "Default Cookbook":

[
    {
        "recipes": [
            "Description",
            "Source",
            "Criticals"
        ],
        "run_on_startup": null,
        "description": "",
        "moobot": "Cookbook.js",
        "cluster_by": null,
        "cook_for": 900,
        "first_recipe_match_only": true,
        "max_cook_for": null,
        "cook_for_extension": null,
        "name": "Default Cookbook",
        "entropy_threshold": 0,
        "process_output_of": "Alert Workflows",
        "scale_by_severity": false
    }
]