Device Recipes Actions#

https://api.losant.com/applications/APPLICATION_ID/device-recipes

Below are the various requests that can be performed against the Device Recipes resource, as well as the expected parameters and the potential responses.

Get#

Returns the device recipes for an application

Method And Url #

GET https://api.losant.com/applications/APPLICATION_ID/device-recipes

Authentication #

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, deviceRecipes.*, or deviceRecipes.get.

Request Path Components #

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97

Request Query Parameters #

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated	name	sortField=name
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	asc	sortDirection=asc
page	N	Which page of results to return	0	page=0
perPage	N	How many items to return per page	1000	perPage=10
filterField	N	Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name		filterField=name
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=my * recipe

Request Headers #

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example #

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/applications/APPLICATION_ID/device-recipes

Successful Responses #

Code	Type	Description
200	Device Recipes	Collection of device recipes

Error Responses #

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Post#

Create a new device recipe for an application

Method And Url #

POST https://api.losant.com/applications/APPLICATION_ID/device-recipes

Authentication #

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, deviceRecipes.*, or deviceRecipes.post.

Request Path Components #

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97

Request Headers #

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body #

The body of the request should be serialized JSON that validates against the Device Recipe Post schema. For example, the following would be a valid body for this request:

{
  "name": "My New Device Recipe",
  "deviceName": "Future device name",
  "description": "Description of my new device recipe",
  "deviceDescription": "Future device description",
  "tags": [
    {
      "key": "TagKey",
      "value": "TagValue"
    }
  ],
  "attributes": [
    {
      "name": "voltage",
      "dataType": "number"
    }
  ],
  "deviceClass": "standalone"
}

Curl Example #

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"name":"My New Device Recipe","deviceName":"Future device name","description":"Description of my new device recipe","deviceDescription":"Future device description","tags":[{"key":"TagKey","value":"TagValue"}],"attributes":[{"name":"voltage","dataType":"number"}],"deviceClass":"standalone"}' \
    https://api.losant.com/applications/APPLICATION_ID/device-recipes

Successful Responses #

Code	Type	Description
201	Device Recipe	Successfully created device recipe

Error Responses #

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found