Skip to content
© 2026 The ThingsBoard Authors
 
Try for free

ThingsBoard Cloud

Choose your data region

Your data stays in the region you choose, for residency and compliance. No credit card required.

North America Data stored in North America Europe Data stored in the European Union

Rather run it yourself? Install on your own servers

EdgeController

EdgeController exposes REST endpoints for inspecting and managing the Edge instance itself — retrieving configuration, querying the outbound event queue, and triggering synchronization with the server. These endpoints are available on the Edge node at port 8080 and are not present in ThingsBoard CE or PE.

Endpoints

Section titled “Endpoints”

Base path: /api/edge

Method Path Description
GET /api/edge/{edgeId} Returns the Edge instance object — ID, name, type, routing key, label, and customer assignment.
GET /api/edge/info/{edgeId} Returns an extended Edge info object that includes customer title and additional metadata.
GET /api/edge/settings Returns the Edge configuration settings applied at startup.
POST /api/edge/sync/{edgeId} Triggers a full synchronization from the server — equivalent to clicking Force sync on the Edge instance page. The server pushes all assigned entities, rule chains, and credentials to Edge.
GET /api/edge/missingToRelatedRuleChains/{edgeId} Returns rule chains referenced by entities assigned to this Edge but not yet assigned to the Edge directly. Useful for diagnosing missing rule chain errors.
POST /api/edge/{edgeId}/{ruleChainId}/root Sets the root rule chain for the Edge instance.
GET /api/edge/events Returns paginated cloud events — the outbound queue of messages waiting to be sent to the server. Supports startTime, endTime, pageSize, page, textSearch, sortProperty, and sortOrder query parameters.
GET /api/edge/events/timeseries Returns cloud events as a time-series data set for charting.
GET /api/edge/instructions/install/{edgeId}/{method} Returns installation instructions for the specified method (docker, ubuntu, rhel, windows).
GET /api/edge/instructions/upgrade/{edgeVersion}/{method} Returns upgrade instructions for the given Edge version and installation method.
GET /api/edge/{edgeId}/upgrade/available Returns whether a newer Edge version is available.
GET /api/edges Returns a paginated list of Edge instances visible to the current user. Supports pageSize, page, textSearch, sortProperty, sortOrder, and optional type filter.
POST /api/edges Queries Edge instances by an EntityDataQuery object — supports filtering by attribute values and telemetry.
© 2026 The ThingsBoard Authors