Inductive Automation config-gateway-network API

Gateway network configuration

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 31 operations across 27 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}.

31 operations 27 paths 0 schemas 5 DELETE14 GET7 POST5 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

Contact

Inductive Automation Support

License

Commercial

Resource Areas

Authentication & Security 1

Inductive Automation config-gateway-network 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 31

Across 27 paths, the API surfaces 31 operations — 5 DELETE, 14 GET, 7 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

config-gateway-network 31

Gateway network configuration

POST

/data/api/v1/resources/delete/ignition/gateway-network-incoming

Delete Incoming Connection Settings (multiple)

delete-incoming-connection-settings-(multiple)-post 1 param body → 200400401404

POST

/data/api/v1/resources/delete/ignition/gateway-network-outgoing

Delete Outgoing Connection Settings (multiple)

delete-outgoing-connection-settings-(multiple)-post 1 param body → 200400401404

GET

/data/api/v1/resources/find/ignition/gateway-network-incoming/{name}

Get Incoming Connection Settings Config

get-incoming-connection-settings-config-get 2 params → 200400401404

GET

/data/api/v1/resources/find/ignition/gateway-network-outgoing/{name}

Get Outgoing Connection Settings Config

get-outgoing-connection-settings-config-get 2 params → 200400401404

PUT

/data/api/v1/resources/ignition/gateway-network-incoming

Modify Incoming Connection Settings

modify-incoming-connection-settings-put body → 200400401404

DELETE

/data/api/v1/resources/ignition/gateway-network-incoming/{name}/{signature}

Delete Incoming Connection Settings

delete-incoming-connection-settings-delete 4 params → 200400401404

PUT

/data/api/v1/resources/ignition/gateway-network-outgoing

Modify Outgoing Connection Settings

modify-outgoing-connection-settings-put body → 200400401404

POST

/data/api/v1/resources/ignition/gateway-network-outgoing

Create Outgoing Connection Settings

create-outgoing-connection-settings-post body → 200400401404

DELETE

/data/api/v1/resources/ignition/gateway-network-outgoing/{name}/{signature}

Delete Outgoing Connection Settings

delete-outgoing-connection-settings-delete 4 params → 200400401404

PUT

/data/api/v1/resources/ignition/gateway-network-proxy-rules

Modify Proxy Rules

modify-proxy-rules-put body → 200400401404

POST

/data/api/v1/resources/ignition/gateway-network-proxy-rules

Create Proxy Rules

create-proxy-rules-post body → 200400401404

DELETE

/data/api/v1/resources/ignition/gateway-network-proxy-rules/{signature}

Delete Proxy Rules

delete-proxy-rules-delete 2 params → 200400401404

PUT

/data/api/v1/resources/ignition/gateway-network-queue-settings

Modify Queue Settings

modify-queue-settings-put body → 200400401404

POST

/data/api/v1/resources/ignition/gateway-network-queue-settings

Create Queue Settings

create-queue-settings-post body → 200400401404

DELETE

/data/api/v1/resources/ignition/gateway-network-queue-settings/{signature}

Delete Queue Settings

delete-queue-settings-delete 2 params → 200400401404

PUT

/data/api/v1/resources/ignition/gateway-network-settings

Modify General Gateway Network Settings

modify-general-gateway-network-settings-put body → 200400401404

POST

/data/api/v1/resources/ignition/gateway-network-settings

Create General Gateway Network Settings

create-general-gateway-network-settings-post body → 200400401404

DELETE

/data/api/v1/resources/ignition/gateway-network-settings/{signature}

Delete General Gateway Network Settings

delete-general-gateway-network-settings-delete 2 params → 200400401404

GET

/data/api/v1/resources/list/ignition/gateway-network-incoming

List Incoming Connection Settings Resources

list-incoming-connection-settings-resources-get 5 params → 200400401404

GET

/data/api/v1/resources/list/ignition/gateway-network-outgoing

List Outgoing Connection Settings Resources

list-outgoing-connection-settings-resources-get 5 params → 200400401404

GET

/data/api/v1/resources/names/ignition/gateway-network-incoming

Get Incoming Connection Settings Names

get-incoming-connection-settings-names-get 5 params → 200400401404

GET

/data/api/v1/resources/names/ignition/gateway-network-outgoing

Get Outgoing Connection Settings Names

get-outgoing-connection-settings-names-get 5 params → 200400401404

POST

/data/api/v1/resources/rename/ignition/gateway-network-outgoing/{name}

Rename Outgoing Connection Settings

rename-outgoing-connection-settings-post 2 params body → 200400401404

GET

/data/api/v1/resources/singleton/ignition/gateway-network-proxy-rules

Get Proxy Rules Config

get-proxy-rules-config-get 2 params → 200400401404

GET

/data/api/v1/resources/singleton/ignition/gateway-network-queue-settings

Get Queue Settings Config

get-queue-settings-config-get 2 params → 200400401404

GET

/data/api/v1/resources/singleton/ignition/gateway-network-settings

Get General Gateway Network Settings Config

get-general-gateway-network-settings-config-get 2 params → 200400401404

GET

/data/api/v1/resources/type/ignition/gateway-network-incoming

Describe 'Incoming Connection Settings' Resource Type

describe-'incoming-connection-settings'-resource-type-get → 200400401404

GET

/data/api/v1/resources/type/ignition/gateway-network-outgoing

Describe 'Outgoing Connection Settings' Resource Type

describe-'outgoing-connection-settings'-resource-type-get → 200400401404

GET

/data/api/v1/resources/type/ignition/gateway-network-proxy-rules

Describe 'Proxy Rules' Resource Type

describe-'proxy-rules'-resource-type-get → 200400401404

GET

/data/api/v1/resources/type/ignition/gateway-network-queue-settings

Describe 'Queue Settings' Resource Type

describe-'queue-settings'-resource-type-get → 200400401404

GET

/data/api/v1/resources/type/ignition/gateway-network-settings

Describe 'General Gateway Network Settings' Resource Type

describe-'general-gateway-network-settings'-resource-type-get → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Inductive Automation publishes across the network.

Ignition Gateway REST API

AE Profile APIs.io

Inductive Automation access-control API

AE Profile APIs.io

Inductive Automation agent-group API

AE Profile APIs.io

Inductive Automation agent-management API

AE Profile APIs.io

Inductive Automation alarm-journal-resources API

AE Profile APIs.io

Inductive Automation alarm-notification-profile API

AE Profile APIs.io

Inductive Automation api-token API

AE Profile APIs.io

Inductive Automation audit API

AE Profile APIs.io

Inductive Automation call-script API

AE Profile APIs.io

Inductive Automation certificate-management API

AE Profile APIs.io

Inductive Automation charts-info API

AE Profile APIs.io

Inductive Automation client-pki-certificate-management API

AE Profile APIs.io

#config-gateway-network

← Back to I APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Inductive Automation config-gateway-network API

Metadata

Authentication & Security 1

Paths & Operations 31

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Inductive Automation config-gateway-network API

Metadata

Authentication & Security 1

Paths & Operations 31

Specification

Source

More from Inductive Automation 12

API Details

Provider

Explore more