rockwell-factorytalk Alarms API
Alarm and event management
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/rockwell-factorytalk-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Rockwell FactoryTalk Optix REST Alarms API
description: Rockwell Automation FactoryTalk Optix REST API provides programmatic access to HMI and SCADA visualization applications, enabling external system integration, tag read/write, alarm management, and runtime control of FactoryTalk Optix applications deployed in industrial automation environments.
version: 1.5.0
contact:
name: Rockwell Automation Support
url: https://www.rockwellautomation.com/en-us/support/
license:
name: Rockwell Automation Software License
url: https://www.rockwellautomation.com/en-us/company/about-us/legal-notices/
servers:
- url: https://{host}/api/v1
description: FactoryTalk Optix REST API
variables:
host:
default: optix.example.com
description: FactoryTalk Optix server hostname
security:
- oauth2: []
- apiKey: []
tags:
- name: Alarms
description: Alarm and event management
paths:
/alarms:
get:
operationId: listAlarms
summary: List Active Alarms
description: Returns currently active and unacknowledged alarms.
tags:
- Alarms
parameters:
- name: status
in: query
description: Filter by alarm status
schema:
type: string
enum:
- ACTIVE
- ACKNOWLEDGED
- NORMAL
- name: severity
in: query
description: Minimum severity to return
schema:
type: string
enum:
- LOW
- MEDIUM
- HIGH
- CRITICAL
- name: limit
in: query
schema:
type: integer
default: 100
- name: offset
in: query
schema:
type: integer
default: 0
responses:
'200':
description: Active alarm list
content:
application/json:
schema:
type: object
properties:
alarms:
type: array
items:
$ref: '#/components/schemas/Alarm'
totalCount:
type: integer
'401':
$ref: '#/components/responses/Unauthorized'
/alarms/{alarmId}/acknowledge:
post:
operationId: acknowledgeAlarm
summary: Acknowledge an Alarm
description: Acknowledges an active alarm, optionally with a comment.
tags:
- Alarms
parameters:
- name: alarmId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
comment:
type: string
description: Acknowledgment comment
responses:
'200':
description: Alarm acknowledged
'404':
$ref: '#/components/responses/NotFound'
/alarms/history:
get:
operationId: getAlarmHistory
summary: Get Alarm History
description: Returns historical alarm events within a time range.
tags:
- Alarms
parameters:
- name: startTime
in: query
required: true
schema:
type: string
format: date-time
- name: endTime
in: query
required: true
schema:
type: string
format: date-time
- name: tagName
in: query
description: Filter to specific tag
schema:
type: string
- name: limit
in: query
schema:
type: integer
default: 500
responses:
'200':
description: Alarm history
content:
application/json:
schema:
type: object
properties:
alarmEvents:
type: array
items:
$ref: '#/components/schemas/AlarmEvent'
components:
schemas:
AlarmEvent:
type: object
properties:
eventId:
type: string
alarmId:
type: string
tagName:
type: string
alarmName:
type: string
eventType:
type: string
enum:
- ACTIVATED
- ACKNOWLEDGED
- RESET
- DISABLED
timestamp:
type: string
format: date-time
value:
description: Tag value at event time
user:
type: string
nullable: true
comment:
type: string
nullable: true
Alarm:
type: object
description: An active alarm condition
properties:
alarmId:
type: string
tagName:
type: string
alarmName:
type: string
description:
type: string
status:
type: string
enum:
- ACTIVE
- ACKNOWLEDGED
- NORMAL
severity:
type: string
enum:
- LOW
- MEDIUM
- HIGH
- CRITICAL
activationTime:
type: string
format: date-time
acknowledgmentTime:
type: string
format: date-time
nullable: true
acknowledgedBy:
type: string
nullable: true
triggerValue:
description: Tag value when alarm activated
setpoint:
description: Alarm setpoint/threshold value
Error:
type: object
properties:
code:
type: string
message:
type: string
details:
type: string
responses:
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth2:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://optix.example.com/auth/token
scopes:
optix.read: Read tag values and alarm data
optix.write: Write tag values
optix.admin: Manage recipes and project configuration
apiKey:
type: apiKey
in: header
name: X-Api-Key
description: FactoryTalk Optix API key