Inductive Automation Config Store Forward API
Store-and-forward configuration
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/inductive-automation:inductive-automation-config-store-forward-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Ignition Gateway REST Config Store Forward 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.
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: config-store-forward
description: Store-and-forward configuration
paths:
/data/api/v1/resources/delete/ignition/store-and-forward-engine:
post:
summary: Delete Store and Forward Engine (multiple)
operationId: delete-store-and-forward-engine-(multiple)-post
tags:
- config-store-forward
description: Delete multiple Store and Forward Engine 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/store-and-forward-engine/{name}:
get:
summary: Get Store and Forward Engine Config
operationId: get-store-and-forward-engine-config-get
tags:
- config-store-forward
description: Retrieve configuration details about a specific Store and Forward Engine 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/store-and-forward-engine:
put:
summary: Modify Store and Forward Engine
operationId: modify-store-and-forward-engine-put
tags:
- config-store-forward
description: Modify one or more Store and Forward Engine resources
requestBody:
content:
application/json:
schema:
type: object
example:
- name: <string>
signature: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
timeThresholdMs: <number>
forwardRateMs: <number>
forwardingPolicy: <string>
forwardingSchedule: <string>
isThirdParty: <boolean>
dataThreshold: <number>
batchSize: <number>
scanRateMs: <number>
primaryMaintenancePolicy:
action: <string>
limit:
limitType: <string>
value: <number>
secondaryMaintenancePolicy:
action: <string>
limit:
limitType: <string>
value: <number>
backupConfig:
timeThresholdMs: <number>
forwardRateMs: <number>
forwardingPolicy: <string>
forwardingSchedule: <string>
isThirdParty: <boolean>
dataThreshold: <number>
batchSize: <number>
scanRateMs: <number>
primaryMaintenancePolicy:
action: <string>
limit:
limitType: <string>
value: <number>
secondaryMaintenancePolicy:
action: <string>
limit:
limitType: <string>
value: <number>
- name: <string>
signature: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
timeThresholdMs: <number>
forwardRateMs: <number>
forwardingPolicy: <string>
forwardingSchedule: <string>
isThirdParty: <boolean>
dataThreshold: <number>
batchSize: <number>
scanRateMs: <number>
primaryMaintenancePolicy:
action: <string>
limit:
limitType: <string>
value: <number>
secondaryMaintenancePolicy:
action: <string>
limit:
limitType: <string>
value: <number>
backupConfig:
timeThresholdMs: <number>
forwardRateMs: <number>
forwardingPolicy: <string>
forwardingSchedule: <string>
isThirdParty: <boolean>
dataThreshold: <number>
batchSize: <number>
scanRateMs: <number>
primaryMaintenancePolicy:
action: <string>
limit:
limitType: <string>
value: <number>
secondaryMaintenancePolicy:
action: <string>
limit:
limitType: <string>
value: <number>
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 Store and Forward Engine
operationId: create-store-and-forward-engine-post
tags:
- config-store-forward
description: Create a new Store and Forward Engine resource
requestBody:
content:
application/json:
schema:
type: object
example:
- name: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
timeThresholdMs: <number>
forwardRateMs: <number>
forwardingPolicy: <string>
forwardingSchedule: <string>
isThirdParty: <boolean>
dataThreshold: <number>
batchSize: <number>
scanRateMs: <number>
primaryMaintenancePolicy:
action: <string>
limit:
limitType: <string>
value: <number>
secondaryMaintenancePolicy:
action: <string>
limit:
limitType: <string>
value: <number>
backupConfig:
timeThresholdMs: <number>
forwardRateMs: <number>
forwardingPolicy: <string>
forwardingSchedule: <string>
isThirdParty: <boolean>
dataThreshold: <number>
batchSize: <number>
scanRateMs: <number>
primaryMaintenancePolicy:
action: <string>
limit:
limitType: <string>
value: <number>
secondaryMaintenancePolicy:
action: <string>
limit:
limitType: <string>
value: <number>
- name: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
timeThresholdMs: <number>
forwardRateMs: <number>
forwardingPolicy: <string>
forwardingSchedule: <string>
isThirdParty: <boolean>
dataThreshold: <number>
batchSize: <number>
scanRateMs: <number>
primaryMaintenancePolicy:
action: <string>
limit:
limitType: <string>
value: <number>
secondaryMaintenancePolicy:
action: <string>
limit:
limitType: <string>
value: <number>
backupConfig:
timeThresholdMs: <number>
forwardRateMs: <number>
forwardingPolicy: <string>
forwardingSchedule: <string>
isThirdParty: <boolean>
dataThreshold: <number>
batchSize: <number>
scanRateMs: <number>
primaryMaintenancePolicy:
action: <string>
limit:
limitType: <string>
value: <number>
secondaryMaintenancePolicy:
action: <string>
limit:
limitType: <string>
value: <number>
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/store-and-forward-engine/{name}/{signature}:
delete:
summary: Delete Store and Forward Engine
operationId: delete-store-and-forward-engine-delete
tags:
- config-store-forward
description: Delete a Store and Forward Engine 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/store-and-forward-engine:
get:
summary: List Store and Forward Engine Resources
operationId: list-store-and-forward-engine-resources-get
tags:
- config-store-forward
description: List all Store and Forward Engine 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/store-and-forward-engine:
get:
summary: Get Store and Forward Engine Names
operationId: get-store-and-forward-engine-names-get
tags:
- config-store-forward
description: List all Store and Forward Engine 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/store-and-forward-engine/{name}:
post:
summary: Rename Store and Forward Engine
operationId: rename-store-and-forward-engine-post
tags:
- config-store-forward
description: Change the name of a Store and Forward Engine 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/store-and-forward-engine:
get:
summary: Describe 'Store and Forward Engine' Resource Type
operationId: describe-'store-and-forward-engine'-resource-type-get
tags:
- config-store-forward
description: Describe the Store and Forward Engine 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