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

Viridi Alarm Controller API

The alarm-controller API from Viridi — 13 operation(s) for alarm-controller.

Viridi Alarm Controller API is one of 56 APIs that Viridi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include alarm-controller. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 14 operations across 13 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 3.7.0.

Requests are made against a single base URL, https://vista.viridiparente.com.

14 operations 13 paths 12 schemas 2 DELETE8 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.7.0
Base URL
https://vista.viridiparente.com
Authentication
HTTP Loginpassword
Resource Areas
1

Authentication & Security 1

Viridi Alarm Controller API declares 1 security scheme for authenticating requests. It uses HTTP loginpassword authentication (HTTP_login_form).

  • HTTP_login_form — Enter Username / Password

Paths & Operations 14

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

alarm-controller 14
POST
/api/alarm
Create or Update Alarm (saveAlarm)
saveAlarm body → 200
POST
/api/alarm/{alarmId}/clear
Clear Alarm (clearAlarm)
clearAlarm 1 param → 200
POST
/api/alarm/{alarmId}/assign/{assigneeId}
Assign/Reassign Alarm (assignAlarm)
assignAlarm 2 params → 200
POST
/api/alarm/{alarmId}/ack
Acknowledge Alarm (ackAlarm)
ackAlarm 1 param → 200
GET
/api/v2/alarms
Get All Alarms (getAllAlarmsV2)
getAllAlarmsV2 11 params → 200
GET
/api/v2/alarm/{entityType}/{entityId}
Get Alarms (getAlarmsV2)
getAlarmsV2 13 params → 200
GET
/api/alarms
Get All Alarms (getAllAlarms)
getAllAlarms 11 params → 200
GET
/api/alarm/{entityType}/{entityId}
Get Alarms (getAlarms)
getAlarms 13 params → 200
GET
/api/alarm/{alarmId}
Get Alarm (getAlarmById)
getAlarmById 1 param → 200
DELETE
/api/alarm/{alarmId}
Delete Alarm (deleteAlarm)
deleteAlarm 1 param → 200
GET
/api/alarm/types
Get Alarm Types (getAlarmTypes)
getAlarmTypes 4 params → 200
GET
/api/alarm/info/{alarmId}
Get Alarm Info (getAlarmInfoById)
getAlarmInfoById 1 param → 200
GET
/api/alarm/highestSeverity/{entityType}/{entityId}
Get Highest Alarm Severity (getHighestAlarmSeverity)
getHighestAlarmSeverity 5 params → 200
DELETE
/api/alarm/{alarmId}/assign
Unassign Alarm (unassignAlarm)
unassignAlarm 1 param → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are AlarmInfo (25 properties), Alarm (22 properties), PageDataAlarmInfo (4 properties), PageDataEntitySubtype (4 properties). Each schema is shown below with its type and property counts.

AlarmInfo
object
25 properties 7 required
UserId
object
2 properties 2 required
AlarmId
object
2 properties 2 required
EntitySubtype
object
3 properties
JsonNode
A value representing the any type (object or primitive)
PageDataEntitySubtype
object
4 properties
AlarmAssignee
object
4 properties
EntityId
object
2 properties 2 required
PageDataAlarmInfo
object
4 properties
Alarm
object
22 properties 7 required
TenantId
object
2 properties 2 required
CustomerId
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

viridi-parente-alarm-controller-api-openapi.yml Raw ↑

Other APIs Viridi publishes across the network.

Viridi Admin Controller API
Viridi Alarm Comment Controller API
Viridi Asset Controller API
Viridi Asset Profile Controller API
Viridi Audit Log Controller API
Viridi Auth Controller API
Viridi Cbrs Controller API
Viridi Component Descriptor Controller API
Viridi Customer Controller API
Viridi Dashboard Controller API
Viridi Device Connectivity Controller API
Viridi Device Controller API
Where this information came from

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