Jump to Content

Home Guides API Reference Changelog

API Reference

Home Guides API Reference Changelog

Introduction

Getting Started
FAQ
Glossary
Firewall
Permissions

HTTP API

General parameters
Authorization
Organization
Device
Device Model
- Device models listget
- Device model detailget
Device Firmware
Device Data
Device Groups
HACCP
Diagnostic Dashboard
Users
Overview
- Alarmsget
- Eventsget
Notes
Roles
Knowledge base
- Get Upload images linkget
- Create new documentpost
Plans
Event notifications
- List event notificationsget
- Event notifications updateput

HTTP API Recipes

Intro
Things5 managed Recipes
Device managed recipes
Cookbooks & recipe templates

MQTT API

Introduction
[Pub] Data ingestion request
[Sub] Data ingestion response
[Sub] Realtime monitoring request

MQTT API - Configuration Parameters

Introduction
[Sub] Parameters read request
[Pub] Parameters read response
[Sub] Parameters write request
[Pub] Parameters write response
[Pub]Variables changed request
[Sub]Variables changed response

MQTT API - Firmware

[Sub] Update request
[Pub] Update response
[Pub] Update progress
[Evt][Pub] Firmware version request
[Evt][Sub] Firmware version response
[Req][Pub] Firmwares list request
[Req][Sub] Firmwares list response
[Req][Pub] Firmware details request
[Req][Sub] Firmware details response
Introduction

MQTT API - HACCP

Introduction

MQTT API - Recipes

Introduction
[Sub] Read recipes request
[Pub] Read recipes response
[Sub] Write recipe request
[Pub] Write recipe response
[Evt][Pub] Recipes updated manually
[Sub] Delete recipe request
[Pub] Delete recipe response
[Sub] List recipes request
[Pub] List recipes response
[Sub] Read recipe request
[Pub] Read recipe response
[Sub] Sync recipe templates request
[Pub] Sync recipe templates response

MQTT API - Logs

[Pub] Log ingestion request
[Sub] Log ingestion response

MQTT API - MISC

[Req][Pub] Model change request
[Req][Sub] Model change response
[Pub] Start VPN
[Pub] Stop VPN

MQTT API - Token Exchange

Introduction
[Pub] Token exchange session request
[Sub] Token exchange session response
[Sub] Token exchange response

Powered by

Cookbook sync request

post https://api.things5.digital/v1/recipes/cookbook_syncs

Send all recipe templates of a cookbook to many devices.

Language

Credentials

Header