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 entities-version-control-controller API

Entities Version Control

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

This API exposes 12 operations across 11 paths, and defines 80 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 11 paths 80 schemas 10 GET2 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 entities-version-control-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 11 paths, the API surfaces 12 operations — 10 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

entities-version-control-controller 12

Entities Version Control

GET
/api/entities/vc/version
List All Versions (listVersions)
listVersions 6 params → 200
POST
/api/entities/vc/version
Save Entities Version (saveEntitiesVersion)
saveEntitiesVersion body → 200
POST
/api/entities/vc/entity
Load Entities Version (loadEntitiesVersion)
loadEntitiesVersion body → 200
GET
/api/entities/vc/version/{requestId}/status
Get Version Create Request Status (getVersionCreateRequestStatus)
getVersionCreateRequestStatus 1 param → 200
GET
/api/entities/vc/version/{entityType}
List Entity Type Versions (listEntityTypeVersions)
listEntityTypeVersions 7 params → 200
GET
/api/entities/vc/version/{entityType}/{externalEntityUuid}
List Entity Versions (listEntityVersions)
listEntityVersions 8 params → 200
GET
/api/entities/vc/info/{versionId}/{entityType}/{externalEntityUuid}
Get Entity Data Info (getEntityDataInfo)
getEntityDataInfo 3 params → 200
GET
/api/entities/vc/entity/{versionId}
List All Entities at Version (listAllEntitiesAtVersion)
listAllEntitiesAtVersion 1 param → 200
GET
/api/entities/vc/entity/{requestId}/status
Get Version Load Request Status (getVersionLoadRequestStatus)
getVersionLoadRequestStatus 1 param → 200
GET
/api/entities/vc/entity/{entityType}/{versionId}
List Entities at Version (listEntitiesAtVersion)
listEntitiesAtVersion 2 params → 200
GET
/api/entities/vc/diff/{entityType}/{internalEntityUuid}
Compare Entity Data to Version (compareEntityDataToVersion)
compareEntityDataToVersion 3 params → 200
GET
/api/entities/vc/branches
List Branches (listBranches)
listBranches → 200

Schemas 80

The contract defines 80 schemas that model the data the API accepts and returns. The most detailed are OtaPackage (18 properties), Device (13 properties), WidgetTypeDetails (13 properties), RuleNode (13 properties). Each schema is shown below with its type and property counts.

EntityExportDataObject
object
5 properties
OtaPackageId
object
2 properties 2 required
AttributeExportData
object
7 properties
EntityLoadError
object
4 properties
VersionLoadRequest
object
2 properties
AttributesOutput
Argument
object
6 properties
EntityDataDiff
object
2 properties
EntityDataInfo
object
4 properties
RelationPathLevel
object
2 properties 2 required
SnmpDeviceTransportConfiguration
WidgetsBundle
object
A JSON value representing the Widget Bundle.
11 properties
CoapDeviceTransportConfiguration
OutputStrategy
TenantId
object
2 properties 2 required
EntityTypeVersionLoadRequest
CalculatedField
object
11 properties 1 required
RuleChain
object
A JSON value representing the rule chain.
11 properties 2 required
WidgetsBundleExportData
DeviceId
object
2 properties 2 required
WidgetTypeId
object
2 properties 2 required
RuleChainId
object
2 properties 2 required
EntityTypeVersionCreateConfig
object
7 properties
VersionLoadResult
object
3 properties
VersionCreationResult
object
6 properties
OtaPackage
object
18 properties
RuleNode
object
13 properties
MqttDeviceTransportConfiguration
CfArgumentDynamicSourceConfiguration
object
1 property 1 required
ResourceExportData
object
11 properties
RelationPathQueryDynamicSourceConfiguration
AttributesRuleChainOutputStrategy
DeviceCredentialsId
object
1 property 1 required
CustomerId
object
2 properties 2 required
DefaultDeviceTransportConfiguration
DeviceProfileId
object
2 properties 2 required
NodeConnectionInfo
object
3 properties 3 required
VersionLoadConfig
object
4 properties
OtaPackageExportData
Device
object
13 properties 2 required
DebugSettings
object
3 properties
BranchInfo
object
2 properties
DeviceExportData
RuleChainExportData
Lwm2mDeviceTransportConfiguration
DeviceCredentials
object
A JSON value representing the device credentials.
7 properties 3 required
RuleChainConnectionInfo
object
4 properties 4 required
TimeSeriesRuleChainOutputStrategy
EntityTypeLoadResult
object
4 properties
DefaultDeviceConfiguration
DeviceData
object
2 properties
RuleChainMetaData
object
A JSON value representing the rule chain metadata.
6 properties 5 required
CurrentOwnerDynamicSourceConfiguration
RuleNodeId
object
2 properties 2 required
AttributesImmediateOutputStrategy
TimeSeriesOutput
Output
object
5 properties 1 required
CalculatedFieldId
object
2 properties 2 required
VersionCreateConfig
object
4 properties
AttributesOutputStrategy
object
1 property 1 required
EntityTypeVersionLoadConfig
object
6 properties
SimpleCalculatedFieldConfiguration
object
4 properties 2 required
DeviceConfiguration
object
1 property 1 required
TimeSeriesOutputStrategy
object
1 property 1 required
EntityRelation
object
A JSON value representing the relation.
6 properties 4 required
WidgetTypeExportData
PageDataEntityVersion
object
4 properties
VersionedEntityInfo
object
1 property
SingleEntityVersionLoadRequest
WidgetsBundleId
object
2 properties 2 required
ComplexVersionCreateRequest
VersionCreateRequest
object
3 properties
TimeSeriesImmediateOutputStrategy
EntityId
object
2 properties 2 required
EntityVersion
object
4 properties
SingleEntityVersionCreateRequest
JsonNode
A value representing the any type (object or primitive)
WidgetTypeDetails
object
A JSON value representing the Widget Type Details.
13 properties
ReferencedEntityKey
object
3 properties
DeviceTransportConfiguration
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thingsboard-entities-version-control-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 entities-version-control-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.