APIIDA Monitoring API

openapi: 3.1.0
info:
  title: APIIDA API Control Plane Alarms Monitoring 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: Monitoring
  description: Metrics and monitoring operations
paths:
  /gateways/{gatewayId}/metrics:
    get:
      operationId: getGatewayMetrics
      summary: APIIDA Get Gateway Metrics
      description: Retrieve performance and usage metrics for a specific gateway. Requires the APIIDA solution kit installed on the gateway.
      tags:
      - Monitoring
      parameters:
      - $ref: '#/components/parameters/gatewayId'
      - name: from
        in: query
        schema:
          type: string
          format: date-time
        description: Start of the time range
      - name: to
        in: query
        schema:
          type: string
          format: date-time
        description: End of the time range
      responses:
        '200':
          description: Gateway metrics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metrics'
        '401':
          description: Unauthorized
        '404':
          description: Gateway not found
components:
  parameters:
    gatewayId:
      name: gatewayId
      in: path
      required: true
      schema:
        type: string
      description: The gateway identifier
  schemas:
    Metrics:
      type: object
      properties:
        gatewayId:
          type: string
        period:
          type: object
          properties:
            from:
              type: string
              format: date-time
            to:
              type: string
              format: date-time
        requestCount:
          type: integer
          description: Total API requests in the period
        errorCount:
          type: integer
          description: Total error responses in the period
        averageLatency:
          type: number
          format: double
          description: Average response latency in milliseconds
        throughput:
          type: number
          format: double
          description: Requests per second
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token authentication
externalDocs:
  description: APIIDA Documentation
  url: https://apiida.atlassian.net