canonical: https://jentic.com/apis/thingsboard.io/thingsboard

# ThingsBoard REST API

ThingsBoard open-source IoT platform REST API documentation. The API exposes 496 endpoints secured with apiKey, loginPassword authentication.

## For AI agents

Programmatically login method to get user jwt token data, refresh user jwt token data. Covers 496 operations with apiKey, loginPassword authentication.

## Scope

Does not handle payments, communications, or crm - use for iot and hardware only.

## Capabilities

- 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

### 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).

Example prompt: 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.

Example prompt: 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.

Example prompt: Search Jentic for 'login method to get user jwt token data', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| 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 |

## Key resources

- **.Well Known** — Operations for .well known
- **2Fa** — Operations for 2fa
- **Admin** — Operations for admin
- **Ai** — Operations for ai
- **Alarm** — Operations for alarm

## Why Jentic

- **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 handling:** 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.
- **Discovery method:** 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

- **Particle** — Alternative iot API
- **Stripe** — Complementary API for broader integration workflows
- **Twilio** — Complementary API for broader integration workflows

## FAQ

### 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.