ThingsBoard

ThingsBoard Dashboard Controller API

Dashboard

GitHub OpenAPI

Operations 24

GET /api/tenant/dashboard/home/info Get Tenant Home Dashboard Info (getTenantHomeDashboardInfo) #
POST /api/tenant/dashboard/home/info Update Tenant Home Dashboard Info (getTenantHomeDashboardInfo) #
POST /api/edge/{edgeId}/dashboard/{dashboardId} Assign Dashboard to Edge (assignDashboardToEdge) #
DELETE /api/edge/{edgeId}/dashboard/{dashboardId} Unassign Dashboard from Edge (unassignDashboardFromEdge) #
POST /api/dashboard Create or Update Dashboard (saveDashboard) #
POST /api/dashboard/{dashboardId}/customers Update the Dashboard Customers (updateDashboardCustomers) #
POST /api/dashboard/{dashboardId}/customers/remove Remove the Dashboard Customers (removeDashboardCustomers) #
POST /api/dashboard/{dashboardId}/customers/add Adds the Dashboard Customers (addDashboardCustomers) #
POST /api/customer/{customerId}/dashboard/{dashboardId} Assign the Dashboard (assignDashboardToCustomer) #
DELETE /api/customer/{customerId}/dashboard/{dashboardId} Unassign the Dashboard (unassignDashboardFromCustomer) #
POST /api/customer/public/dashboard/{dashboardId} Assign the Dashboard to Public Customer (assignDashboardToPublicCustomer) #
DELETE /api/customer/public/dashboard/{dashboardId} Unassign the Dashboard from Public Customer… #
GET /api/tenant/{tenantId}/dashboards Get Tenant Dashboards by System Administrator (getTenantDashboards) #
GET /api/tenant/dashboards Get Tenant Dashboards (getTenantDashboards) #
GET /api/edge/{edgeId}/dashboards Get Edge Dashboards (getEdgeDashboards) #
GET /api/dashboards Get Dashboards by Dashboard Ids (getDashboardsByIds) #
GET /api/dashboard/{dashboardId} Get Dashboard (getDashboardById) #
DELETE /api/dashboard/{dashboardId} Delete the Dashboard (deleteDashboard) #
GET /api/dashboard/serverTime Get Server Time (getServerTime) #
GET /api/dashboard/maxDatapointsLimit Get Max Data Points Limit (getMaxDatapointsLimit) #
GET /api/dashboard/info/{dashboardId} Get Dashboard Info (getDashboardInfoById) #
GET /api/dashboard/home Get Home Dashboard (getHomeDashboard) #
GET /api/dashboard/home/info Get Home Dashboard Info (getHomeDashboardInfo) #
GET /api/customer/{customerId}/dashboards Get Customer Dashboards (getCustomerDashboards) #

Documentation

📖
Documentation
https://thingsboard.io/docs/reference/rest-api/
📖
Documentation
https://thingsboard.io/docs/user-guide/assets/
📖
Documentation
https://thingsboard.io/docs/user-guide/telemetry/
📖
Documentation
https://thingsboard.io/docs/user-guide/alarms/
📖
Documentation
https://thingsboard.io/docs/user-guide/rule-engine-2-0/re-getting-started/
📖
Documentation
https://thingsboard.io/docs/user-guide/rpc/
📖
Documentation
https://thingsboard.io/docs/user-guide/dashboards/
📖
Documentation
https://thingsboard.io/docs/user-guide/ui/customers/
📖
Documentation
https://thingsboard.io/docs/user-guide/notifications/
📖
Documentation
https://thingsboard.io/docs/edge/
📖
Documentation
https://thingsboard.io/docs/user-guide/mobile-app/
📖
Documentation
https://thingsboard.io/docs/user-guide/lwm2m/
📖
Documentation
https://thingsboard.io/products/trendz/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/openapi/thingsboard-dashboard-controller-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-device-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-deviceprofile-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-asset-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-assetprofile-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-entityrelation-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-alarm-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-rulechain-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-dashboard-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-tenant-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-customer-schema.json
📊
JSONSchema
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-dashboard-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

thingsboard-dashboard-controller-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: ThingsBoard Dashboards Dashboard Controller API
  description: 'ThingsBoard Dashboards API — subset of the ThingsBoard REST API (open-source IoT platform). Covers: Dashboard, Widget Type, Widgets Bundle, Image, Tb Resource, Ui Settings.'
  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 (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/openapi/thingsboard-dashboard-controller-api-openapi.yml