Get Alarm

GET

/api/public/v1/alarms/{id}

This endpoint returns information about a given alarm, including its conditions and its current state.

Alarms of type basic return conditions, alarms of type inactivity return inactivityConditions.

Request

Path Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Bodyapplication/json

Examples

Success basicSuccess inactivity

{
    "id": 1,
    "name": "High temperature",
    "type": "basic",
    "function": "AND",
    "up": true,
    "disabled": false,
    "createdAt": "2025-03-19 08:14:02",
    "updatedAt": "2025-03-24 17:41:55",
    "conditions": [
        {
            "id": 1,
            "entity": {
                "id": 1,
                "urn": "urn:ngsi-ld:Device:oneFiware"
            },
            "measure": "temperature",
            "condition": "gt",
            "threshold": [
                "30"
            ],
            "period": {
                "from": "08:00",
                "to": "20:00"
            }
        }
    ]
}

Modified at 2026-09-15 12:25:55

Paginate Alarms

SimpleAlarm