ThingsBoard REST API
42
AI ReadinessNon-Ready (D-)42/100
Official vendor OpenAPI document · agent-readyIOTDevice ManagementapiKey, loginPassword496 EndpointsREST
For Agents
Programmatically login method to get user jwt token data, refresh user jwt token data. Covers 496 operations with apiKey, loginPassword authentication.
Use for: I need to login method to get user jwt token data, I want to refresh user jwt token data, Search for save user settings (saveusersettings), Find all user settings (getusersettings)
Not supported: Does not handle payments, communications, or crm - use for iot and hardware only.
ThingsBoard open-source IoT platform REST API documentation. The API exposes 496 endpoints secured with apiKey, loginPassword authentication.
Install Jentic One Beta
Connect the ThingsBoard REST API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the ThingsBoard REST API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fthingsboard.io%2Fthingsboard" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fthingsboard.io%2Fthingsboard" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with ThingsBoard REST API.
Login method to get user JWT token data
Refresh user JWT token data
Save user settings (saveUserSettings)
Get user settings (getUserSettings)
Update user settings (saveUserSettings)
Use Cases
Patterns agents use ThingsBoard REST API for, with concrete tasks.
★ IoT and Hardware Operations
Use the ThingsBoard REST API to perform iot operations programmatically. The API provides 496 endpoints covering core functionality including login method to get user jwt token data, refresh user jwt token data, save user settings (saveusersettings).
Call POST /api/auth/login to login method to get user jwt token data
Automated .Well Known Management
Automate .well known operations by combining multiple ThingsBoard REST API endpoints. Agents can refresh user jwt token data and then save user settings (saveusersettings) in a single workflow.
Call POST /api/auth/token to refresh user jwt token data, then verify the result
AI Agent Integration via Jentic
AI agents discover and call ThingsBoard REST API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey, loginPassword tokens manually.
Search Jentic for 'login method to get user jwt token data', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
496 endpoints — thingsboard open-source iot platform rest api documentation.
METHOD
PATH
DESCRIPTION
POST
/api/auth/login
Login method to get user JWT token data
POST
/api/auth/token
Refresh user JWT token data
POST
/api/user/settings
Save user settings (saveUserSettings)
GET
/api/user/settings
Get user settings (getUserSettings)
PUT
/api/user/settings
Update user settings (saveUserSettings)
GET
/api/user/settings/{type}
Get user settings (getUserSettings)
PUT
/api/user/settings/{type}
Update user settings (saveUserSettings)
PUT
/api/resource/{id}/info
updateResourceInfo
POST
/api/auth/login
Login method to get user JWT token data
POST
/api/auth/token
Refresh user JWT token data
POST
/api/user/settings
Save user settings (saveUserSettings)
GET
/api/user/settings
Get user settings (getUserSettings)
PUT
/api/user/settings
Update user settings (saveUserSettings)
GET
/api/user/settings/{type}
Get user settings (getUserSettings)
PUT
/api/user/settings/{type}
Update user settings (saveUserSettings)
PUT
/api/resource/{id}/info
updateResourceInfo
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
T
ThingsBoard REST API
- Non-Ready (D-)42/100
36
Foundational Compliance55
Developer Experience & Jentic Compatibility47
AI-Readiness & Agent Experience42
Agent Usability25
Security70
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
36
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: FSignals: 4
43%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
0%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
55
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: CSignals: 4
10%
Example Density
How richly the API is illustrated with examples.
96%
Example Validity
Percentage of examples that conform to their schemas.
26%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
87%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
47
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: D+Signals: 4
45%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
94%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
50%
Summary Coverage
Coverage of summaries across operations/tags/info.
42
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: D-Signals: 1
42%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
25
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
25%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
70
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A-Signals: 1
70%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the ThingsBoard REST API by hand means logging in for a JWT with your username and password or using an ApiKey-prefixed header, refreshing tokens yourself, and handling your own retries. Through Jentic you install once, import the ThingsBoard REST API from the API Directory, store the credential once, and your agent calls it.
Permission scoping
The ThingsBoard REST API puts the settings type in the URL path (/api/user/settings/{type}), so a rule can pin your agent to one settings type: it can read that entry and nothing else. You choose the operations it may call, so writes like saving user settings are not included unless you add them.
Credential isolation
Your ThingsBoard credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'get user settings' or 'refresh an auth token', and Jentic returns the matching ThingsBoard operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
Complementary
Stripe
Complementary API for broader integration workflows
Use alongside ThingsBoard REST API for multi-service workflows
FAQs
Specific to using ThingsBoard REST API through Jentic.
What authentication does the ThingsBoard REST API use?
The ThingsBoard REST API uses apiKey, loginPassword authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.
Can I login method to get user jwt token data with the ThingsBoard REST API?
Yes. Use the POST /api/auth/login endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the ThingsBoard REST API?
Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.
How do I login method to get user jwt token data through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'login method to get user jwt token data'. Jentic returns the matching ThingsBoard REST API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the ThingsBoard REST API have?
The ThingsBoard REST API exposes 496 endpoints covering .well known, 2fa, admin operations.
Can I limit what my agent is allowed to do with the ThingsBoard REST API?
Yes. Because you run Jentic One yourself, your own rules decide which ThingsBoard operations and credentials the agent may use. Since the settings type lives in the URL path (/api/user/settings/{type}), you can pin the agent to a single settings type and let it read that entry and nothing else. You choose the operations it can call, so writes such as saving user settings stay off the list unless you add them.
GET STARTED