APIIDA

APIIDA Alarms API

Alarm configuration and management

GitHub OpenAPI

Operations 2

GET /alarms APIIDA List Alarm Configurations #
POST /alarms APIIDA Create an Alarm #

Documentation

📖
Documentation
https://apiida.com/product/apiida-api-control-plane/
📖
Documentation
https://apiida.com/product/apiida-api-gateway-manager/
📖
Documentation
https://apiida.atlassian.net/wiki/spaces/AAGM

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/apiida/refs/heads/main/openapi/apiida-alarms-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/apiida/refs/heads/main/json-schema/apiida-api.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/apiida/refs/heads/main/json-schema/apiida-deployment.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/apiida/refs/heads/main/json-schema/apiida-gateway.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/apiida/refs/heads/main/json-ld/apiida-context.jsonld
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/apiida/refs/heads/main/apis.yml

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/apiida-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

apiida-alarms-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: APIIDA API Control Plane Alarms API
  description: REST API for the APIIDA API Control Plane, enabling programmatic management of APIs across multiple API gateways. Supports validation of proxy specifications, API version management, and deployment to gateways.
  version: '1.0'
  contact:
    name: APIIDA Support
    url: https://www.apiida.com
servers:
- url: https://{tenant}.backend.apiida.io
  description: APIIDA Backend
  variables:
    tenant:
      description: Your APIIDA tenant identifier
      default: example
security:
- bearerAuth: []
tags:
- name: Alarms
  description: Alarm configuration and management
paths:
  /alarms:
    get:
      operationId: listAlarms
      summary: APIIDA List Alarm Configurations
      description: Retrieve all configured alarm rules for monitored gateways.
      tags:
      - Alarms
      responses:
        '200':
          description: List of alarm configurations
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Alarm'
                  total:
                    type: integer
        '401':
          description: Unauthorized
    post:
      operationId: createAlarm
      summary: APIIDA Create an Alarm
      description: Create a new alarm rule for gateway monitoring.
      tags:
      - Alarms
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlarmRequest'
      responses:
        '201':
          description: Alarm created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alarm'
        '400':
          description: Invalid alarm configuration
        '401':
          description: Unauthorized
components:
  schemas:
    Alarm:
      type: object
      properties:
        id:
          type: string
          description: Alarm identifier
        name:
          type: string
          description: Alarm name
        gatewayId:
          type: string
          description: Target gateway identifier
        metric:
          type: string
          description: Metric to monitor
        threshold:
          type: number
          description: Threshold value to trigger alarm
        condition:
          type: string
          enum:
          - above
          - below
          - equals
          description: Threshold comparison condition
        enabled:
          type: boolean
        createdAt:
          type: string
          format: date-time
    AlarmRequest:
      type: object
      required:
      - name
      - gatewayId
      - metric
      - threshold
      - condition
      properties:
        name:
          type: string
        gatewayId:
          type: string
        metric:
          type: string
        threshold:
          type: number
        condition:
          type: string
          enum:
          - above
          - below
          - equals
        enabled:
          type: boolean
          default: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token authentication
externalDocs:
  description: APIIDA Documentation
  url: https://apiida.atlassian.net