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 gateway-network API

Gateway network topology

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

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

13 operations 13 paths 0 schemas 1 DELETE6 GET1 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
License
Resource Areas
1

Authentication & Security 1

Inductive Automation 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 13

Across 13 paths, the API surfaces 13 operations — 1 DELETE, 6 GET, 1 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

gateway-network 13

Gateway network topology

PUT
/data/api/v1/gateway-network-incoming/reset/{resourceName}
Reset Incoming Connection
reset-incoming-connection-put 1 param → 200400401404
PUT
/data/api/v1/gateway-network-incoming/toggleApproval/{remoteId}/{approve}
Toggle Approval
toggle-approval-put 2 params → 200400401404
PUT
/data/api/v1/gateway-network-outgoing/reset/{resourceName}
Reset Outgoing Connection
reset-outgoing-connection-put 1 param → 200400401404
DELETE
/data/api/v1/gateway-network/cancelQueueTasks/{serverId}/{queueId}
Cancel Task Queue
cancel-task-queue-delete 2 params → 200400401404
GET
/data/api/v1/gateway-network/crawler
Gateway Network Crawler
gateway-network-crawler-get 1 param → 200400401404
GET
/data/api/v1/gateway-network/diagnostics/getRemoteServerIds
Get Remote Server Names
get-remote-server-names-get → 200400401404
POST
/data/api/v1/gateway-network/diagnostics/testConnectionToServer/{serverId}
Diagnostic Ping
diagnostic-ping-post 1 param → 200400401404
GET
/data/api/v1/gateway-network/gatewayDetail/{serverId}
Gateway Detail
gateway-detail-get 1 param → 200400401404
GET
/data/api/v1/gateway-network/gateways
Gateways
gateways-get 5 params → 200400401404
GET
/data/api/v1/gateway-network/livediagram
Gateway Network Live Diagram
gateway-network-live-diagram-get → 200400401404
PUT
/data/api/v1/gateway-network/pauseQueue/{serverId}/{queueId}
Pause Task Queue
pause-task-queue-put 2 params → 200400401404
GET
/data/api/v1/gateway-network/remote-tag-providers/{serverId}
Remote Tag Providers
remote-tag-providers-get 6 params → 200400401404
PUT
/data/api/v1/gateway-network/resumeQueue/{serverId}/{queueId}
Resume Task Queue
resume-task-queue-put 2 params → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

inductive-automation-gateway-network-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