How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ThingsBoard rule-chain-controller API

Rule Chain

ThingsBoard rule-chain-controller API is one of 58 APIs that ThingsBoard publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 11 JSON Schema definitions.

Tagged areas include rule-chain-controller. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 11 JSON Schemas.

This API exposes 22 operations across 19 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 4.3.0.3DEMO.

Requests are made against 2 base URLs: https://demo.thingsboard.io, http://localhost:8080.

22 operations 19 paths 15 schemas 3 DELETE10 GET9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.3.0.3DEMO
Servers
https://demo.thingsboard.io
http://localhost:8080
Authentication
HTTP Loginpassword, API Key
License
Resource Areas
1

Authentication & Security 2

ThingsBoard rule-chain-controller API declares 2 security schemes for authenticating requests. It uses HTTP loginpassword authentication (HTTP_login_form). An API key is passed in the header as X-Authorization (API_key_form).

  • HTTP_login_form — Enter Username / Password
  • API_key_form — Enter the API key value with 'ApiKey' prefix in format: ApiKey Example: ApiKey tb5te51SkLRYpjGrujUGwqkjFvooWBlQpVe2An2Dr3w13wjfxDW NOTE: Use only ONE authentic…

Paths & Operations 22

Across 19 paths, the API surfaces 22 operations — 3 DELETE, 10 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.

rule-chain-controller 22

Rule Chain

POST
/api/ruleChains/import
Import Rule Chains
importRuleChains 1 param body → 200
POST
/api/ruleChain
Create or Update Rule Chain (saveRuleChain)
saveRuleChain body → 200
POST
/api/ruleChain/{ruleChainId}/root
Set Root Rule Chain (setRootRuleChain)
setRootRuleChain 1 param → 200
POST
/api/ruleChain/{ruleChainId}/edgeTemplateRoot
Set Edge Template Root Rule Chain (setEdgeTemplateRootRuleChain)
setEdgeTemplateRootRuleChain 1 param → 200
POST
/api/ruleChain/{ruleChainId}/autoAssignToEdge
Set Auto Assign to Edge Rule Chain (setAutoAssignToEdgeRuleChain)
setAutoAssignToEdgeRuleChain 1 param → 200
DELETE
/api/ruleChain/{ruleChainId}/autoAssignToEdge
Unset Auto Assign to Edge Rule Chain (unsetAutoAssignToEdgeRuleChain)
unsetAutoAssignToEdgeRuleChain 1 param → 200
POST
/api/ruleChain/testScript
Test Script Function
testScript 1 param body → 200
POST
/api/ruleChain/metadata
Update Rule Chain Metadata
saveRuleChainMetaData 1 param body → 200
POST
/api/ruleChain/device/default
Create Default Rule Chain
saveRuleChain_1 body → 200
POST
/api/edge/{edgeId}/ruleChain/{ruleChainId}
Assign Rule Chain to Edge (assignRuleChainToEdge)
assignRuleChainToEdge 2 params → 200
DELETE
/api/edge/{edgeId}/ruleChain/{ruleChainId}
Unassign Rule Chain from Edge (unassignRuleChainFromEdge)
unassignRuleChainFromEdge 2 params → 200
GET
/api/ruleNode/{ruleNodeId}/debugIn
Get Latest Input Message (getLatestRuleNodeDebugInput)
getLatestRuleNodeDebugInput 1 param → 200
GET
/api/ruleChains
Get Rule Chains (getRuleChains)
getRuleChainsByIds 7 params → 200
GET
/api/ruleChains/export
Export Rule Chains
exportRuleChains 1 param → 200
GET
/api/ruleChain/{ruleChainId}
Get Rule Chain (getRuleChainById)
getRuleChainById 1 param → 200
DELETE
/api/ruleChain/{ruleChainId}
Delete Rule Chain (deleteRuleChain)
deleteRuleChain 1 param → 200
GET
/api/ruleChain/{ruleChainId}/output/labels
Get Rule Chain Output Labels (getRuleChainOutputLabels)
getRuleChainOutputLabels 1 param → 200
GET
/api/ruleChain/{ruleChainId}/output/labels/usage
Get Output Labels Usage (getRuleChainOutputLabelsUsage)
getRuleChainOutputLabelsUsage 1 param → 200
GET
/api/ruleChain/{ruleChainId}/metadata
Get Rule Chain (getRuleChainById)
getRuleChainMetaData 1 param → 200
GET
/api/ruleChain/tbelEnabled
Is TBEL Script Executor Enabled
isTbelEnabled → 200
GET
/api/ruleChain/autoAssignToEdgeRuleChains
Get Auto Assign to Edge Rule Chains (getAutoAssignToEdgeRuleChains)
getAutoAssignToEdgeRuleChains → 200
GET
/api/edge/{edgeId}/ruleChains
Get Edge Rule Chains (getEdgeRuleChains)
getEdgeRuleChains 6 params → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are RuleNode (13 properties), RuleChain (11 properties), RuleChainMetaData (6 properties), RuleChainOutputLabelsUsage (5 properties). Each schema is shown below with its type and property counts.

RuleChainConnectionInfo
object
4 properties 4 required
RuleNode
object
13 properties
DefaultRuleChainCreateRequest
object
A JSON value representing the request.
1 property 1 required
RuleChainId
object
2 properties 2 required
TenantId
object
2 properties 2 required
RuleChain
object
A JSON value representing the rule chain.
11 properties 2 required
RuleNodeId
object
2 properties 2 required
JsonNode
A value representing the any type (object or primitive)
NodeConnectionInfo
object
3 properties 3 required
RuleChainMetaData
object
A JSON value representing the rule chain metadata.
6 properties 5 required
PageDataRuleChain
object
4 properties
DebugSettings
object
3 properties
RuleChainData
object
A JSON value representing the rule chains.
2 properties 2 required
RuleChainOutputLabelsUsage
object
5 properties 5 required
RuleChainImportResult
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thingsboard-rule-chain-controller-api-openapi.yml Raw ↑

Other APIs ThingsBoard publishes across the network.

ThingsBoard admin-controller API
ThingsBoard ai-model-controller API
ThingsBoard alarm-comment-controller API
ThingsBoard alarm-controller API
ThingsBoard api-key-controller API
ThingsBoard asset-controller API
ThingsBoard asset-profile-controller API
ThingsBoard audit-log-controller API
ThingsBoard auth-controller API
ThingsBoard calculated-field-controller API
ThingsBoard component-descriptor-controller API
ThingsBoard customer-controller API
Where this information came from

This is an independent, third-party profile of ThingsBoard rule-chain-controller API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.