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 notification-rule-controller API

Notification Rule

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

This API exposes 4 operations across 3 paths, and defines 25 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.

4 operations 3 paths 25 schemas 1 DELETE2 GET1 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 notification-rule-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 4

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

notification-rule-controller 4

Notification Rule

POST
/api/notification/rule
Save Notification Rule (saveNotificationRule)
saveNotificationRule body → 200
GET
/api/notification/rules
Get Notification Rules (getNotificationRules)
getNotificationRules 5 params → 200
GET
/api/notification/rule/{id}
Get Notification Rule by Id (getNotificationRuleById)
getNotificationRuleById 1 param → 200
DELETE
/api/notification/rule/{id}
Delete Notification Rule (deleteNotificationRule)
deleteNotificationRule 1 param → 200

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are NotificationRuleInfo (12 properties), NotificationRule (10 properties), PageDataNotificationRuleInfo (4 properties), NotificationTemplateId (2 properties). Each schema is shown below with its type and property counts.

AlarmCommentNotificationRuleTriggerConfig
NotificationRuleId
object
2 properties 2 required
PageDataNotificationRuleInfo
object
4 properties
NotificationRuleConfig
object
1 property
TaskProcessingFailureNotificationRuleTriggerConfig
NotificationRuleInfo
object
12 properties 5 required
ApiUsageLimitNotificationRuleTriggerConfig
AlarmNotificationRuleTriggerConfig
1 required
ClearRule
object
1 property
RuleEngineComponentLifecycleEventNotificationRuleTriggerConfig
EdgeConnectionNotificationRuleTriggerConfig
NewPlatformVersionNotificationRuleTriggerConfig
EdgeCommunicationFailureNotificationRuleTriggerConfig
NotificationRule
object
10 properties 5 required
TenantId
object
2 properties 2 required
NotificationRuleTriggerConfig
object
1 property
ResourcesShortageNotificationRuleTriggerConfig
DeviceActivityNotificationRuleTriggerConfig
1 required
NotificationTemplateId
object
2 properties 2 required
AlarmAssignmentNotificationRuleTriggerConfig
1 required
EntityActionNotificationRuleTriggerConfig
RateLimitsNotificationRuleTriggerConfig
EscalatedNotificationRuleRecipientsConfig
2 required
EntitiesLimitNotificationRuleTriggerConfig
NotificationRuleRecipientsConfig
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thingsboard-notification-rule-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 notification-rule-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.