openapi: 3.0.3
info:
  title: Teledyne FLIR Camera REST Alarms API
  description: The Teledyne FLIR Camera REST API provides programmatic access to FLIR automation cameras (A50/A70, A400/A500/A700, Ax8 series) for retrieving thermal images, temperature measurements, region of interest (ROI) data, alarm states, and camera configuration. The API is accessed directly on the camera's local IP address. Supports industrial process monitoring, predictive maintenance, building inspection, and automated quality control.
  version: 1.0.0
  contact:
    url: https://www.flir.com/support-center/Instruments/restful-api-exercise/
  license:
    name: Proprietary
    url: https://www.flir.com/
servers:
- url: http://{cameraIp}/api
  description: FLIR Camera REST API (local network access)
  variables:
    cameraIp:
      default: 192.168.0.100
      description: IP address of the FLIR automation camera on the local network.
tags:
- name: Alarms
paths:
  /alarms:
    get:
      operationId: getAllAlarms
      summary: Get All Alarms
      description: Retrieve the current state of all configured alarm conditions on the camera.
      tags:
      - Alarms
      parameters:
      - name: pretty
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: All camera alarm states.
          content:
            application/json:
              schema:
                type: object
                properties:
                  alarms:
                    type: array
                    items:
                      $ref: '#/components/schemas/Alarm'
  /alarm/{instance}.json:
    get:
      operationId: getAlarm
      summary: Get Alarm
      description: Retrieve the state of a specific alarm instance.
      tags:
      - Alarms
      parameters:
      - name: instance
        in: path
        description: Alarm instance number.
        required: true
        schema:
          type: integer
          minimum: 1
      responses:
        '200':
          description: Alarm state data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alarm'
components:
  schemas:
    Alarm:
      type: object
      description: A configured alarm condition on the FLIR camera.
      properties:
        instance:
          type: integer
          description: Alarm instance number.
        name:
          type: string
          description: Alarm name.
        state:
          type: string
          description: Current alarm state.
          enum:
          - active
          - inactive
          - acknowledged
        triggered:
          type: boolean
          description: Whether the alarm condition is currently triggered.
        threshold:
          type: number
          format: double
          description: Temperature threshold that triggers the alarm.
        unit:
          type: string
          description: Temperature unit.
        associatedROI:
          type: string
          description: The ROI associated with this alarm.