For AI agents: visit https://docs.things5.com/v2.0/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Things5
HomeGuidesAPI ReferenceChangelog
Log InThings5
API Reference
Log In
HomeGuidesAPI ReferenceChangelog

Introduction

  • Getting Started
  • FAQ
  • Glossary
  • Firewall

HTTP API

  • General parameters
  • Authorization
    • Authorizationpost
    • Refresh tokenget
  • Organizations listget
  • Device
    • Device listget
    • Device detailsget
    • Device createpost
    • Device provisioningput
    • Use existing certificatesput
    • Change machine modelpost
  • Device model and firmware
    • Device models listget
    • Device model detailget
    • Device firmwares listget
    • Device firmware update requestpost
  • Device Data
    • Data ingestionpost
    • States readget
    • States read last valueget
    • Metrics readget
    • Events readget
    • Parameters readget
    • Parameters writepost
  • Device Groups
    • Devices Groups listget
    • Devices Group createpost
    • Device devices group association createget
  • HACCP
    • HACCP deviceget
    • HACCP email notification detailget
    • HACCP email notification updatepatch
  • Diagnostic Dashboard
    • Diagnostic dashboard listget
    • Diagnostic Dashboard updatepatch
    • Diagnostic Dashboard deletedel
    • Diagnostic Dashboard socket
  • Overview
    • Alarmsget
  • Notes
    • Notes listget
    • Notes createpost
    • Notes deletedel

HTTP API Recipes

  • Cookbooks & recipe templates
    • Recipe template listget
    • Recipe template deletedel
    • Recipe template createpost
    • Recipe template detailget
    • Recipe template add to cookbookpost
    • Cookbook listget
    • Cookbook detailget
    • Cookbook deletedel
    • Cookbook-recipe-template, deletedel
    • Cookbooks sync listget
    • Cookbook sync detailget
    • Cookbook sync requestpost
    • Cookbook sync log retryget
  • Device Recipes
    • Init recipesget
    • List recipesget
    • Delete recipedel
    • Update recipepatch
    • Create recipepost

MQTT API

  • Client settings
  • [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

MQTT API - Firmware

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

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
Powered by 
  1. HTTP API

Authorization

Things5 uses keycloak as authentication server, which leverages OIDC as authentication protocol. It is possible to use a OIDC library to manage token authentication and refresh for you, like https://www.npmjs.com/package/oidc-react or https://github.com/manfredsteyer/angular-oauth2-oidc

Updated over 2 years ago


Updated over 2 years ago