For AI agents: visit https://docs.things5.com/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
  • Permissions

HTTP API

  • General parameters
  • Authorization
    • Get access tokenpost
    • Refresh tokenget
    • Token exchangepost
  • Organization
    • Listget
    • Detail Organizationget
    • Update organizationpatch
    • Logo and favicon updateput
  • Device
    • [DEPRECATED] Device listget
    • Device listget
    • Device detailsget
    • Device createpost
    • Device provisioning V1put
    • Device provisioning V2put
    • Change machine modelpost
    • Device updatepatch
    • Users
      • List usersget
      • Createpost
      • Deletedel
  • Device Model
    • Device models listget
    • Device model detailget
    • Updatepatch
  • Device Firmware
    • Listget
    • Detailget
    • Deletedel
    • Editpatch
    • Archivepost
    • Update
      • Firmware update requestpost
      • Firmware update statusget
      • Cancel updatepost
  • Device Data
    • Data ingestionpost
    • States readget
    • States read last valueget
    • Metrics readget
    • Aggregated metricsget
    • Events readget
    • Parameters readget
    • Parameters writepost
    • Event durationsget
    • State durationsget
    • Kpi listget
    • Device kpisget
  • Device Groups
    • Categories
      • List device group categoriesget
      • Create machine group categorypost
      • Edit device group categorypatch
      • Delete device group categorydel
    • Groups
      • Createpost
      • Listget
      • Deletedel
      • Showget
      • Updatepatch
    • Device-Group association
      • Deletedel
      • Createpost
    • Users
      • Create user-device group associationpost
      • Remove user-device associationdel
  • 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
  • Users
    • User updatepatch
    • User createpost
    • Users listget
    • Users detailget
    • Current User
      • Updatepatch
      • Detailget
    • Machine sharedget
  • Overview
    • Alarmsget
    • Eventsget
  • Notes
    • Notes listget
    • Notes createpost
    • Notes deletedel
  • Roles
    • Roles listget
    • Roles createpost
    • Edit Rolepatch
  • Knowledge base
    • Get Upload images linkget
    • Create new documentpost
  • Plans
    • Plans
      • Plans detailget
      • Plans createpost
      • Plans Updatepatch
      • Plan deletedel
      • Plans listget
      • Set default planpost
      • Set fallback planpost
    • Emails
      • Emails listget
      • Email createpost
      • Email updatepatch
      • Audience detailget
      • Audience upsertput
    • Machine plans
      • Batch upsert machines planput
      • Upsert machine planput
      • Request plan changepost
  • Event notifications
    • List event notificationsget
    • Event notifications updateput
  • Actions
    • Createpost
    • Deletedel
    • Editpatch
    • Performpost
    • Listget
  • Device Commands
    • Createpost
    • Deletedel
    • Updatepatch
    • Executeput
  • Device tokens
    • Listget
    • Deletedel
    • Createpost
    • Updatepatch
    • Consumepost
    • Generation policies
      • Createpost
      • Updatepatch
      • Deletedel
      • Listget
  • Machine Logs
    • List logsget

HTTP API Recipes

  • Intro
  • Things5 managed Recipes
    • Init recipesget
    • List recipesget
    • Recipe detailget
    • Delete recipedel
    • Update recipepatch
    • Create recipepost
    • Cancel write recipes requestget
  • Device managed recipes
    • Read recipesget
    • Read recipeget
    • Write recipepost
    • Delete recipedel
  • Cookbooks & recipe templates
    • Recipe templates
      • Recipe template listget
      • Recipe template deletedel
      • Recipe template createpost
      • Recipe template updatepatch
      • Recipe template detailget
      • Recipe template add to cookbookpost
    • Cookbooks
      • Cookbook listget
      • Cookbook updatepatch
      • Cookbook createpost
      • Cookbook detailget
      • Cookbook deletedel
      • Cookbook tagsget
    • Cookbooks syncs
      • Cookbook syncs listget
      • Cookbook sync detailget
      • Cookbook sync requestpost
      • Cookbook sync log retryget
      • Cookbook sync log cancelpost
    • Cookbook-recipe-template, deletedel

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
  • [Sub] Perform action request
  • [Pub] Perform action response

MQTT API - Token Exchange

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

MQTT API - DEVICE TOKENS

  • Introduction
  • [Pub] Generate device token from policies request
  • [Sub] generate device token from policies 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