ThingsBoard

ThingsBoard Rule Chain Controller API

Rule Chain

Documentation GitHub OpenAPI

Operations 22

POST /api/ruleChains/import Import Rule Chains #

POST /api/ruleChain Create or Update Rule Chain (saveRuleChain) #

POST /api/ruleChain/{ruleChainId}/root Set Root Rule Chain (setRootRuleChain) #

POST /api/ruleChain/{ruleChainId}/edgeTemplateRoot Set Edge Template Root Rule Chain (setEdgeTemplateRootRuleChain) #

POST /api/ruleChain/{ruleChainId}/autoAssignToEdge Set Auto Assign to Edge Rule Chain (setAutoAssignToEdgeRuleChain) #

DELETE /api/ruleChain/{ruleChainId}/autoAssignToEdge Unset Auto Assign to Edge Rule Chain (unsetAutoAssignToEdgeRuleChain) #

POST /api/ruleChain/testScript Test Script Function #

POST /api/ruleChain/metadata Update Rule Chain Metadata #

POST /api/ruleChain/device/default Create Default Rule Chain #

POST /api/edge/{edgeId}/ruleChain/{ruleChainId} Assign Rule Chain to Edge (assignRuleChainToEdge) #

DELETE /api/edge/{edgeId}/ruleChain/{ruleChainId} Unassign Rule Chain from Edge (unassignRuleChainFromEdge) #

GET /api/ruleNode/{ruleNodeId}/debugIn Get Latest Input Message (getLatestRuleNodeDebugInput) #

GET /api/ruleChains Get Rule Chains (getRuleChains) #

GET /api/ruleChains/export Export Rule Chains #

GET /api/ruleChain/{ruleChainId} Get Rule Chain (getRuleChainById) #

DELETE /api/ruleChain/{ruleChainId} Delete Rule Chain (deleteRuleChain) #

GET /api/ruleChain/{ruleChainId}/output/labels Get Rule Chain Output Labels (getRuleChainOutputLabels) #

GET /api/ruleChain/{ruleChainId}/output/labels/usage Get Output Labels Usage (getRuleChainOutputLabelsUsage) #

GET /api/ruleChain/{ruleChainId}/metadata Get Rule Chain (getRuleChainById) #

GET /api/ruleChain/tbelEnabled Is TBEL Script Executor Enabled #

GET /api/ruleChain/autoAssignToEdgeRuleChains Get Auto Assign to Edge Rule Chains (getAutoAssignToEdgeRuleChains) #

GET /api/edge/{edgeId}/ruleChains Get Edge Rule Chains (getEdgeRuleChains) #

Documentation

https://thingsboard.io/docs/reference/rest-api/

https://thingsboard.io/docs/user-guide/assets/

https://thingsboard.io/docs/user-guide/telemetry/

https://thingsboard.io/docs/user-guide/alarms/

https://thingsboard.io/docs/user-guide/rule-engine-2-0/re-getting-started/

https://thingsboard.io/docs/user-guide/rpc/

https://thingsboard.io/docs/user-guide/dashboards/

https://thingsboard.io/docs/user-guide/ui/customers/

https://thingsboard.io/docs/user-guide/notifications/

https://thingsboard.io/docs/edge/

https://thingsboard.io/docs/user-guide/mobile-app/

https://thingsboard.io/docs/user-guide/lwm2m/

https://thingsboard.io/products/trendz/

Specifications

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/openapi/thingsboard-rule-chain-controller-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-device-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-deviceprofile-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-asset-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-assetprofile-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-entityrelation-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-alarm-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-rulechain-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-dashboard-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-tenant-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-customer-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-user-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/thingsboard-rule-chain-controller-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: ThingsBoard Rule Engine Rule Chain Controller API
  description: 'ThingsBoard Rule Engine API — subset of the ThingsBoard REST API (open-source IoT platform). Covers: Rule Chain, Rule Engine, Component Descriptor.'
  version: 4.3.0.3DEMO
  contact:
    name: ThingsBoard team
    url: https://thingsboard.io
    email: info@thingsboard.io
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://demo.thingsboard.io
  description: ThingsBoard Live Demo
- url: http://localhost:8080
  description: Local ThingsBoard server
tags:


# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/openapi/thingsboard-rule-chain-controller-api-openapi.yml