Skip to main content

deleteCookbook

A Graze API POST request that deletes an existing Cookbook.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint deleteCookbook takes the following request arguments:

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 delete.

Response

Endpoint deleteCookbook returns the following response:

Examples

The following examples demonstrate typical use of endpoint deleteCookbook:

Request example

Example cURL request to delete Cookbook "GrazeCookBook1":

curl -X POST -u graze:graze -k -v "https://localhost/graze/v1/deleteCookbook" -H "Content-Type: application/json; charset=UTF-8" -d '{"name" : "GrazeCookBook1"}'

Response example

In this section: