Read a recipe and how it installs

install_method says what installRecipe will do: simple_install mirrors the author's render; read_only_fork copies the recipe so the installer fills its custom fields; oauth_choice is a fork that can also carry the author's OAuth connection when inherit_oauth is true.

get/api/recipes/{id}

Request

Base URL: https://trmnl.com
URL: https://trmnl.com/api/recipes/{id}
Auth: HTTP bearer

Path parameters

idinteger required

Recipe id

Response

A recipe with custom fields must be forked so the installer can fill them

Example response

{
  "data": {
    "id": 1,
    "name": "Train Departures",
    "author": "Ada",
    "strategy": "polling"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.