API Reference

Updates a Device

put
https://api.edgeiq.io/api/v1/platform/devices/

Updates a Device

Path Params
string
required

The ID that specifies a Device

Body Params
string

Company account id for this device. If left blank, defaults to current user's company id on creation.

string
required

A descriptive name for this Device.

string
required

A unique identifier for the device. Must be globally unique. For gateway devices running our edge service, this ID will uniquely identify this gateway when it requests its configuration from the cloud. Allowed to contain only lower or uppercase letters, numbers, colons, underscores, or dashes (the characters :, -, or _).

string
required

The _id of the Device Type

boolean

Indicates that the device is marked as activated in another system. Currently applies only to cloud-native devices. Exclusive of deactivated_at.

boolean

Indicates that the device is marked as deactivated in another system. Currently applies only to cloud-native devices. Exclusive of activated_at.

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
string of strings | null

Method used for authenticating with MQTT (e.g. password, certificate)

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
device_certificates
array of objects | null

An array of device certificates

device_certificates
ingestor_ids
array of strings | null

IDs of associated Ingestors (deprecated, optional).

ingestor_ids
command_ids
array of strings | null

IDs of associated Commands (deprecated, optional).

command_ids
attached_device_ids
array of strings | null
attached_device_ids
string | null

The ID of the last device location observation received for this device. Field will be undefined if location observation doesn't exist.

log_config
object | null
string | null

A textual (non-geographic) location for keeping track of the location of a device. For example "Warehouse", "Building One".

last_known_geographic_location
object | null

GeoJSON Feature representation of the device's last known location, with the radius of accuracy in properties.radius. If this device has received any device location observations, the latest device location observation's geographic coordinates will be returned here on the device as well.

metadata
object | null

A key/value object of user defined data

boolean
deprecated

[deprecated] Indicates whether or not the Device is available. No longer used.

Responses
200

Successful operation

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!
Updated 7 months ago