Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIIDA Alarms API

Alarm configuration and management

APIIDA Alarms API is one of 6 APIs that APIIDA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Alarms. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

This API exposes 2 operations across 1 path, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://{tenant}.backend.apiida.io.

2 operations 1 paths 2 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.apiida.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

APIIDA Alarms API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token authentication

Paths & Operations 2

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

Alarms 2

Alarm configuration and management

GET
/alarms
APIIDA List Alarm Configurations
listAlarms → 200401
POST
/alarms
APIIDA Create an Alarm
createAlarm body → 201400401

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Alarm (8 properties), AlarmRequest (6 properties). Each schema is shown below with its type and property counts.

AlarmRequest
object
6 properties 5 required
Alarm
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apiida-alarms-api-openapi.yml Raw ↑

Other APIs APIIDA publishes across the network.

APIIDA Apis API
APIIDA Deployments API
APIIDA Gateways API
APIIDA Monitoring API
APIIDA Versions API