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 opc connection API

OPC connection management

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

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

9 operations 8 paths 0 schemas 1 DELETE4 GET3 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 opc connection 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 9

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

opc connection 9

OPC connection management

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

inductive-automation-opc-connection-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