canonical: https://jentic.com/apis/swaggerhub.legrandcare/alma-alarm-system-api

# Legrandcare ALMA Alarm System API

API to manage and retrieve ALMA historical alarms and related metadata. The API exposes 7 endpoints.

## For AI agents

Programmatically retrieve historical alarms with pagination, sorting, and filtering, retrieve detailed information about a specific alarm. Covers 7 operations.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Retrieve historical alarms with pagination, sorting, and filtering
- Manage developer tools data programmatically
- Integrate ALMA Alarm System API into automated workflows
- Query and filter ALMA Alarm System API records by parameters
- Monitor ALMA Alarm System API operational status and events

## Use cases

### Developer Tools Operations

Use the ALMA Alarm System API to perform developer tools operations programmatically. The API provides 7 endpoints covering core functionality including retrieve historical alarms with pagination, sorting, and filtering, retrieve detailed information about a specific alarm, retrieve all possible alarm states.

Example prompt: Call GET /alarms to retrieve historical alarms with pagination, sorting, and filtering

### Automated Alarm Hist States Management

Automate alarm hist states operations by combining multiple ALMA Alarm System API endpoints. Agents can retrieve detailed information about a specific alarm and then retrieve all possible alarm states in a single workflow.

Example prompt: Call GET /alarms/{id} to retrieve detailed information about a specific alarm, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call ALMA Alarm System API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle none tokens manually.

Example prompt: Search Jentic for 'retrieve historical alarms with pagination, sorting, and filtering', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /alarms | Retrieve historical alarms with pagination, sorting, and filtering |
| GET | /alarms/{id} | Retrieve detailed information about a specific alarm |
| GET | /alarm-states | Retrieve all possible alarm states |
| GET | /alarm-hist-states | Retrieve all possible alarm hist states (alive or terminated) |
| GET | /alarm-types | Retrieve all possible alarm types |
| GET | /locations | Retrieve all possible locations |
| GET | /sources | Retrieve all possible sources |

## Key resources

- **Alarm Hist States** — Operations for alarm hist states
- **Alarm States** — Operations for alarm states
- **Alarm Types** — Operations for alarm types
- **Alarms** — Operations for alarms
- **Locations** — Operations for locations

## Why Jentic

- **Setup:** Wiring ALMA Alarm System API by hand means supplying your own host and threading alarm ids and filters through its read routes yourself. Through Jentic you install once, import ALMA Alarm System API from the API Directory, and your agent calls it without you hand-building each request.
- **Permission scoping:** ALMA Alarm System API puts the alarm id in the URL path (/alarms/{id}), so a rule can pin your agent to reading one alarm. Every exposed operation is read-only, and you choose which of them the agent may call.
- **Credential handling:** Any ALMA Alarm System API credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list historical alarms' or 'read one alarm by id', and Jentic returns the matching ALMA Alarm System API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the ALMA Alarm System API use?

The ALMA Alarm System API uses no authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I retrieve historical alarms with pagination, sorting, and filtering with the ALMA Alarm System API?

Yes. Use the GET /alarms endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the ALMA Alarm System API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I retrieve historical alarms with pagination, sorting, and filtering through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'retrieve historical alarms with pagination, sorting, and filtering'. Jentic returns the matching ALMA Alarm System API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the ALMA Alarm System API have?

The ALMA Alarm System API exposes 7 endpoints covering alarm hist states, alarm states, alarm types operations.

### Can I limit what my agent is allowed to do with the ALMA Alarm System API?

Yes. Because you run Jentic One yourself, your own rules decide which of the ALMA Alarm System API operations the agent may call and which credentials it may use. Every exposed endpoint is read-only, so you can grant listing historical alarms, alarm states, alarm types, locations, or sources while withholding the rest. Since the alarm id sits in the URL path at GET /alarms/{id}, you can pin the agent to reading a single alarm rather than the full history.