Jump to Content

Droplit.io Portal

Droplit.io Portal Log In

API Reference

Getting Started

Introduction
Containers

Device Modeling With Service Classes

Service Classes
Service Examples
Service Selectors
Service Class Specification

Platform Overview

Ontology
Identifiers
Metadata
Authentication
Devices
Ecosystems
Environments
Zones
Aliases
Users
Webhooks
Webhooks v2

Droplit Command Line

Droplit Command Line Console
Droplit Command Line Console Setup
Node.js Setup: Windows
Node.js Setup: MacOS
Node.js Setup: Linux/Embedded Systems

Edge Server

Setting Up The Edge Server
Local Settings
Creating Plugins
LIFX Bulbs Plugin
Philips Hue Bulbs Plugin
Sonos Speakers Plugin
Voyager Thermostat Plugin
WeMo Devices Plugin
Provisioning CLI
Edge Provisioning API

Real Time Monitoring

Trace Command Line Console
WebSocket SDK

REST API Usage

Usage Techniques
Standard Responses
URL Organization
Endpoint Discovery
Droplit SDK

Tutorial

Droplit System Tutorial
Common API Use Cases

Connections

AWS IoT

Integrations

Ecobee Thermostats
Ecobee EMS Thermostats
Google Home
Honeywell Thermostats
Nest Thermostats

Security

Auth0

Features

Assets
Behaviors
Filters
Key Policies
Pagination
Presence
Projections
Automated User Logins

Account API

Get a user's authentication status.get
Log a user out of the Droplit system.post
Update a user's account.put

Assets API

Get Assetsget
Get an Assetget
Create/Update Assetput
Delete Assetdelete

Authorization API

Create Shortcodepost
Consume Shortcodepost

Clients API

List clients in an ecosystem.get
Create a client.post
Get a client.get
Update a client.put
Delete a client.delete
List client tokens.get
Create a client token.post
Get a client token.get
Update a client token.put
Delete a client token.delete
Regenerate a client token.post

Conduits API

List conduits.get
Install a conduit.
Get a conduit.get
Update a conduit.put
Delete a conduit.delete
Activate a conduit.post
List a conduit's activations.get
Get a conduit's activation.get
Remove a conduit's activation.delete
Reactivate a conduit.post
List local devices.get
Get a local device.get
Create a token.post
List tokens.get
Get a token.get
Delete a token.delete

Deleted API

Deleted API
List Allget
Get Info for Sessionget
Permanently Delete Recordsdelete
Get All Deleted Recordsget
Undelete a Recordpost

Devices API

List devices.get
Create a device.post
Get a device.get
Update a device.put
Delete a device.delete
View the action history of a device.get
List the service properties of a device.get
Get a device service property.get
Update Service Propertyput
Update Multiple Service Propertiesput
Delete a device service property.delete
Call Service Methodpost

Ecosystems API

Environments API

List environments.get
Create an environment.post
Get an environment.get
Update an environment.put
Delete an environment.delete
View the action history of all devices in an environment.get
List all service properties of devices in an environment.get
List specific service properties of devices in an environment.get
Update Service Propertyput
Update Multiple Service Propertiesput
Call Service Methodpost
Claim an environment as a user.post
List behaviors.get
Get a behavior.get
Create a behavior.post
Update a behavior.put
Delete a behavior.delete
Start a behavior.post
Enable a behavior.post
Disable a behavior.post
List actions.get
Get an action.get
Start an action.post
Stop an action.post
List permissions.get
Get permissions.get
Update permissions.put
Remove permissions.delete

Key Policies

List Key Policiesget
Create Key Policypost
Read Key Policyget
Update Key Policyput
Delete Key Policydelete

Schemas API

List schemas.get
Get a schema by its file name.get

Service Classes API

List service classes in an ecosystem.get
Create a service class.post
Get a service class.get
Update a service class.put
Delete a service class.delete
List curated service classes.get
Get a curated service class.get

Territories API

List all territories.get
Create a territory.post
Get a territory.get
Update a territory.put
Create a sub-territory.post
Delete a territory.delete
List sub-territories.get
Move a territory.post
List environments.get
Replace environments.put
List users.get
Get a user.get
Add a user.post
Remove a user.delete
Replace users.put
List all permissions.get
Get permissions.get
Update permissions.put
Remove permissions.get

Users API

List users.get
Create or Update a User.put
Get a user.get
Delete a user.delete
Generate a user token.put
List all permissions.get
Get user permissions.get
Update user permissions.put
Remove user permissions.delete

Webhooks API

List webhooks.get
Create a webhook.post
Get a webhook.get
Update a webhook.post
Delete a webhook.delete
Invoke a webhook.post
List webhooks v2get
Create a webhook. v2post
Get a webhook. v2get
Update a webhook. v2put
Delete a webhook. v2delete
Invoke a webhook. v2post

Zones API

List zones.get
Create a zone.post
Get a zone.get
Update a zone.put
Delete a zone.delete
List devices that are present in a zone.get
List items that are present in a zone.get
Alter items that are present in a zone.put
Create a zone item.post
Delete a zone item.delete
List the service properties of all devices in a zone.get
List the given service selector property from devices in a zone.get
Update Service Propertyput
Update Multiple Service Propertiesput
Call Service Methodpost
List factor values.get
Get a factor value.get
Update a factor value.put
Get presence mode.get
Set presence mode.put
Get presence.get
List behaviors.get
Get a behavior.get
Create a behavior.post
Update a behavior.put
Delete a behavior.delete
Start a behavior.post
Enable a behavior.post
Disable a behavior.post
List actions.get
Get an action.get
Start an action.post
Stop an action.post

Powered by

Getting Started

Introduction
Containers

Device Modeling With Service Classes

Service Classes
Service Examples
Service Selectors
Service Class Specification

Platform Overview

Ontology
Identifiers
Metadata
Authentication
Devices
Ecosystems
Environments
Zones
Aliases
Users
Webhooks
Webhooks v2

Droplit Command Line

Droplit Command Line Console
Droplit Command Line Console Setup
Node.js Setup: Windows
Node.js Setup: MacOS
Node.js Setup: Linux/Embedded Systems

Edge Server

Setting Up The Edge Server
Local Settings
Creating Plugins
LIFX Bulbs Plugin
Philips Hue Bulbs Plugin
Sonos Speakers Plugin
Voyager Thermostat Plugin
WeMo Devices Plugin
Provisioning CLI
Edge Provisioning API

Real Time Monitoring

Trace Command Line Console
WebSocket SDK

REST API Usage

Usage Techniques
Standard Responses
URL Organization
Endpoint Discovery
Droplit SDK

Tutorial

Droplit System Tutorial
Common API Use Cases

Connections

AWS IoT

Integrations

Ecobee Thermostats
Ecobee EMS Thermostats
Google Home
Honeywell Thermostats
Nest Thermostats

Security

Auth0

Features

Assets
Behaviors
Filters
Key Policies
Pagination
Presence
Projections
Automated User Logins

Account API

Get a user's authentication status.get
Log a user out of the Droplit system.post
Update a user's account.put

Assets API

Get Assetsget
Get an Assetget
Create/Update Assetput
Delete Assetdelete

Authorization API

Create Shortcodepost
Consume Shortcodepost

Clients API

List clients in an ecosystem.get
Create a client.post
Get a client.get
Update a client.put
Delete a client.delete
List client tokens.get
Create a client token.post
Get a client token.get
Update a client token.put
Delete a client token.delete
Regenerate a client token.post

Conduits API

List conduits.get
Install a conduit.
Get a conduit.get
Update a conduit.put
Delete a conduit.delete
Activate a conduit.post
List a conduit's activations.get
Get a conduit's activation.get
Remove a conduit's activation.delete
Reactivate a conduit.post
List local devices.get
Get a local device.get
Create a token.post
List tokens.get
Get a token.get
Delete a token.delete

Deleted API

Deleted API
List Allget
Get Info for Sessionget
Permanently Delete Recordsdelete
Get All Deleted Recordsget
Undelete a Recordpost

Devices API

List devices.get
Create a device.post
Get a device.get
Update a device.put
Delete a device.delete
View the action history of a device.get
List the service properties of a device.get
Get a device service property.get
Update Service Propertyput
Update Multiple Service Propertiesput
Delete a device service property.delete
Call Service Methodpost

Ecosystems API

Environments API

List environments.get
Create an environment.post
Get an environment.get
Update an environment.put
Delete an environment.delete
View the action history of all devices in an environment.get
List all service properties of devices in an environment.get
List specific service properties of devices in an environment.get
Update Service Propertyput
Update Multiple Service Propertiesput
Call Service Methodpost
Claim an environment as a user.post
List behaviors.get
Get a behavior.get
Create a behavior.post
Update a behavior.put
Delete a behavior.delete
Start a behavior.post
Enable a behavior.post
Disable a behavior.post
List actions.get
Get an action.get
Start an action.post
Stop an action.post
List permissions.get
Get permissions.get
Update permissions.put
Remove permissions.delete

Key Policies

List Key Policiesget
Create Key Policypost
Read Key Policyget
Update Key Policyput
Delete Key Policydelete

Schemas API

List schemas.get
Get a schema by its file name.get

Service Classes API

List service classes in an ecosystem.get
Create a service class.post
Get a service class.get
Update a service class.put
Delete a service class.delete
List curated service classes.get
Get a curated service class.get

Territories API

List all territories.get
Create a territory.post
Get a territory.get
Update a territory.put
Create a sub-territory.post
Delete a territory.delete
List sub-territories.get
Move a territory.post
List environments.get
Replace environments.put
List users.get
Get a user.get
Add a user.post
Remove a user.delete
Replace users.put
List all permissions.get
Get permissions.get
Update permissions.put
Remove permissions.get

Users API

List users.get
Create or Update a User.put
Get a user.get
Delete a user.delete
Generate a user token.put
List all permissions.get
Get user permissions.get
Update user permissions.put
Remove user permissions.delete

Webhooks API

List webhooks.get
Create a webhook.post
Get a webhook.get
Update a webhook.post
Delete a webhook.delete
Invoke a webhook.post
List webhooks v2get
Create a webhook. v2post
Get a webhook. v2get
Update a webhook. v2put
Delete a webhook. v2delete
Invoke a webhook. v2post

Zones API

List zones.get
Create a zone.post
Get a zone.get
Update a zone.put
Delete a zone.delete
List devices that are present in a zone.get
List items that are present in a zone.get
Alter items that are present in a zone.put
Create a zone item.post
Delete a zone item.delete
List the service properties of all devices in a zone.get
List the given service selector property from devices in a zone.get
Update Service Propertyput
Update Multiple Service Propertiesput
Call Service Methodpost
List factor values.get
Get a factor value.get
Update a factor value.put
Get presence mode.get
Set presence mode.put
Get presence.get
List behaviors.get
Get a behavior.get
Create a behavior.post
Update a behavior.put
Delete a behavior.delete
Start a behavior.post
Enable a behavior.post
Disable a behavior.post
List actions.get
Get an action.get
Start an action.post
Stop an action.post

Powered by

List tokens.

get https://ioe.droplit.io/v0/api/conduits/{id}/tokens

Get a conduit's tokens.

Language

Credentials

Header

Click Try It! to start a request and see the response here!