API Reference

Creates a Device Template

post
https://api.edgeiq.io/api/v1/platform/device_templates

Creates a Device Template

Body Params
string
required

The name of the Device Template.

string

Description of the Device Template.

string

The name for the Device(s) (templatable). If omitted, the unique_id will be used for the Devices' name.

string

The company_id for the Device(s). If omitted, the requesting user's company_id will be used for the Devices' company_id.

string
required

The device_type_id for the Device(s).

integer
Defaults to 60

The interval (in seconds) that the heartbeat message will be sent.

heartbeat_values
array of strings | null

An array of strings indicating what values should be included in the heartbeat message.

heartbeat_values
tags
array of strings | null

A comma separated list of strings acting as tags for the device. Can be used to group and store information about devices.

tags
log_config
object | null
metadata
object | null

A key/value object of user defined data

string

The _id of the device Integration to be associated with the Device(s).

string

The _id of the cloud native Integration to be associated with the Device(s).

Responses

401

You are not authorized

404

The item you were looking for does not exist

500

An unexpected error was encountered.

Updated 7 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago