Inductive Automation config-databases API

openapi: 3.0.3
info:
  title: Ignition Gateway REST access-control config-databases 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: config-databases
  description: Database connection configuration
paths:
  /data/api/v1/resources/datafile/ignition/database-driver/{name}/{filename}:
    get:
      summary: Get JDBC Driver Data File
      operationId: get-jdbc-driver-data-file-get
      tags:
      - config-databases
      description: Retrieve a data file from a specific JDBC Driver resource
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - name: filename
        in: path
        required: true
        schema:
          type: string
      - name: collection
        in: query
        required: false
        schema:
          type: string
        description: The configuration collection to read the file from
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
    put:
      summary: Update JDBC Driver Data File
      operationId: update-jdbc-driver-data-file-put
      tags:
      - config-databases
      description: Update (overwrite) a data file for a named JDBC Driver resource
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - name: filename
        in: path
        required: true
        schema:
          type: string
      - name: collection
        in: query
        required: false
        schema:
          type: string
        description: The configuration collection to update. If omitted, the active definition's collection will be used.
      - name: signature
        in: query
        required: false
        schema:
          type: string
        description: (Required) The current signature of the resource.
      - name: rename
        in: query
        required: false
        schema:
          type: string
        description: An optional new name for the file
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
    delete:
      summary: Delete JDBC Driver Data File
      operationId: delete-jdbc-driver-data-file-delete
      tags:
      - config-databases
      description: Delete a data file for a named JDBC Driver resource
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - name: filename
        in: path
        required: true
        schema:
          type: string
      - name: collection
        in: query
        required: false
        schema:
          type: string
        description: The configuration collection to update. If omitted, the active definition's collection will be used.
      - name: signature
        in: query
        required: false
        schema:
          type: string
        description: (Required) The current signature of the resource.
      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/resources/delete/ignition/database-connection:
    post:
      summary: Delete Database Connection (multiple)
      operationId: delete-database-connection-(multiple)-post
      tags:
      - config-databases
      description: Delete multiple Database Connection resources by name
      parameters:
      - name: confirm
        in: query
        required: false
        schema:
          type: string
        description: Whether to confirm the deletion, required when the operation would affect other resources.
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
            - name: <string>
              signature: <string>
              collection: <string>
            - name: <string>
              signature: <string>
              collection: <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/resources/delete/ignition/database-driver:
    post:
      summary: Delete JDBC Driver (multiple)
      operationId: delete-jdbc-driver-(multiple)-post
      tags:
      - config-databases
      description: Delete multiple JDBC Driver resources by name
      parameters:
      - name: confirm
        in: query
        required: false
        schema:
          type: string
        description: Whether to confirm the deletion, required when the operation would affect other resources.
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
            - name: <string>
              signature: <string>
              collection: <string>
            - name: <string>
              signature: <string>
              collection: <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/resources/delete/ignition/database-translator:
    post:
      summary: Delete Database Translator (multiple)
      operationId: delete-database-translator-(multiple)-post
      tags:
      - config-databases
      description: Delete multiple Database Translator resources by name
      parameters:
      - name: confirm
        in: query
        required: false
        schema:
          type: string
        description: Whether to confirm the deletion, required when the operation would affect other resources.
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
            - name: <string>
              signature: <string>
              collection: <string>
            - name: <string>
              signature: <string>
              collection: <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/resources/find/ignition/database-connection/{name}:
    get:
      summary: Get Database Connection Config
      operationId: get-database-connection-config-get
      tags:
      - config-databases
      description: Retrieve configuration details about a specific Database Connection resource
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - name: collection
        in: query
        required: false
        schema:
          type: string
        description: The configuration collection to read the resource from
      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/resources/find/ignition/database-driver/{name}:
    get:
      summary: Get JDBC Driver Config
      operationId: get-jdbc-driver-config-get
      tags:
      - config-databases
      description: Retrieve configuration details about a specific JDBC Driver resource
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - name: collection
        in: query
        required: false
        schema:
          type: string
        description: The configuration collection to read the resource from
      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/resources/find/ignition/database-translator/{name}:
    get:
      summary: Get Database Translator Config
      operationId: get-database-translator-config-get
      tags:
      - config-databases
      description: Retrieve configuration details about a specific Database Translator resource
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - name: collection
        in: query
        required: false
        schema:
          type: string
        description: The configuration collection to read the resource from
      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/resources/ignition/database-connection:
    put:
      summary: Modify Database Connection
      operationId: modify-database-connection-put
      tags:
      - config-databases
      description: Modify one or more Database Connection resources
      parameters:
      - name: allowInvalidReferences
        in: query
        required: false
        schema:
          type: string
        description: If true, invalid references will be allowed. Default is false.
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
            - name: <string>
              signature: <string>
              collection: <string>
              enabled: <boolean>
              description: <string>
              config:
                driver: <string>
                translator: <string>
                includeSchemaInTableName: <boolean>
                connectURL: <string>
                username: <string>
                password:
                  type: <string>
                  data:
                    protected:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    encrypted_key:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    iv:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    ciphertext:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    tag:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                connectionProps: <string>
                connectionResetParams: <string>
                defaultTransactionLevel: <string>
                poolInitSize: <number>
                poolMaxActive: <number>
                poolMaxIdle: <number>
                poolMinIdle: <number>
                poolMaxWait: <number>
                validationQuery: <string>
                testOnBorrow: <boolean>
                testOnReturn: <boolean>
                testWhileIdle: <boolean>
                evictionRate: <number>
                evictionTests: <number>
                evictionTime: <number>
                failoverProfile: <string>
                failoverMode: <string>
                slowQueryLogThreshold: <number>
                validationSleepTime: <number>
              backupConfig:
                driver: <string>
                translator: <string>
                includeSchemaInTableName: <boolean>
                connectURL: <string>
                username: <string>
                password:
                  type: <string>
                  data:
                    protected:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    encrypted_key:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    iv:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    ciphertext:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    tag:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                connectionProps: <string>
                connectionResetParams: <string>
                defaultTransactionLevel: <string>
                poolInitSize: <number>
                poolMaxActive: <number>
                poolMaxIdle: <number>
                poolMinIdle: <number>
                poolMaxWait: <number>
                validationQuery: <string>
                testOnBorrow: <boolean>
                testOnReturn: <boolean>
                testWhileIdle: <boolean>
                evictionRate: <number>
                evictionTests: <number>
                evictionTime: <number>
                failoverProfile: <string>
                failoverMode: <string>
                slowQueryLogThreshold: <number>
                validationSleepTime: <number>
            - name: <string>
              signature: <string>
              collection: <string>
              enabled: <boolean>
              description: <string>
              config:
                driver: <string>
                translator: <string>
                includeSchemaInTableName: <boolean>
                connectURL: <string>
                username: <string>
                password:
                  type: <string>
                  data:
                    protected:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    encrypted_key:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    iv:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    ciphertext:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    tag:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                connectionProps: <string>
                connectionResetParams: <string>
                defaultTransactionLevel: <string>
                poolInitSize: <number>
                poolMaxActive: <number>
                poolMaxIdle: <number>
                poolMinIdle: <number>
                poolMaxWait: <number>
                validationQuery: <string>
                testOnBorrow: <boolean>
                testOnReturn: <boolean>
                testWhileIdle: <boolean>
                evictionRate: <number>
                evictionTests: <number>
                evictionTime: <number>
                failoverProfile: <string>
                failoverMode: <string>
                slowQueryLogThreshold: <number>
                validationSleepTime: <number>
              backupConfig:
                driver: <string>
                translator: <string>
                includeSchemaInTableName: <boolean>
                connectURL: <string>
                username: <string>
                password:
                  type: <string>
                  data:
                    protected:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    encrypted_key:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    iv:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    ciphertext:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    tag:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                connectionProps: <string>
                connectionResetParams: <string>
                defaultTransactionLevel: <string>
                poolInitSize: <number>
                poolMaxActive: <number>
                poolMaxIdle: <number>
                poolMinIdle: <number>
                poolMaxWait: <number>
                validationQuery: <string>
                testOnBorrow: <boolean>
                testOnReturn: <boolean>
                testWhileIdle: <boolean>
                evictionRate: <number>
                evictionTests: <number>
                evictionTime: <number>
                failoverProfile: <string>
                failoverMode: <string>
                slowQueryLogThreshold: <number>
                validationSleepTime: <number>
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
    post:
      summary: Create Database Connection
      operationId: create-database-connection-post
      tags:
      - config-databases
      description: Create a new Database Connection resource
      parameters:
      - name: allowInvalidReferences
        in: query
        required: false
        schema:
          type: string
        description: If true, invalid references will be allowed. Default is false.
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
            - name: <string>
              collection: <string>
              enabled: <boolean>
              description: <string>
              config:
                driver: <string>
                translator: <string>
                includeSchemaInTableName: <boolean>
                connectURL: <string>
                username: <string>
                password:
                  type: <string>
                  data:
                    protected:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    encrypted_key:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    iv:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    ciphertext:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    tag:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                connectionProps: <string>
                connectionResetParams: <string>
                defaultTransactionLevel: <string>
                poolInitSize: <number>
                poolMaxActive: <number>
                poolMaxIdle: <number>
                poolMinIdle: <number>
                poolMaxWait: <number>
                validationQuery: <string>
                testOnBorrow: <boolean>
                testOnReturn: <boolean>
                testWhileIdle: <boolean>
                evictionRate: <number>
                evictionTests: <number>
                evictionTime: <number>
                failoverProfile: <string>
                failoverMode: <string>
                slowQueryLogThreshold: <number>
                validationSleepTime: <number>
              backupConfig:
                driver: <string>
                translator: <string>
                includeSchemaInTableName: <boolean>
                connectURL: <string>
                username: <string>
                password:
                  type: <string>
                  data:
                    protected:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    encrypted_key:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    iv:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    ciphertext:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    tag:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                connectionProps: <string>
                connectionResetParams: <string>
                defaultTransactionLevel: <string>
                poolInitSize: <number>
                poolMaxActive: <number>
                poolMaxIdle: <number>
                poolMinIdle: <number>
                poolMaxWait: <number>
                validationQuery: <string>
                testOnBorrow: <boolean>
                testOnReturn: <boolean>
                testWhileIdle: <boolean>
                evictionRate: <number>
                evictionTests: <number>
                evictionTime: <number>
                failoverProfile: <string>
                failoverMode: <string>
                slowQueryLogThreshold: <number>
                validationSleepTime: <number>
            - name: <string>
              collection: <string>
              enabled: <boolean>
              description: <string>
              config:
                driver: <string>
                translator: <string>
                includeSchemaInTableName: <boolean>
                connectURL: <string>
                username: <string>
                password:
                  type: <string>
                  data:
                    protected:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    encrypted_key:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    iv:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    ciphertext:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    tag:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                connectionProps: <string>
                connectionResetParams: <string>
                defaultTransactionLevel: <string>
                poolInitSize: <number>
                poolMaxActive: <number>
                poolMaxIdle: <number>
                poolMinIdle: <number>
                poolMaxWait: <number>
                validationQuery: <string>
                testOnBorrow: <boolean>
                testOnReturn: <boolean>
                testWhileIdle: <boolean>
                evictionRate: <number>
                evictionTests: <number>
                evictionTime: <number>
                failoverProfile: <string>
                failoverMode: <string>
                slowQueryLogThreshold: <number>
                validationSleepTime: <number>
              backupConfig:
                driver: <string>
                translator: <string>
                includeSchemaInTableName: <boolean>
                connectURL: <string>
                username: <string>
                password:
                  type: <string>
                  data:
                    protected:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    encrypted_key:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    iv:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    ciphertext:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                    tag:
                      value: '<Error: Too many levels of nesting to fake this schema>'
                connectionProps: <string>
                connectionResetParams: <string>
                defaultTransactionLevel: <string>
                poolInitSize: <number>
                poolMaxActive: <number>
                poolMaxIdle: <number>
                poolMinIdle: <number>
                poolMaxWait: <number>
                validationQuery: <string>
                testOnBorrow: <boolean>
                testOnReturn: <boolean>
                testWhileIdle: <boolean>
                evictionRate: <number>
                evictionTests: <number>
                evictionTime: <number>
                failoverProfile: <string>
                failoverMode: <string>
                slowQueryLogThreshold: <number>
                validationSleepTime: <number>
      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/resources/ignition/database-connection/{name}/{signature}:
    delete:
      summary: Delete Database Connection
      operationId: delete-database-connection-delete
      tags:
      - config-databases
      description: Delete a Database Connection resource by name
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - name: signature
        in: path
        required: true
        schema:
          type: string
      - name: collection
        in: query
        required: false
        schema:
          type: string
        description: The configuration collection to delete the resource from
      - name: confirm
        in: query
        required: false
        schema:
          type: string
        description: Whether to confirm the deletion, required when the operation would affect other resources.
      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/resources/ignition/database-driver:
    put:
      summary: Modify JDBC Driver
      operationId: modify-jdbc-driver-put
      tags:
      - config-databases
      description: Modify one or more JDBC Driver resources
      parameters:
      - name: allowInvalidReferences
        in: query
        required: false
        schema:
          type: string
        description: If true, invalid references will be allowed. Default is false.
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
            - name: <string>
              signature: <string>
              collection: <string>
              enabled: <boolean>
              description: <string>
              config:
                type: <string>
                defaultTranslator: <string>
                classname: <string>
                urlFormat: <string>
                urlInstructions: <string>
                defaultProps: <string>
                defaultPropInstructions: <string>
                defaultValidationQuery: <string>
              backupConfig:
                type: <string>
                defaultTranslator: <string>
                classname: <string>
                urlFormat: <string>
                urlInstructions: <string>
                defaultProps: <string>
                defaultPropInstructions: <string>
                defaultValidationQuery: <string>
            - name: <string>
              signature: <string>
              collection: <string>
              enabled: <boolean>
              description: <string>
              config:
                type: <string>
                defaultTranslator: <string>
                classname: <string>
                urlFormat: <string>
                urlInstructions: <string>
                defaultProps: <string>
                defaultPropInstructions: <string>
                defaultValidationQuery: <string>
              backupConfig:
                type: <string>
                defaultTranslator: <string>
                classname: <string>
                urlFormat: <string>
                urlInstructions: <string>
                defaultProps: <string>
                defaultPropInstructions: <string>
                defaultValidationQuery: <string>
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
    post:
      summary: Create JDBC Driver
      operationId: create-jdbc-driver-post
      tags:
      - config-databases
      description: Create a new JDBC Driver resource
      parameters:
      - name: allowInvalidReferences
        in: query
        required: false
        schema:
          type: string
        description: If true, invalid references will be allowed. Default is false.
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
            - name: <string>
              collection: <string>
              enabled: <boolean>
              description: <string>
              config:
                type: <string>
                defaultTranslator: <string>
                classname: <string>
                urlFormat: <string>
                urlInstructions: <string>
                defaultProps: <string>
                defaultPropInstructions: <string>
                defaultValidationQuery: <string>
              backupConfig:
                type: <string>
                defaultTranslator: <string>
                classname: <string>
                urlFormat: <string>
                urlInstructions: <string>
                defaultProps: <string>
                defaultPropInstructions: <string>
                defaultValidationQuery: <string>
            - name: <string>
              collection: <string>
              enabled: <boolean>
              description: <string>
              config:
                type: <string>
                defaultTranslator: <string>
                classname: <string>
               

# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/inductive-automation/refs/heads/main/openapi/inductive-automation-config-databases-api-openapi.yml