Retrieving recipes

Retrieve details of a particular recipe.

Procedure

  1. In a REST client platform, add the authentication details of the tenant that is associated with the recipe, the details you want to retrieve.
    
    //In case of Instance API key 
    Headers:
    {
    "x-instance-api-key": "instance_api_key"
    }
     
    // In case of MCSP or ISV token
    Headers:
    {
    "Authorization": "mcsp_or_isv_token"
    }
    
  2. Make a GET request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/recipes/:uid

    In this URL request, :uid is the ID of the recipe you want to retrieve.

    Method: GET

    If the request is successful, you receive the response code for success.

    {
    output: 
    	{      	         
    	"uid": <recipe_uid>
    	"name": "<recipe_name>",
    	"description": "<description>",
    	"download": "<recipe_download_count>"                             
    	}  
    }