Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Inductive Automation config-alarm API

Alarm configuration resources

Inductive Automation config-alarm API is one of 88 APIs that Inductive Automation publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include config-alarm. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 18 operations across 16 paths. It is described by OpenAPI 3.0.3, at version 8.3.0.

Requests are made against 2 base URLs: http://{gateway-host}:{port}, https://{gateway-host}:{port}.

18 operations 16 paths 0 schemas 2 DELETE8 GET6 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
8.3.0
Base URL
https://{gateway-host}:8088/api
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Inductive Automation config-alarm API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Ignition-API-Token (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — Time-limited API token. Obtain by posting credentials to the token endpoint. See /data/api/v1/token for details.

Paths & Operations 18

Across 16 paths, the API surfaces 18 operations — 2 DELETE, 8 GET, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

config-alarm 18

Alarm configuration resources

POST
/data/api/v1/resources/delete/ignition/holiday
Delete Holiday (multiple)
delete-holiday-(multiple)-post 1 param body → 200400401404
POST
/data/api/v1/resources/delete/ignition/schedule
Delete Schedule (multiple)
delete-schedule-(multiple)-post 1 param body → 200400401404
GET
/data/api/v1/resources/find/ignition/holiday/{name}
Get Holiday Config
get-holiday-config-get 2 params → 200400401404
GET
/data/api/v1/resources/find/ignition/schedule/{name}
Get Schedule Config
get-schedule-config-get 2 params → 200400401404
PUT
/data/api/v1/resources/ignition/holiday
Modify Holiday
modify-holiday-put body → 200400401404
POST
/data/api/v1/resources/ignition/holiday
Create Holiday
create-holiday-post body → 200400401404
DELETE
/data/api/v1/resources/ignition/holiday/{name}/{signature}
Delete Holiday
delete-holiday-delete 4 params → 200400401404
PUT
/data/api/v1/resources/ignition/schedule
Modify Schedule
modify-schedule-put 1 param body → 200400401404
POST
/data/api/v1/resources/ignition/schedule
Create Schedule
create-schedule-post 1 param body → 200400401404
DELETE
/data/api/v1/resources/ignition/schedule/{name}/{signature}
Delete Schedule
delete-schedule-delete 4 params → 200400401404
GET
/data/api/v1/resources/list/ignition/holiday
List Holiday Resources
list-holiday-resources-get 5 params → 200400401404
GET
/data/api/v1/resources/list/ignition/schedule
List Schedule Resources
list-schedule-resources-get 5 params → 200400401404
GET
/data/api/v1/resources/names/ignition/holiday
Get Holiday Names
get-holiday-names-get 5 params → 200400401404
GET
/data/api/v1/resources/names/ignition/schedule
Get Schedule Names
get-schedule-names-get 5 params → 200400401404
POST
/data/api/v1/resources/rename/ignition/holiday/{name}
Rename Holiday
rename-holiday-post 2 params body → 200400401404
POST
/data/api/v1/resources/rename/ignition/schedule/{name}
Rename Schedule
rename-schedule-post 2 params body → 200400401404
GET
/data/api/v1/resources/type/ignition/holiday
Describe 'Holiday' Resource Type
describe-'holiday'-resource-type-get → 200400401404
GET
/data/api/v1/resources/type/ignition/schedule
Describe 'Schedule' Resource Type
describe-'schedule'-resource-type-get → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

inductive-automation-config-alarm-api-openapi.yml Raw ↑

Other APIs Inductive Automation publishes across the network.

Ignition Gateway REST API
Inductive Automation access-control API
Inductive Automation agent-group API
Inductive Automation agent-management API
Inductive Automation alarm-journal-resources API
Inductive Automation alarm-notification-profile API
Inductive Automation api-token API
Inductive Automation audit API
Inductive Automation call-script API
Inductive Automation certificate-management API
Inductive Automation charts-info API
Inductive Automation client-pki-certificate-management API