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 redundancy API

Gateway redundancy configuration

Inductive Automation redundancy 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 redundancy. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 6 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}.

7 operations 6 paths 0 schemas 4 GET2 POST1 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 redundancy 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 7

Across 6 paths, the API surfaces 7 operations — 4 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

redundancy 7

Gateway redundancy configuration

GET
/data/api/v1/redundancy
Status
status-get → 200400401404
GET
/data/api/v1/redundancy/config
Get Redundancy Config
get-redundancy-config-get → 200400401404
PUT
/data/api/v1/redundancy/config
Update Redundancy Config
update-redundancy-config-put body → 200400401404
GET
/data/api/v1/redundancy/events
Log Events
log-events-get 6 params → 200400401404
POST
/data/api/v1/redundancy/gwaction/failover
Force Failover
force-failover-post → 200400401404
POST
/data/api/v1/redundancy/gwaction/resync
Re-Sync Configuration
re-sync-configuration-post → 200400401404
GET
/data/api/v1/redundancy/providers
Redundancy Provider Metrics
redundancy-provider-metrics-get 5 params → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

inductive-automation-redundancy-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