Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ThingsBoard domain-controller API

Domain

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

This API exposes 5 operations across 5 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 4.3.0.3DEMO.

Requests are made against 2 base URLs: https://demo.thingsboard.io, http://localhost:8080.

5 operations 5 paths 7 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.3.0.3DEMO
Servers
https://demo.thingsboard.io
http://localhost:8080
Authentication
HTTP Loginpassword, API Key
License
Resource Areas
1

Authentication & Security 2

ThingsBoard domain-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 5

Across 5 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

domain-controller 5

Domain

PUT
/api/domain/{id}/oauth2Clients
Update Oauth2 Clients (updateOauth2Clients)
updateOauth2Clients_1 1 param body → 200
POST
/api/domain
Save or Update Domain (saveDomain)
saveDomain 1 param body → 200
GET
/api/domain/infos
Get Domain Infos (getTenantDomainInfos)
getTenantDomainInfos 5 params → 200
GET
/api/domain/info/{id}
Get Domain Info by Id (getDomainInfoById)
getDomainInfoById 1 param → 200
DELETE
/api/domain/{id}
Delete Domain by ID (deleteDomain)
deleteDomain 1 param → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are DomainInfo (7 properties), OAuth2ClientInfo (6 properties), Domain (6 properties), PageDataDomainInfo (4 properties). Each schema is shown below with its type and property counts.

DomainId
object
2 properties 2 required
Domain
object
A JSON value representing the Domain.
6 properties 1 required
PageDataDomainInfo
object
4 properties
OAuth2ClientId
object
2 properties 2 required
TenantId
object
2 properties 2 required
OAuth2ClientInfo
object
6 properties
DomainInfo
object
7 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs ThingsBoard publishes across the network.

ThingsBoard admin-controller API
ThingsBoard ai-model-controller API
ThingsBoard alarm-comment-controller API
ThingsBoard alarm-controller API
ThingsBoard api-key-controller API
ThingsBoard asset-controller API
ThingsBoard asset-profile-controller API
ThingsBoard audit-log-controller API
ThingsBoard auth-controller API
ThingsBoard calculated-field-controller API
ThingsBoard component-descriptor-controller API
ThingsBoard customer-controller API