Inductive Automation general API

openapi: 3.0.3
info:
  title: Ignition Gateway REST access-control general 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: general
paths:
  /data/config/journal/edge/edit:
    get:
      summary: /data/config/journal/edge/edit
      operationId: -data-config-journal-edge-edit-get
      tags:
      - general
      parameters:
      - name: defaultIfUndefined
        in: query
        required: false
        schema:
          type: string
        description: If true, and the configuration is undefined, returns the default edge journal configuration.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
  /data/sipcall-scripts/available-locales:
    get:
      summary: /data/sipcall-scripts/available-locales
      operationId: -data-sipcall-scripts-available-locales-get
      tags:
      - general
      parameters:
      - name: includeVariants
        in: query
        required: false
        schema:
          type: string
        description: Include local variants in the results
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
  /data/config/journal/getRemoteJournalNames:
    get:
      summary: /data/config/journal/getRemoteJournalNames
      operationId: -data-config-journal-getremotejournalnames-get
      tags:
      - general
      parameters:
      - name: gatewayName
        in: query
        required: false
        schema:
          type: string
        description: (Required) The name of the remote gateway to query for alarm journal names.
      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