Inductive Automation service-connectors API
Service connector configuration
OpenAPI Specification
openapi: 3.0.3
info:
title: Ignition Gateway REST access-control service-connectors 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: service-connectors
description: Service connector configuration
paths:
/data/api/v1/resources/datafile/ignition/service-connector/{name}/{filename}:
get:
summary: Get Service Connectors Data File
operationId: get-service-connectors-data-file-get
tags:
- service-connectors
description: Retrieve a data file from a specific Service Connectors resource
parameters:
- name: name
in: path
required: true
schema:
type: string
- name: filename
in: path
required: true
schema:
type: string
- name: collection
in: query
required: false
schema:
type: string
description: The configuration collection to read the file from
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
put:
summary: Update Service Connectors Data File
operationId: update-service-connectors-data-file-put
tags:
- service-connectors
description: Update (overwrite) a data file for a named Service Connectors resource
parameters:
- name: name
in: path
required: true
schema:
type: string
- name: filename
in: path
required: true
schema:
type: string
- name: collection
in: query
required: false
schema:
type: string
description: The configuration collection to update. If omitted, the active definition's collection will be used.
- name: signature
in: query
required: false
schema:
type: string
description: (Required) The current signature of the resource.
- name: rename
in: query
required: false
schema:
type: string
description: An optional new name for the file
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
delete:
summary: Delete Service Connectors Data File
operationId: delete-service-connectors-data-file-delete
tags:
- service-connectors
description: Delete a data file for a named Service Connectors resource
parameters:
- name: name
in: path
required: true
schema:
type: string
- name: filename
in: path
required: true
schema:
type: string
- name: collection
in: query
required: false
schema:
type: string
description: The configuration collection to update. If omitted, the active definition's collection will be used.
- name: signature
in: query
required: false
schema:
type: string
description: (Required) The current signature of the resource.
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/delete/ignition/service-connector:
post:
summary: Delete Service Connectors (multiple)
operationId: delete-service-connectors-(multiple)-post
tags:
- service-connectors
description: Delete multiple Service Connectors resources by name
parameters:
- name: confirm
in: query
required: false
schema:
type: string
description: Whether to confirm the deletion, required when the operation would affect other resources.
requestBody:
content:
application/json:
schema:
type: object
example:
- name: <string>
signature: <string>
collection: <string>
- name: <string>
signature: <string>
collection: <string>
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/find/ignition/service-connector/{name}:
get:
summary: Get Service Connectors Config
operationId: get-service-connectors-config-get
tags:
- service-connectors
description: Retrieve configuration details about a specific Service Connectors resource
parameters:
- name: name
in: path
required: true
schema:
type: string
- 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/ignition/service-connector:
put:
summary: Modify Service Connectors
operationId: modify-service-connectors-put
tags:
- service-connectors
description: Modify one or more Service Connectors resources
requestBody:
content:
application/json:
schema:
type: object
example:
- name: <string>
signature: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
profile:
type: <string>
settings:
bootstrapServers:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
saslMechanism: <string>
securityProtocol: <string>
username: <string>
password:
value: '<Error: Too many levels of nesting to fake this schema>'
ssl:
protocol:
value: '<Error: Too many levels of nesting to fake this schema>'
keyPassword:
value: '<Error: Too many levels of nesting to fake this schema>'
keystore:
value: '<Error: Too many levels of nesting to fake this schema>'
truststore:
value: '<Error: Too many levels of nesting to fake this schema>'
props:
client:
value: '<Error: Too many levels of nesting to fake this schema>'
consumer:
value: '<Error: Too many levels of nesting to fake this schema>'
producer:
value: '<Error: Too many levels of nesting to fake this schema>'
backupConfig:
profile:
type: <string>
settings:
bootstrapServers:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
saslMechanism: <string>
securityProtocol: <string>
username: <string>
password:
value: '<Error: Too many levels of nesting to fake this schema>'
ssl:
protocol:
value: '<Error: Too many levels of nesting to fake this schema>'
keyPassword:
value: '<Error: Too many levels of nesting to fake this schema>'
keystore:
value: '<Error: Too many levels of nesting to fake this schema>'
truststore:
value: '<Error: Too many levels of nesting to fake this schema>'
props:
client:
value: '<Error: Too many levels of nesting to fake this schema>'
consumer:
value: '<Error: Too many levels of nesting to fake this schema>'
producer:
value: '<Error: Too many levels of nesting to fake this schema>'
- name: <string>
signature: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
profile:
type: <string>
settings:
bootstrapServers:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
saslMechanism: <string>
securityProtocol: <string>
username: <string>
password:
value: '<Error: Too many levels of nesting to fake this schema>'
ssl:
protocol:
value: '<Error: Too many levels of nesting to fake this schema>'
keyPassword:
value: '<Error: Too many levels of nesting to fake this schema>'
keystore:
value: '<Error: Too many levels of nesting to fake this schema>'
truststore:
value: '<Error: Too many levels of nesting to fake this schema>'
props:
client:
value: '<Error: Too many levels of nesting to fake this schema>'
consumer:
value: '<Error: Too many levels of nesting to fake this schema>'
producer:
value: '<Error: Too many levels of nesting to fake this schema>'
backupConfig:
profile:
type: <string>
settings:
bootstrapServers:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
saslMechanism: <string>
securityProtocol: <string>
username: <string>
password:
value: '<Error: Too many levels of nesting to fake this schema>'
ssl:
protocol:
value: '<Error: Too many levels of nesting to fake this schema>'
keyPassword:
value: '<Error: Too many levels of nesting to fake this schema>'
keystore:
value: '<Error: Too many levels of nesting to fake this schema>'
truststore:
value: '<Error: Too many levels of nesting to fake this schema>'
props:
client:
value: '<Error: Too many levels of nesting to fake this schema>'
consumer:
value: '<Error: Too many levels of nesting to fake this schema>'
producer:
value: '<Error: Too many levels of nesting to fake this schema>'
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 Service Connectors
operationId: create-service-connectors-post
tags:
- service-connectors
description: Create a new Service Connectors resource
requestBody:
content:
application/json:
schema:
type: object
example:
- name: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
profile:
type: <string>
settings:
bootstrapServers:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
saslMechanism: <string>
securityProtocol: <string>
username: <string>
password:
value: '<Error: Too many levels of nesting to fake this schema>'
ssl:
protocol:
value: '<Error: Too many levels of nesting to fake this schema>'
keyPassword:
value: '<Error: Too many levels of nesting to fake this schema>'
keystore:
value: '<Error: Too many levels of nesting to fake this schema>'
truststore:
value: '<Error: Too many levels of nesting to fake this schema>'
props:
client:
value: '<Error: Too many levels of nesting to fake this schema>'
consumer:
value: '<Error: Too many levels of nesting to fake this schema>'
producer:
value: '<Error: Too many levels of nesting to fake this schema>'
backupConfig:
profile:
type: <string>
settings:
bootstrapServers:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
saslMechanism: <string>
securityProtocol: <string>
username: <string>
password:
value: '<Error: Too many levels of nesting to fake this schema>'
ssl:
protocol:
value: '<Error: Too many levels of nesting to fake this schema>'
keyPassword:
value: '<Error: Too many levels of nesting to fake this schema>'
keystore:
value: '<Error: Too many levels of nesting to fake this schema>'
truststore:
value: '<Error: Too many levels of nesting to fake this schema>'
props:
client:
value: '<Error: Too many levels of nesting to fake this schema>'
consumer:
value: '<Error: Too many levels of nesting to fake this schema>'
producer:
value: '<Error: Too many levels of nesting to fake this schema>'
- name: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
profile:
type: <string>
settings:
bootstrapServers:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
saslMechanism: <string>
securityProtocol: <string>
username: <string>
password:
value: '<Error: Too many levels of nesting to fake this schema>'
ssl:
protocol:
value: '<Error: Too many levels of nesting to fake this schema>'
keyPassword:
value: '<Error: Too many levels of nesting to fake this schema>'
keystore:
value: '<Error: Too many levels of nesting to fake this schema>'
truststore:
value: '<Error: Too many levels of nesting to fake this schema>'
props:
client:
value: '<Error: Too many levels of nesting to fake this schema>'
consumer:
value: '<Error: Too many levels of nesting to fake this schema>'
producer:
value: '<Error: Too many levels of nesting to fake this schema>'
backupConfig:
profile:
type: <string>
settings:
bootstrapServers:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
saslMechanism: <string>
securityProtocol: <string>
username: <string>
password:
value: '<Error: Too many levels of nesting to fake this schema>'
ssl:
protocol:
value: '<Error: Too many levels of nesting to fake this schema>'
keyPassword:
value: '<Error: Too many levels of nesting to fake this schema>'
keystore:
value: '<Error: Too many levels of nesting to fake this schema>'
truststore:
value: '<Error: Too many levels of nesting to fake this schema>'
props:
client:
value: '<Error: Too many levels of nesting to fake this schema>'
consumer:
value: '<Error: Too many levels of nesting to fake this schema>'
producer:
value: '<Error: Too many levels of nesting to fake this schema>'
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/ignition/service-connector/{name}/{signature}:
delete:
summary: Delete Service Connectors
operationId: delete-service-connectors-delete
tags:
- service-connectors
description: Delete a Service Connectors resource by name
parameters:
- name: name
in: path
required: true
schema:
type: string
- 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
- name: confirm
in: query
required: false
schema:
type: string
description: Whether to confirm the deletion, required when the operation would affect other resources.
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/list/ignition/service-connector:
get:
summary: List Service Connectors Resources
operationId: list-service-connectors-resources-get
tags:
- service-connectors
description: List all Service Connectors resources, in verbose format, including configuration, metrics, and health checks.
parameters:
- name: limit
in: query
required: false
schema:
type: string
description: The maximum number of items to return.
- name: offset
in: query
required: false
schema:
type: string
description: The number of items to skip before returning results.
- name: sortBy
in: query
required: false
schema:
type: string
description: 'The name of a field to sort by. Use `asc(fieldName)` or `desc(fieldName)`
to specify the sort direction as ascending or descending, respectively.
'
- name: search
in: query
required: false
schema:
type: string
description: A search string to filter items by. Terms separated by whitespace.
- name: key_0
in: query
required: false
schema:
type: string
description: 'Filter items by field name, using format like `fieldName[op]=value` where `op` is one of: `eq` (equals), `ne` (not equals), `cn` (contains), `sw` (starts with), `ew` (ends with), `gt` (greater than), `gte` (greater than or equal), `lt` (less than), `lte` (less than or equal), `rgx` (regular expression).'
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/names/ignition/service-connector:
get:
summary: Get Service Connectors Names
operationId: get-service-connectors-names-get
tags:
- service-connectors
description: List all Service Connectors resources, including just names and enabled bit
parameters:
- name: limit
in: query
required: false
schema:
type: string
description: The maximum number of items to return.
- name: offset
in: query
required: false
schema:
type: string
description: The number of items to skip before returning results.
- name: sortBy
in: query
required: false
schema:
type: string
description: 'The name of a field to sort by. Use `asc(fieldName)` or `desc(fieldName)`
to specify the sort direction as ascending or descending, respectively.
'
- name: search
in: query
required: false
schema:
type: string
description: A search string to filter items by. Terms separated by whitespace.
- name: key_0
in: query
required: false
schema:
type: string
description: 'Filter items by field name, using format like `fieldName[op]=value` where `op` is one of: `eq` (equals), `ne` (not equals), `cn` (contains), `sw` (starts with), `ew` (ends with), `gt` (greater than), `gte` (greater than or equal), `lt` (less than), `lte` (less than or equal), `rgx` (regular expression).'
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/rename/ignition/service-connector/{name}:
post:
summary: Rename Service Connectors
operationId: rename-service-connectors-post
tags:
- service-connectors
description: Change the name of a Service Connectors resource, and update all references to it
parameters:
- name: name
in: path
required: true
schema:
type: string
- name: collection
in: query
required: false
schema:
type: string
description: The configuration collection to rename the resource in
requestBody:
content:
application/json:
schema:
type: object
example:
name: <string>
references: <string>
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/ignition/service-connector:
get:
summary: Describe 'Service Connectors' Resource Type
operationId: describe-'service-connectors'-resource-type-get
tags:
- service-connectors
description: Describe the Service Connectors 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