Cumulocity

Cumulocity Alarms API

The Alarms API from Cumulocity — 2 operation(s) for alarms.

GitHub OpenAPI
Business capability
IT Operations Management BC-600.40

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /alarm/alarms List alarms raised on devices · List Alarms #
Ask an LLM
“Which alarms are currently active on my Cumulocity devices?”
“Can I filter the alarm list by severity, such as only critical ones?”
Tell an agent
List active alarms for device {source}.
Show all {severity} alarms raised since {dateFrom}.
POST /alarm/alarms Raise a new alarm for a device · Raise an Alarm #
Ask an LLM
“How can I raise an alarm against a device from my own code?”
“What fields are required when creating a new alarm, like severity and text?”
Tell an agent
Raise a {severity} alarm of type {type} on device {source} saying "{text}" at {time}.
Create a new {status} alarm for device {source} with message {text}.
PUT /alarm/alarms Update many alarms at once by filter · Bulk Update Alarms #
Ask an LLM
“How do I acknowledge every active alarm on a device in one call?”
“Can I change the status of all alarms matching a filter at once?”
Tell an agent
Set every {status} alarm on device {source} to ACKNOWLEDGED in bulk.
Bulk-clear all alarms raised by device {source}.
DELETE /alarm/alarms Delete alarms matching a filter · Delete Alarms by Filter #
Ask an LLM
“Is there a way to purge a whole batch of old alarms by filter?”
“Can I wipe out many alarms in one request instead of one at a time?”
Tell an agent destructive · confirm first
Delete all alarms matching the current filter.
Purge the alarm collection by filter in a single request.
GET /alarm/alarms/{id} Look up a single alarm by ID · Retrieve an Alarm #
Ask an LLM
“How do I fetch the full details of one alarm by its ID?”
“What severity and status does a specific alarm have right now?”
Tell an agent
Show me alarm {id}.
Get the severity, count and first occurrence time of alarm {id}.
PUT /alarm/alarms/{id} Change the status or text of one alarm · Update an Alarm #
Ask an LLM
“How do I acknowledge or clear one specific alarm?”
“Can I change the severity of an alarm I already raised?”
Tell an agent
Set the status of alarm {id} to {status}.
Change alarm {id} to severity {severity} with text {text}.

Documentation

📖
Documentation
https://cumulocity.com/api/core/
📖
Documentation
https://cumulocity.com/docs/concepts/domain-model/
📖
Documentation
https://cumulocity.com/docs/device-integration/device-integration-introduction/
📖
Documentation
https://cumulocity.com/docs/microservice-sdk/
📖
Documentation
https://cumulocity.com/docs/reference/notifications/
📖
Documentation
https://cumulocity.com/api/datahub/
📖
Documentation
https://cumulocity.com/docs/datahub/datahub-overview/
📖
Documentation
https://cumulocity.com/api/dtm/
📖
Documentation
https://cumulocity.com/docs/digital-twin-manager/dtm-overview/
📖
Documentation
https://cumulocity.com/api/edge/
📖
Documentation
https://cumulocity.com/docs/edge/edge-overview/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/openapi/cumulocity-alarms-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/asyncapi/cumulocity-notification2-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-schema/cumulocity-managed-object-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-schema/cumulocity-measurement-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-schema/cumulocity-event-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-schema/cumulocity-alarm-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-ld/cumulocity-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cumulocity:cumulocity-alarms-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cumulocity-alarms-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cumulocity Alarm Alarms API
  version: 10.20.0
  description: 'Raise, query, acknowledge, clear, and bulk-update alarms with four severity levels (CRITICAL, MAJOR,

    MINOR, WARNING) and four statuses (ACTIVE, ACKNOWLEDGED, CLEARED). Cumulocity auto-deduplicates alarms

    by source + type so repeated raises increment the count rather than creating duplicates.'
servers:
- url: https://{tenant}.cumulocity.com
  variables:
    tenant:
      default: example
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Alarms
paths:
  /alarm/alarms:
    get:
      tags:
      - Alarms
      summary: List Alarms
      operationId: listAlarms
      parameters:
      - name: source
        in: query
        schema:
          type: string
      - name: status
        in: query
        schema:
          type: string
          enum:
          - ACTIVE
          - ACKNOWLEDGED
          - CLEARED
      - name: severity
        in: query
        schema:
          type: string
          enum:
          - CRITICAL
          - MAJOR
          - MINOR
          - WARNING
      - name: type
        in: query
        schema:
          type: string
      - name: dateFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: dateTo
        in: query
        schema:
          type: string
          format: date-time
      - name: resolved
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: A collection of alarms.
          content:
            application/vnd.com.nsn.cumulocity.alarmCollection+json:
              schema:
                $ref: '#/components/schemas/AlarmCollection'
    post:
      tags:
      - Alarms
      summary: Raise an Alarm
      operationId: createAlarm
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.alarm+json:
            schema:
              $ref: '#/components/schemas/Alarm'
      responses:
        '201':
          description: Alarm raised (or count incremented if duplicate).
          content:
            application/vnd.com.nsn.cumulocity.alarm+json:
              schema:
                $ref: '#/components/schemas/Alarm'
    put:
      tags:
      - Alarms
      summary: Bulk Update Alarms
      operationId: bulkUpdateAlarms
      parameters:
      - name: source
        in: query
        schema:
          type: string
      - name: status
        in: query
        schema:
          type: string
      requestBody:
        content:
          application/vnd.com.nsn.cumulocity.alarm+json:
            schema:
              $ref: '#/components/schemas/Alarm'
      responses:
        '200':
          description: Alarms updated.
    delete:
      tags:
      - Alarms
      summary: Delete Alarms by Filter
      operationId: deleteAlarms
      responses:
        '204':
          description: Alarms deleted.
  /alarm/alarms/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Alarms
      summary: Retrieve an Alarm
      operationId: getAlarm
      responses:
        '200':
          description: A single alarm.
          content:
            application/vnd.com.nsn.cumulocity.alarm+json:
              schema:
                $ref: '#/components/schemas/Alarm'
    put:
      tags:
      - Alarms
      summary: Update an Alarm
      operationId: updateAlarm
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.alarm+json:
            schema:
              $ref: '#/components/schemas/Alarm'
      responses:
        '200':
          description: Alarm updated.
components:
  schemas:
    Alarm:
      type: object
      required:
      - time
      - type
      - text
      - source
      - severity
      - status
      properties:
        id:
          type: string
          readOnly: true
        self:
          type: string
          format: uri
          readOnly: true
        time:
          type: string
          format: date-time
        creationTime:
          type: string
          format: date-time
          readOnly: true
        type:
          type: string
        text:
          type: string
        severity:
          type: string
          enum:
          - CRITICAL
          - MAJOR
          - MINOR
          - WARNING
        status:
          type: string
          enum:
          - ACTIVE
          - ACKNOWLEDGED
          - CLEARED
        count:
          type: integer
          readOnly: true
        firstOccurrenceTime:
          type: string
          format: date-time
          readOnly: true
        source:
          type: object
          properties:
            id:
              type: string
            self:
              type: string
              format: uri
      additionalProperties: true
    AlarmCollection:
      type: object
      properties:
        self:
          type: string
          format: uri
        alarms:
          type: array
          items:
            $ref: '#/components/schemas/Alarm'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT