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 module-settings API

Module settings configuration

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

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

5 operations 4 paths 0 schemas 1 DELETE2 GET1 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 module-settings 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 5

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

module-settings 5

Module settings configuration

PUT
/data/api/v1/resources/com.inductiveautomation.eam/module-settings
Modify Module Settings
modify-module-settings-put 1 param body → 200400401404
POST
/data/api/v1/resources/com.inductiveautomation.eam/module-settings
Create Module Settings
create-module-settings-post 1 param body → 200400401404
DELETE
/data/api/v1/resources/com.inductiveautomation.eam/module-settings/{signature}
Delete Module Settings
delete-module-settings-delete 2 params → 200400401404
GET
/data/api/v1/resources/singleton/com.inductiveautomation.eam/module-settings
Get Module Settings Config
get-module-settings-config-get 2 params → 200400401404
GET
/data/api/v1/resources/type/com.inductiveautomation.eam/module-settings
Describe 'Module Settings' Resource Type
describe-'module-settings'-resource-type-get → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

inductive-automation-module-settings-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