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

Device connection management

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

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

12 operations 9 paths 0 schemas 2 DELETE5 GET3 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 device 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 12

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

device 12

Device connection management

PUT
/data/api/v1/resources/com.inductiveautomation.opcua/device
Modify Devices
modify-devices-put 1 param body → 200400401404
POST
/data/api/v1/resources/com.inductiveautomation.opcua/device
Create Devices
create-devices-post 1 param body → 200400401404
DELETE
/data/api/v1/resources/com.inductiveautomation.opcua/device/{name}/{signature}
Delete Devices
delete-devices-delete 4 params → 200400401404
GET
/data/api/v1/resources/datafile/com.inductiveautomation.opcua/device/{name}/{filename}
Get Devices Data File
get-devices-data-file-get 3 params → 200400401404
PUT
/data/api/v1/resources/datafile/com.inductiveautomation.opcua/device/{name}/{filename}
Update Devices Data File
update-devices-data-file-put 5 params → 200400401404
DELETE
/data/api/v1/resources/datafile/com.inductiveautomation.opcua/device/{name}/{filename}
Delete Devices Data File
delete-devices-data-file-delete 4 params → 200400401404
POST
/data/api/v1/resources/delete/com.inductiveautomation.opcua/device
Delete Devices (multiple)
delete-devices-(multiple)-post 1 param body → 200400401404
GET
/data/api/v1/resources/find/com.inductiveautomation.opcua/device/{name}
Get Devices Config
get-devices-config-get 2 params → 200400401404
GET
/data/api/v1/resources/list/com.inductiveautomation.opcua/device
List Devices Resources
list-devices-resources-get 5 params → 200400401404
GET
/data/api/v1/resources/names/com.inductiveautomation.opcua/device
Get Devices Names
get-devices-names-get 5 params → 200400401404
POST
/data/api/v1/resources/rename/com.inductiveautomation.opcua/device/{name}
Rename Devices
rename-devices-post 2 params body → 200400401404
GET
/data/api/v1/resources/type/com.inductiveautomation.opcua/device
Describe 'Devices' Resource Type
describe-'devices'-resource-type-get → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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