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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
ThingsBoard

ThingsBoard edge-controller API

Edge

Documentation Provider Profile APIs.io OpenAPI GitHub

ThingsBoard edge-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 edge-controller. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 11 JSON Schemas.

This API exposes 22 operations across 20 paths, and defines 17 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 20 paths 17 schemas 2 DELETE13 GET7 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
Contact
ThingsBoard team
License
Apache 2.0
Resource Areas
1

Authentication & Security 2

ThingsBoard edge-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 20 paths, the API surfaces 22 operations — 2 DELETE, 13 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

edge-controller 22

Edge

GET
/api/edges
Get Edges by Ids (getEdgesByIds)
getEdges 6 params → 200
POST
/api/edges
Find Related Edges (findByQuery)
findByQuery_2 body → 200
POST
/api/edge
Create or Update Edge (saveEdge)
saveEdge body → 200
POST
/api/edge/{edgeId}/{ruleChainId}/root
Set Root Rule Chain for Provided Edge (setEdgeRootRuleChain)
setEdgeRootRuleChain 2 params → 200
POST
/api/edge/sync/{edgeId}
Sync Edge (syncEdge)
syncEdge 1 param → 200
POST
/api/edge/bulk_import
Import the Bulk of Edges (processEdgesBulkImport)
processEdgesBulkImport body → 200
POST
/api/customer/{customerId}/edge/{edgeId}
Assign Edge to Customer (assignEdgeToCustomer)
assignEdgeToCustomer 2 params → 200
POST
/api/customer/public/edge/{edgeId}
Make Edge Publicly Available (assignEdgeToPublicCustomer)
assignEdgeToPublicCustomer 1 param → 200
GET
/api/tenant/edges
Get Tenant Edge (getTenantEdge)
getTenantEdges 7 params → 200
GET
/api/tenant/edgeInfos
Get Tenant Edge Infos (getTenantEdgeInfos)
getTenantEdgeInfos 6 params → 200
GET
/api/edges/enabled
Is Edges Support Enabled (isEdgesSupportEnabled)
isEdgesSupportEnabled → 200
GET
/api/edge/{edgeId}
Get Edge (getEdgeById)
getEdgeById 1 param → 200
DELETE
/api/edge/{edgeId}
Delete Edge (deleteEdge)
deleteEdge 1 param → 200
GET
/api/edge/{edgeId}/upgrade/available
Is Edge Upgrade Enabled (isEdgeUpgradeAvailable)
isEdgeUpgradeAvailable 1 param → 200
GET
/api/edge/types
Get Edge Types (getEdgeTypes)
getEdgeTypes → 200
GET
/api/edge/missingToRelatedRuleChains/{edgeId}
Find Missing Rule Chains (findMissingToRelatedRuleChains)
findMissingToRelatedRuleChains 1 param → 200
GET
/api/edge/instructions/upgrade/{edgeVersion}/{method}
Get Edge Upgrade Instructions (getEdgeUpgradeInstructions)
getEdgeUpgradeInstructions 2 params → 200
GET
/api/edge/instructions/install/{edgeId}/{method}
Get Edge Install Instructions (getEdgeInstallInstructions)
getEdgeInstallInstructions 2 params → 200
GET
/api/edge/info/{edgeId}
Get Edge Info (getEdgeInfoById)
getEdgeInfoById 1 param → 200
GET
/api/customer/{customerId}/edges
Get Customer Edges (getCustomerEdges)
getCustomerEdges 7 params → 200
GET
/api/customer/{customerId}/edgeInfos
Get Customer Edge Infos (getCustomerEdgeInfos)
getCustomerEdgeInfos 7 params → 200
DELETE
/api/customer/edge/{edgeId}
Unassign Edge from Customer (unassignEdgeFromCustomer)
unassignEdgeFromCustomer 1 param → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are EdgeInfo (14 properties), Edge (12 properties), RelationsSearchParameters (6 properties), Mapping (4 properties). Each schema is shown below with its type and property counts.

Mapping
object
4 properties
ColumnMapping
object
2 properties
EdgeInstructions
object
1 property
BulkImportRequest
object
2 properties
BulkImportResultEdge
object
4 properties
TenantId
object
2 properties 2 required
RelationsSearchParameters
object
6 properties
EdgeId
object
2 properties 2 required
EntitySubtype
object
3 properties
EdgeSearchQuery
object
3 properties
JsonNode
A value representing the any type (object or primitive)
Edge
object
A JSON value representing the edge.
12 properties 4 required
EdgeInfo
object
14 properties 4 required
CustomerId
object
2 properties 2 required
PageDataEdge
object
4 properties
RuleChainId
object
2 properties 2 required
PageDataEdgeInfo
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thingsboard-edge-controller-api-openapi.yml Raw ↑

Other APIs ThingsBoard publishes across the network.

ThingsBoard admin-controller API
AE Profile APIs.io
ThingsBoard ai-model-controller API
AE Profile APIs.io
ThingsBoard alarm-comment-controller API
AE Profile APIs.io
ThingsBoard alarm-controller API
AE Profile APIs.io
ThingsBoard api-key-controller API
AE Profile APIs.io
ThingsBoard asset-controller API
AE Profile APIs.io
ThingsBoard asset-profile-controller API
AE Profile APIs.io
ThingsBoard audit-log-controller API
AE Profile APIs.io
ThingsBoard auth-controller API
AE Profile APIs.io
ThingsBoard calculated-field-controller API
AE Profile APIs.io
ThingsBoard component-descriptor-controller API
AE Profile APIs.io
ThingsBoard customer-controller API
AE Profile APIs.io
#edge-controller
← Back to T APIs
API Details
ID
thingsboard:thingsboard-edge-controller-api
Server
https://demo.thingsboard.io
Docs
https://thingsboard.io/docs/reference/rest-api/
Provider
ThingsBoard
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=thingsboard-edge-controller-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/thingsboard-edge-controller-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of ThingsBoard edge-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.