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 image-controller API

Image

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

This API exposes 12 operations across 9 paths, and defines 8 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.

12 operations 9 paths 8 schemas 1 DELETE6 GET1 POST4 PUT

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

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

image-controller 12

Image

GET
/api/images/{type}/{key}
downloadImage 4 params → 200
PUT
/api/images/{type}/{key}
updateImage 2 params body → 200
DELETE
/api/images/{type}/{key}
deleteImage 3 params → 200
PUT
/api/images/{type}/{key}/public/{isPublic}
updateImagePublicStatus 3 params → 200
GET
/api/images/{type}/{key}/info
getImageInfo 2 params → 200
PUT
/api/images/{type}/{key}/info
updateImageInfo 2 params body → 200
PUT
/api/image/import
importImage body → 200
POST
/api/image
uploadImage body → 200
GET
/api/images
getImages 7 params → 200
GET
/api/images/{type}/{key}/preview
downloadImagePreview 4 params → 200
GET
/api/images/{type}/{key}/export
exportImage 2 params → 200
GET
/api/images/public/{publicResourceKey}
downloadPublicImage 3 params → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are TbResourceInfo (15 properties), ResourceExportData (11 properties), PageDataTbResourceInfo (4 properties), TbImageDeleteResult (2 properties). Each schema is shown below with its type and property counts.

TbImageDeleteResult
object
2 properties
TenantId
object
2 properties 2 required
HasIdObject
object
1 property
TbResourceInfo
object
A JSON value representing the Resource Info.
15 properties
JsonNode
A value representing the any type (object or primitive)
ResourceExportData
object
11 properties
PageDataTbResourceInfo
object
4 properties
TbResourceId
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thingsboard-image-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
Where this information came from

This is an independent, third-party profile of ThingsBoard image-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.