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

Installed module management

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

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

10 operations 8 paths 0 schemas 1 DELETE4 GET4 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 modules 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 10

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

modules 10

Installed module management

GET
/data/api/v1/modules/certificate
View Certificate Information
view-certificate-information-get 1 param → 200400401404
POST
/data/api/v1/modules/certificate
Accept Certificate
accept-certificate-post 1 param → 200400401404
GET
/data/api/v1/modules/eula
View EULA
view-eula-get 1 param → 200400401404
POST
/data/api/v1/modules/eula
Accept EULA
accept-eula-post 1 param → 200400401404
GET
/data/api/v1/modules/healthy
All Healthy Modules
all-healthy-modules-get 5 params → 200400401404
POST
/data/api/v1/modules/install
Install Module
install-module-post 1 param → 200400401404
GET
/data/api/v1/modules/quarantined
Quarantined Modules
quarantined-modules-get 5 params → 200400401404
PUT
/data/api/v1/modules/toggle-state
Toggle Module State
toggle-module-state-put body → 200400401404
DELETE
/data/api/v1/modules/uninstall
Uninstall Module[s]
uninstall-module[s]-delete → 200400401404
POST
/data/api/v1/modules/upload
Upload Module
upload-module-post 1 param → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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