Inductive Automation server API
OPC UA server configuration
OpenAPI Specification
openapi: 3.0.3
info:
title: Ignition Gateway REST access-control server API
description: The Ignition Gateway REST API (Ignition 8.3+) provides an OpenAPI-compliant HTTP interface to Gateway configuration resources including tags, projects, modules, device connections, historian data, user management (SCIM), alarm notification, OPC connections, and more. The specification is dynamically generated based on installed modules. Authentication uses API keys exchanged for time-limited tokens via the X-Ignition-API-Token header. Mutative requests are audit-logged. Supports Kubernetes and Helm-based cloud-native deployments.
version: 8.3.0
contact:
name: Inductive Automation Support
url: https://support.inductiveautomation.com/
license:
name: Commercial
url: https://inductiveautomation.com/pricing/
x-postman-collection: https://raw.githubusercontent.com/inductiveautomation/83-api/main/postman/8.3.postman_collection_v2.json
servers:
- url: http://{gateway-host}:{port}
description: Ignition Gateway (HTTP)
variables:
gateway-host:
default: localhost
description: Hostname or IP address of the Ignition Gateway
port:
default: '8088'
description: Gateway HTTP port (default 8088; HTTPS default 8043)
- url: https://{gateway-host}:{port}
description: Ignition Gateway (HTTPS)
variables:
gateway-host:
default: localhost
description: Hostname or IP address of the Ignition Gateway
port:
default: '8043'
description: Gateway HTTPS port
security:
- apiKeyAuth: []
tags:
- name: server
description: OPC UA server configuration
paths:
/data/api/v1/resources/com.inductiveautomation.opcua/server-config:
put:
summary: Modify OPC UA Server Config
operationId: modify-opc-ua-server-config-put
tags:
- server
description: Modify one or more OPC UA Server Config resources
parameters:
- name: allowInvalidReferences
in: query
required: false
schema:
type: string
description: If true, invalid references will be allowed. Default is false.
requestBody:
content:
application/json:
schema:
type: object
example:
- signature: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
endpoint:
bindPort: <number>
bindAddresses:
- <string>
- <string>
endpointAddresses:
- <string>
- <string>
securityPolicies:
- <string>
- <string>
messageSecurityModes:
- <string>
- <string>
authentication:
anonymousAccessAllowed: <boolean>
authenticationProfile: <string>
redundancy:
readOnlyWhenInactive: <boolean>
advanced:
exposedTagsEnabled: <boolean>
maxSessionCount: <number>
gdsPushEnabled: <boolean>
backupConfig:
endpoint:
bindPort: <number>
bindAddresses:
- <string>
- <string>
endpointAddresses:
- <string>
- <string>
securityPolicies:
- <string>
- <string>
messageSecurityModes:
- <string>
- <string>
authentication:
anonymousAccessAllowed: <boolean>
authenticationProfile: <string>
redundancy:
readOnlyWhenInactive: <boolean>
advanced:
exposedTagsEnabled: <boolean>
maxSessionCount: <number>
gdsPushEnabled: <boolean>
- signature: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
endpoint:
bindPort: <number>
bindAddresses:
- <string>
- <string>
endpointAddresses:
- <string>
- <string>
securityPolicies:
- <string>
- <string>
messageSecurityModes:
- <string>
- <string>
authentication:
anonymousAccessAllowed: <boolean>
authenticationProfile: <string>
redundancy:
readOnlyWhenInactive: <boolean>
advanced:
exposedTagsEnabled: <boolean>
maxSessionCount: <number>
gdsPushEnabled: <boolean>
backupConfig:
endpoint:
bindPort: <number>
bindAddresses:
- <string>
- <string>
endpointAddresses:
- <string>
- <string>
securityPolicies:
- <string>
- <string>
messageSecurityModes:
- <string>
- <string>
authentication:
anonymousAccessAllowed: <boolean>
authenticationProfile: <string>
redundancy:
readOnlyWhenInactive: <boolean>
advanced:
exposedTagsEnabled: <boolean>
maxSessionCount: <number>
gdsPushEnabled: <boolean>
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
post:
summary: Create OPC UA Server Config
operationId: create-opc-ua-server-config-post
tags:
- server
description: Create the OPC UA Server Config resource
parameters:
- name: allowInvalidReferences
in: query
required: false
schema:
type: string
description: If true, invalid references will be allowed. Default is false.
requestBody:
content:
application/json:
schema:
type: object
example:
- collection: <string>
enabled: <boolean>
description: <string>
config:
endpoint:
bindPort: <number>
bindAddresses:
- <string>
- <string>
endpointAddresses:
- <string>
- <string>
securityPolicies:
- <string>
- <string>
messageSecurityModes:
- <string>
- <string>
authentication:
anonymousAccessAllowed: <boolean>
authenticationProfile: <string>
redundancy:
readOnlyWhenInactive: <boolean>
advanced:
exposedTagsEnabled: <boolean>
maxSessionCount: <number>
gdsPushEnabled: <boolean>
backupConfig:
endpoint:
bindPort: <number>
bindAddresses:
- <string>
- <string>
endpointAddresses:
- <string>
- <string>
securityPolicies:
- <string>
- <string>
messageSecurityModes:
- <string>
- <string>
authentication:
anonymousAccessAllowed: <boolean>
authenticationProfile: <string>
redundancy:
readOnlyWhenInactive: <boolean>
advanced:
exposedTagsEnabled: <boolean>
maxSessionCount: <number>
gdsPushEnabled: <boolean>
- collection: <string>
enabled: <boolean>
description: <string>
config:
endpoint:
bindPort: <number>
bindAddresses:
- <string>
- <string>
endpointAddresses:
- <string>
- <string>
securityPolicies:
- <string>
- <string>
messageSecurityModes:
- <string>
- <string>
authentication:
anonymousAccessAllowed: <boolean>
authenticationProfile: <string>
redundancy:
readOnlyWhenInactive: <boolean>
advanced:
exposedTagsEnabled: <boolean>
maxSessionCount: <number>
gdsPushEnabled: <boolean>
backupConfig:
endpoint:
bindPort: <number>
bindAddresses:
- <string>
- <string>
endpointAddresses:
- <string>
- <string>
securityPolicies:
- <string>
- <string>
messageSecurityModes:
- <string>
- <string>
authentication:
anonymousAccessAllowed: <boolean>
authenticationProfile: <string>
redundancy:
readOnlyWhenInactive: <boolean>
advanced:
exposedTagsEnabled: <boolean>
maxSessionCount: <number>
gdsPushEnabled: <boolean>
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/com.inductiveautomation.opcua/server-config/{signature}:
delete:
summary: Delete OPC UA Server Config
operationId: delete-opc-ua-server-config-delete
tags:
- server
description: Delete the OPC UA Server Config resource.
parameters:
- name: signature
in: path
required: true
schema:
type: string
- name: collection
in: query
required: false
schema:
type: string
description: The configuration collection to delete the resource from
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/singleton/com.inductiveautomation.opcua/server-config:
get:
summary: Get OPC UA Server Config Config
operationId: get-opc-ua-server-config-config-get
tags:
- server
description: Retrieve configuration details about the OPC UA Server Config resource
parameters:
- name: defaultIfUndefined
in: query
required: false
schema:
type: string
description: If true, return the default configuration if the resource is not defined. Otherwise, return 404. Default is false.
- name: collection
in: query
required: false
schema:
type: string
description: The configuration collection to read the resource from
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/type/com.inductiveautomation.opcua/server-config:
get:
summary: Describe 'OPC UA Server Config' Resource Type
operationId: describe-'opc-ua-server-config'-resource-type-get
tags:
- server
description: Describe the OPC UA Server Config resource type
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: X-Ignition-API-Token
description: Time-limited API token. Obtain by posting credentials to the token endpoint. See /data/api/v1/token for details.
externalDocs:
description: Ignition 8.3 Gateway REST API Documentation
url: https://www.docs.inductiveautomation.com/docs/8.3/platform/gateway/openapi