Inductive Automation executors API

openapi: 3.0.3
info:
  title: Ignition Gateway REST access-control executors 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: executors
  description: Thread pool executor management
paths:
  /data/api/v1/executors/private:
    get:
      summary: Private
      operationId: private-get
      tags:
      - executors
      description: Details on the executors running on private execution pools on this Ignition Gateway.
      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/executors/shared:
    get:
      summary: Shared
      operationId: shared-get
      tags:
      - executors
      description: Details on the executors running on the shared execution pool.
      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
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