Inductive Automation alarm-notification-profile API
Alarm notification profile management
OpenAPI Specification
openapi: 3.0.3
info:
title: Ignition Gateway REST access-control alarm-notification-profile API
description: The Ignition Gateway REST API (Ignition 8.3+) provides an OpenAPI-compliant HTTP interface to Gateway configuration resources including tags, projects, modules, device connections, historian data, user management (SCIM), alarm notification, OPC connections, and more. The specification is dynamically generated based on installed modules. Authentication uses API keys exchanged for time-limited tokens via the X-Ignition-API-Token header. Mutative requests are audit-logged. Supports Kubernetes and Helm-based cloud-native deployments.
version: 8.3.0
contact:
name: Inductive Automation Support
url: https://support.inductiveautomation.com/
license:
name: Commercial
url: https://inductiveautomation.com/pricing/
x-postman-collection: https://raw.githubusercontent.com/inductiveautomation/83-api/main/postman/8.3.postman_collection_v2.json
servers:
- url: http://{gateway-host}:{port}
description: Ignition Gateway (HTTP)
variables:
gateway-host:
default: localhost
description: Hostname or IP address of the Ignition Gateway
port:
default: '8088'
description: Gateway HTTP port (default 8088; HTTPS default 8043)
- url: https://{gateway-host}:{port}
description: Ignition Gateway (HTTPS)
variables:
gateway-host:
default: localhost
description: Hostname or IP address of the Ignition Gateway
port:
default: '8043'
description: Gateway HTTPS port
security:
- apiKeyAuth: []
tags:
- name: alarm-notification-profile
description: Alarm notification profile management
paths:
/data/api/v1/resources/com.inductiveautomation.alarm-notification/alarm-notification-profile:
put:
summary: Modify Alarm Notification Profiles
operationId: modify-alarm-notification-profiles-put
tags:
- alarm-notification-profile
description: Modify one or more Alarm Notification Profiles resources
parameters:
- name: allowInvalidReferences
in: query
required: false
schema:
type: string
description: If true, invalid references will be allowed. Default is false.
requestBody:
content:
application/json:
schema:
type: object
example:
- name: <string>
signature: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
profile:
type: <string>
settings:
hostAddress: 0.0.0.0
sendPort: 17341
receivePort: 17342
backupHostAddress: 0.0.0.0
backupSendPort: 17341
backupReceivePort: 17342
twoWayEnabled: false
numericOnlyAckCode: false
auditProfile: 'null'
backupConfig:
profile:
type: <string>
settings:
hostAddress: 0.0.0.0
sendPort: 17341
receivePort: 17342
backupHostAddress: 0.0.0.0
backupSendPort: 17341
backupReceivePort: 17342
twoWayEnabled: false
numericOnlyAckCode: false
auditProfile: 'null'
- name: <string>
signature: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
profile:
type: <string>
settings:
hostAddress: 0.0.0.0
sendPort: 17341
receivePort: 17342
backupHostAddress: 0.0.0.0
backupSendPort: 17341
backupReceivePort: 17342
twoWayEnabled: false
numericOnlyAckCode: false
auditProfile: 'null'
backupConfig:
profile:
type: <string>
settings:
hostAddress: 0.0.0.0
sendPort: 17341
receivePort: 17342
backupHostAddress: 0.0.0.0
backupSendPort: 17341
backupReceivePort: 17342
twoWayEnabled: false
numericOnlyAckCode: false
auditProfile: 'null'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
post:
summary: Create Alarm Notification Profiles
operationId: create-alarm-notification-profiles-post
tags:
- alarm-notification-profile
description: Create a new Alarm Notification Profiles resource
parameters:
- name: allowInvalidReferences
in: query
required: false
schema:
type: string
description: If true, invalid references will be allowed. Default is false.
requestBody:
content:
application/json:
schema:
type: object
example:
- name: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
profile:
type: <string>
settings:
hostAddress: 0.0.0.0
sendPort: 17341
receivePort: 17342
backupHostAddress: 0.0.0.0
backupSendPort: 17341
backupReceivePort: 17342
twoWayEnabled: false
numericOnlyAckCode: false
auditProfile: 'null'
backupConfig:
profile:
type: <string>
settings:
hostAddress: 0.0.0.0
sendPort: 17341
receivePort: 17342
backupHostAddress: 0.0.0.0
backupSendPort: 17341
backupReceivePort: 17342
twoWayEnabled: false
numericOnlyAckCode: false
auditProfile: 'null'
- name: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
profile:
type: <string>
settings:
hostAddress: 0.0.0.0
sendPort: 17341
receivePort: 17342
backupHostAddress: 0.0.0.0
backupSendPort: 17341
backupReceivePort: 17342
twoWayEnabled: false
numericOnlyAckCode: false
auditProfile: 'null'
backupConfig:
profile:
type: <string>
settings:
hostAddress: 0.0.0.0
sendPort: 17341
receivePort: 17342
backupHostAddress: 0.0.0.0
backupSendPort: 17341
backupReceivePort: 17342
twoWayEnabled: false
numericOnlyAckCode: false
auditProfile: 'null'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/com.inductiveautomation.alarm-notification/alarm-notification-profile/{name}/{signature}:
delete:
summary: Delete Alarm Notification Profiles
operationId: delete-alarm-notification-profiles-delete
tags:
- alarm-notification-profile
description: Delete a Alarm Notification Profiles resource by name
parameters:
- name: name
in: path
required: true
schema:
type: string
- name: signature
in: path
required: true
schema:
type: string
- name: collection
in: query
required: false
schema:
type: string
description: The configuration collection to delete the resource from
- name: confirm
in: query
required: false
schema:
type: string
description: Whether to confirm the deletion, required when the operation would affect other resources.
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/delete/com.inductiveautomation.alarm-notification/alarm-notification-profile:
post:
summary: Delete Alarm Notification Profiles (multiple)
operationId: delete-alarm-notification-profiles-(multiple)-post
tags:
- alarm-notification-profile
description: Delete multiple Alarm Notification Profiles resources by name
parameters:
- name: confirm
in: query
required: false
schema:
type: string
description: Whether to confirm the deletion, required when the operation would affect other resources.
requestBody:
content:
application/json:
schema:
type: object
example:
- name: <string>
signature: <string>
collection: <string>
- name: <string>
signature: <string>
collection: <string>
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/find/com.inductiveautomation.alarm-notification/alarm-notification-profile/{name}:
get:
summary: Get Alarm Notification Profiles Config
operationId: get-alarm-notification-profiles-config-get
tags:
- alarm-notification-profile
description: Retrieve configuration details about a specific Alarm Notification Profiles resource
parameters:
- name: name
in: path
required: true
schema:
type: string
- name: collection
in: query
required: false
schema:
type: string
description: The configuration collection to read the resource from
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/list/com.inductiveautomation.alarm-notification/alarm-notification-profile:
get:
summary: List Alarm Notification Profiles Resources
operationId: list-alarm-notification-profiles-resources-get
tags:
- alarm-notification-profile
description: List all Alarm Notification Profiles resources, in verbose format, including configuration, metrics, and health checks.
parameters:
- name: limit
in: query
required: false
schema:
type: string
description: The maximum number of items to return.
- name: offset
in: query
required: false
schema:
type: string
description: The number of items to skip before returning results.
- name: sortBy
in: query
required: false
schema:
type: string
description: 'The name of a field to sort by. Use `asc(fieldName)` or `desc(fieldName)`
to specify the sort direction as ascending or descending, respectively.
'
- name: search
in: query
required: false
schema:
type: string
description: A search string to filter items by. Terms separated by whitespace.
- name: key_0
in: query
required: false
schema:
type: string
description: 'Filter items by field name, using format like `fieldName[op]=value` where `op` is one of: `eq` (equals), `ne` (not equals), `cn` (contains), `sw` (starts with), `ew` (ends with), `gt` (greater than), `gte` (greater than or equal), `lt` (less than), `lte` (less than or equal), `rgx` (regular expression).'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/names/com.inductiveautomation.alarm-notification/alarm-notification-profile:
get:
summary: Get Alarm Notification Profiles Names
operationId: get-alarm-notification-profiles-names-get
tags:
- alarm-notification-profile
description: List all Alarm Notification Profiles resources, including just names and enabled bit
parameters:
- name: limit
in: query
required: false
schema:
type: string
description: The maximum number of items to return.
- name: offset
in: query
required: false
schema:
type: string
description: The number of items to skip before returning results.
- name: sortBy
in: query
required: false
schema:
type: string
description: 'The name of a field to sort by. Use `asc(fieldName)` or `desc(fieldName)`
to specify the sort direction as ascending or descending, respectively.
'
- name: search
in: query
required: false
schema:
type: string
description: A search string to filter items by. Terms separated by whitespace.
- name: key_0
in: query
required: false
schema:
type: string
description: 'Filter items by field name, using format like `fieldName[op]=value` where `op` is one of: `eq` (equals), `ne` (not equals), `cn` (contains), `sw` (starts with), `ew` (ends with), `gt` (greater than), `gte` (greater than or equal), `lt` (less than), `lte` (less than or equal), `rgx` (regular expression).'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/rename/com.inductiveautomation.alarm-notification/alarm-notification-profile/{name}:
post:
summary: Rename Alarm Notification Profiles
operationId: rename-alarm-notification-profiles-post
tags:
- alarm-notification-profile
description: Change the name of a Alarm Notification Profiles resource, and update all references to it
parameters:
- name: name
in: path
required: true
schema:
type: string
- name: collection
in: query
required: false
schema:
type: string
description: The configuration collection to rename the resource in
requestBody:
content:
application/json:
schema:
type: object
example:
name: <string>
references: <string>
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/type/com.inductiveautomation.alarm-notification/alarm-notification-profile:
get:
summary: Describe 'Alarm Notification Profiles' Resource Type
operationId: describe-'alarm-notification-profiles'-resource-type-get
tags:
- alarm-notification-profile
description: Describe the Alarm Notification Profiles resource type
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: X-Ignition-API-Token
description: Time-limited API token. Obtain by posting credentials to the token endpoint. See /data/api/v1/token for details.
externalDocs:
description: Ignition 8.3 Gateway REST API Documentation
url: https://www.docs.inductiveautomation.com/docs/8.3/platform/gateway/openapi