How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ThingsBoard admin-controller API

Admin

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

This API exposes 24 operations across 18 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 4.3.0.3DEMO.

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

24 operations 18 paths 21 schemas 2 DELETE14 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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 admin-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 24

Across 18 paths, the API surfaces 24 operations — 2 DELETE, 14 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

admin-controller 24

Admin

POST
/api/admin/settings
Creates or Updates the Administration Settings (saveAdminSettings)
saveAdminSettings body → 200
POST
/api/admin/settings/testSms
Send Test Sms (sendTestSms)
sendTestSms body → 200
POST
/api/admin/settings/testMail
Send Test Email (sendTestMail)
sendTestMail body → 200
GET
/api/admin/securitySettings
Get the Security Settings Object (getSecuritySettings)
getSecuritySettings → 200
POST
/api/admin/securitySettings
Update Security Settings (saveSecuritySettings)
saveSecuritySettings body → 200
GET
/api/admin/repositorySettings
Get Repository Settings (getRepositorySettings)
getRepositorySettings → 200
POST
/api/admin/repositorySettings
Creates or Updates the Repository Settings (saveRepositorySettings)
saveRepositorySettings body → 200
DELETE
/api/admin/repositorySettings
Delete Repository Settings (deleteRepositorySettings)
deleteRepositorySettings → 200
POST
/api/admin/repositorySettings/checkAccess
Check Repository Access (checkRepositoryAccess)
checkRepositoryAccess body → 200
GET
/api/admin/jwtSettings
Get the JWT Settings Object (getJwtSettings)
getJwtSettings → 200
POST
/api/admin/jwtSettings
Update JWT Settings (saveJwtSettings)
saveJwtSettings body → 200
GET
/api/admin/autoCommitSettings
Get Auto Commit Settings (getAutoCommitSettings)
getAutoCommitSettings → 200
POST
/api/admin/autoCommitSettings
Creates or Updates the Auto Commit Settings (saveAutoCommitSettings)
saveAutoCommitSettings body → 200
DELETE
/api/admin/autoCommitSettings
Delete Auto Commit Settings (deleteAutoCommitSettings)
deleteAutoCommitSettings → 200
GET
/api/admin/updates
Check for New Platform Releases (checkUpdates)
checkUpdates → 200
GET
/api/admin/systemInfo
Get System Info (getSystemInfo)
getSystemInfo → 200
GET
/api/admin/settings/{key}
Get the Administration Settings Object Using Key (getAdminSettings)
getAdminSettings 1 param → 200
GET
/api/admin/repositorySettings/info
getRepositorySettingsInfo → 200
GET
/api/admin/repositorySettings/exists
Check Repository Settings Exists (repositorySettingsExists)
repositorySettingsExists → 200
GET
/api/admin/mail/oauth2/loginProcessingUrl
Get OAuth2 Log in Processing URL (getMailProcessingUrl)
getMailProcessingUrl → 200
GET
/api/admin/mail/oauth2/code
codeProcessingUrl 2 params → 200
GET
/api/admin/mail/oauth2/authorize
Redirect User to Mail Provider Login Page.
getAuthorizationUrl → 200
GET
/api/admin/featuresInfo
Get Features Info (getFeaturesInfo)
getFeaturesInfo → 200
GET
/api/admin/autoCommitSettings/exists
Check Auto Commit Settings Exists (autoCommitSettingsExists)
autoCommitSettingsExists → 200

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are RepositorySettings (11 properties), UserPasswordPolicy (10 properties), SystemInfoData (8 properties), UpdateMessage (6 properties). Each schema is shown below with its type and property counts.

AutoVersionCreateConfig
object
5 properties
JwtSettings
object
A JSON value representing the JWT Settings.
4 properties
SmsProviderConfiguration
object
1 property 1 required
TestSmsRequest
object
A JSON value representing the Test SMS request.
3 properties
RepositorySettings
object
A JSON value representing the Repository Settings.
11 properties
FeaturesInfo
object
5 properties
AdminSettings
object
A JSON value representing the Mail Settings.
5 properties
TenantId
object
2 properties 2 required
TwilioSmsProviderConfiguration
UpdateMessage
object
6 properties
SmppSmsProviderConfiguration
5 required
AdminSettingsId
object
2 properties 2 required
SecuritySettings
object
A JSON value representing the Security Settings.
6 properties 2 required
AutoCommitSettings
object
AwsSnsSmsProviderConfiguration
SystemInfo
object
2 properties
RepositorySettingsInfo
object
2 properties
JsonNode
A value representing the any type (object or primitive)
JwtPair
object
JWT Pair
3 properties
SystemInfoData
object
8 properties
UserPasswordPolicy
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs ThingsBoard publishes across the network.

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
ThingsBoard dashboard-controller API
Where this information came from

This is an independent, third-party profile of ThingsBoard admin-controller API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.