ThingsBoard

ThingsBoard ui-settings-controller API

Ui Settings

Documentation GitHub OpenAPI

Documentation

https://thingsboard.io/docs/reference/rest-api/

https://thingsboard.io/docs/user-guide/assets/

https://thingsboard.io/docs/user-guide/telemetry/

https://thingsboard.io/docs/user-guide/alarms/

https://thingsboard.io/docs/user-guide/rule-engine-2-0/re-getting-started/

https://thingsboard.io/docs/user-guide/rpc/

https://thingsboard.io/docs/user-guide/dashboards/

https://thingsboard.io/docs/user-guide/ui/customers/

https://thingsboard.io/docs/user-guide/notifications/

https://thingsboard.io/docs/edge/

https://thingsboard.io/docs/user-guide/mobile-app/

https://thingsboard.io/docs/user-guide/lwm2m/

https://thingsboard.io/products/trendz/

Specifications

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/openapi/thingsboard-ui-settings-controller-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-device-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-deviceprofile-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-asset-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-assetprofile-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-entityrelation-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-alarm-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-rulechain-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-dashboard-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-tenant-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-customer-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-user-schema.json

OpenAPI Specification

openapi: 3.1.0
info:
  title: ThingsBoard Admin admin-controller ui-settings-controller API
  description: 'ThingsBoard Admin API — subset of the ThingsBoard REST API (open-source IoT platform). Covers: Admin, Audit Log, Event, Usage Info, Queue, Queue Stats, Mail Config Template, Qr Code Settings, Job.'
  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:
- name: ui-settings-controller
  description: Ui Settings
paths:
  /api/uiSettings/helpBaseUrl:
    get:
      tags:
      - ui-settings-controller
      summary: Get UI Help Base Url (getHelpBaseUrl)
      description: Get UI help base url used to fetch help assets. The actual value of the base url is configurable in the system configuration file.
      operationId: getHelpBaseUrl
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
components:
  securitySchemes:
    HTTP login form:
      type: http
      description: Enter Username / Password
      scheme: loginPassword
      bearerFormat: /api/auth/login|X-Authorization
    API key form:
      type: apiKey
      description: 'Enter the API key value with ''ApiKey'' prefix in format: **ApiKey <your_api_key_value>**


        Example: **ApiKey tb_5te51SkLRYpjGrujUGwqkjFvooWBlQpVe2An2Dr3w13wjfxDW**


        <br>**NOTE**: Use only ONE authentication method at a time. If both are authorized, JWT auth takes the priority.<br>

        '
      name: X-Authorization
      in: header