Inductive Automation gateway-network API

openapi: 3.0.3
info:
  title: Ignition Gateway REST access-control gateway-network 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: gateway-network
  description: Gateway network topology
paths:
  /data/api/v1/gateway-network-incoming/reset/{resourceName}:
    put:
      summary: Reset Incoming Connection
      operationId: reset-incoming-connection-put
      tags:
      - gateway-network
      description: Resets the incoming gateway network connection from a specified remote gateway.
      parameters:
      - name: resourceName
        in: path
        required: true
        schema:
          type: 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/gateway-network-incoming/toggleApproval/{remoteId}/{approve}:
    put:
      summary: Toggle Approval
      operationId: toggle-approval-put
      tags:
      - gateway-network
      description: Toggles the approval status of an incoming connection.
      parameters:
      - name: remoteId
        in: path
        required: true
        schema:
          type: string
      - name: approve
        in: path
        required: true
        schema:
          type: 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/gateway-network-outgoing/reset/{resourceName}:
    put:
      summary: Reset Outgoing Connection
      operationId: reset-outgoing-connection-put
      tags:
      - gateway-network
      description: Resets the outgoing gateway network connection to a specified remote gateway.
      parameters:
      - name: resourceName
        in: path
        required: true
        schema:
          type: 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/gateway-network/cancelQueueTasks/{serverId}/{queueId}:
    delete:
      summary: Cancel Task Queue
      operationId: cancel-task-queue-delete
      tags:
      - gateway-network
      description: Cancels any tasks pending in the queue. Note that it does *not* cancel outstanding tasks that have already been dispatched to the gateway network connection.
      parameters:
      - name: serverId
        in: path
        required: true
        schema:
          type: string
      - name: queueId
        in: path
        required: true
        schema:
          type: 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/gateway-network/crawler:
    get:
      summary: Gateway Network Crawler
      operationId: gateway-network-crawler-get
      tags:
      - gateway-network
      description: Runs the Gateway Network crawler to gather information on connected gateways.
      parameters:
      - name: ignoreCrawlerCache
        in: query
        required: false
        schema:
          type: string
        description: Choose to ignore any existing cache information.
      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/gateway-network/diagnostics/getRemoteServerIds:
    get:
      summary: Get Remote Server Names
      operationId: get-remote-server-names-get
      tags:
      - gateway-network
      description: Gets the names of all remote servers.
      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/gateway-network/diagnostics/testConnectionToServer/{serverId}:
    post:
      summary: Diagnostic Ping
      operationId: diagnostic-ping-post
      tags:
      - gateway-network
      description: Pings a remote server to test connectivity.
      parameters:
      - name: serverId
        in: path
        required: true
        schema:
          type: 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/gateway-network/gatewayDetail/{serverId}:
    get:
      summary: Gateway Detail
      operationId: gateway-detail-get
      tags:
      - gateway-network
      description: Gateway network details about a specific Ignition server.
      parameters:
      - name: serverId
        in: path
        required: true
        schema:
          type: 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/gateway-network/gateways:
    get:
      summary: Gateways
      operationId: gateways-get
      tags:
      - gateway-network
      description: Information about all gateways on the Gateway Network that this Ignition server is aware of.
      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/gateway-network/livediagram:
    get:
      summary: Gateway Network Live Diagram
      operationId: gateway-network-live-diagram-get
      tags:
      - gateway-network
      description: Information describing the relationships between all Ignition systems on this Gateway Network.
      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/gateway-network/pauseQueue/{serverId}/{queueId}:
    put:
      summary: Pause Task Queue
      operationId: pause-task-queue-put
      tags:
      - gateway-network
      description: Pauses any pending tasks on the given queue, which will cause it to reject any new messages.
      parameters:
      - name: serverId
        in: path
        required: true
        schema:
          type: string
      - name: queueId
        in: path
        required: true
        schema:
          type: 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/gateway-network/remote-tag-providers/{serverId}:
    get:
      summary: Remote Tag Providers
      operationId: remote-tag-providers-get
      tags:
      - gateway-network
      description: A list of remote tag providers names for the specified remote Gateway.
      parameters:
      - name: serverId
        in: path
        required: true
        schema:
          type: string
      - 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/gateway-network/resumeQueue/{serverId}/{queueId}:
    put:
      summary: Resume Task Queue
      operationId: resume-task-queue-put
      tags:
      - gateway-network
      description: Resumes a paused task queue.
      parameters:
      - name: serverId
        in: path
        required: true
        schema:
          type: string
      - name: queueId
        in: path
        required: true
        schema:
          type: string
      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