Skip to content

Cookie preferences

We use cookies for our own analytics, to see how our campaigns perform and, if you allow it, to load content from other services such as the Google site search. We never sell your data. Necessary cookies keep the site working and cannot be switched off. See our Cookie Policy for details and our Privacy Policy for how we handle personal data.

Security, load balancing and remembering your cookie choice.

Show us which pages people read, how they find the site and where they get stuck, so we can improve it (Google Analytics, Microsoft Clarity).

Show us which of our ad campaigns bring visitors to the site and remember the campaign or partner link you arrived from (Google Ads, LinkedIn, Meta, partner program). We do not use these cookies to build advertising profiles.

Load the site search from Google when you use it. Google sets its own cookies and shows ads in the search results.
© 2026 The ThingsBoard Authors
180 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. The same controller exists on the ThingsBoard server. On the Edge node (port 8080), /api/edge/settings, /api/edge/events, and /api/edge/events/timeseries are Edge-only, and the synchronization, instruction, and upgrade endpoints work only on the server: on Edge they return Edges support disabled.

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 Edge only. Returns the Edge configuration settings applied at startup.
POST /api/edge/sync/{edgeId} Triggers a full synchronization from the server — equivalent to clicking Sync Edge on the Edge details page. The server pushes all assigned entities, rule chains, and credentials to Edge. Server only.
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 Edge only. 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 a paginated list of time-series cloud events (telemetry and attribute uplinks queued in ts_kv_cloud_event). Edge only.
GET /api/edge/instructions/install/{edgeId}/{method} Returns installation instructions for the specified method (docker, ubuntu, centos). Server only.
GET /api/edge/instructions/upgrade/{edgeVersion}/{method} Returns upgrade instructions for the given Edge version and installation method. Server only.
GET /api/edge/{edgeId}/upgrade/available Returns whether a newer Edge version is available. Server only.
GET /api/edges Returns a paginated list of Edge instances visible to the current user. Supports pageSize, page, textSearch, sortProperty, and sortOrder. To filter by type, use /api/tenant/edges?type=....
POST /api/edges Finds Edge instances related to an entity, using an EdgeSearchQuery (relation-based search).
© 2026 The ThingsBoard Authors · Privacy Policy · Cookie Policy ·