Inductive Automation config-databases API

Database connection configuration

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

30 operations 25 paths 0 schemas 4 DELETE13 GET9 POST4 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

Contact

Inductive Automation Support

License

Commercial

Resource Areas

Authentication & Security 1

Inductive Automation config-databases 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 30

Across 25 paths, the API surfaces 30 operations — 4 DELETE, 13 GET, 9 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

config-databases 30

Database connection configuration

GET

/data/api/v1/resources/datafile/ignition/database-driver/{name}/{filename}

Get JDBC Driver Data File

get-jdbc-driver-data-file-get 3 params → 200400401404

PUT

/data/api/v1/resources/datafile/ignition/database-driver/{name}/{filename}

Update JDBC Driver Data File

update-jdbc-driver-data-file-put 5 params → 200400401404

DELETE

/data/api/v1/resources/datafile/ignition/database-driver/{name}/{filename}

Delete JDBC Driver Data File

delete-jdbc-driver-data-file-delete 4 params → 200400401404

POST

/data/api/v1/resources/delete/ignition/database-connection

Delete Database Connection (multiple)

delete-database-connection-(multiple)-post 1 param body → 200400401404

POST

/data/api/v1/resources/delete/ignition/database-driver

Delete JDBC Driver (multiple)

delete-jdbc-driver-(multiple)-post 1 param body → 200400401404

POST

/data/api/v1/resources/delete/ignition/database-translator

Delete Database Translator (multiple)

delete-database-translator-(multiple)-post 1 param body → 200400401404

GET

/data/api/v1/resources/find/ignition/database-connection/{name}

Get Database Connection Config

get-database-connection-config-get 2 params → 200400401404

GET

/data/api/v1/resources/find/ignition/database-driver/{name}

Get JDBC Driver Config

get-jdbc-driver-config-get 2 params → 200400401404

GET

/data/api/v1/resources/find/ignition/database-translator/{name}

Get Database Translator Config

get-database-translator-config-get 2 params → 200400401404

PUT

/data/api/v1/resources/ignition/database-connection

Modify Database Connection

modify-database-connection-put 1 param body → 200400401404

POST

/data/api/v1/resources/ignition/database-connection

Create Database Connection

create-database-connection-post 1 param body → 200400401404

DELETE

/data/api/v1/resources/ignition/database-connection/{name}/{signature}

Delete Database Connection

delete-database-connection-delete 4 params → 200400401404

PUT

/data/api/v1/resources/ignition/database-driver

Modify JDBC Driver

modify-jdbc-driver-put 1 param body → 200400401404

POST

/data/api/v1/resources/ignition/database-driver

Create JDBC Driver

create-jdbc-driver-post 1 param body → 200400401404

DELETE

/data/api/v1/resources/ignition/database-driver/{name}/{signature}

Delete JDBC Driver

delete-jdbc-driver-delete 4 params → 200400401404

PUT

/data/api/v1/resources/ignition/database-translator

Modify Database Translator

modify-database-translator-put body → 200400401404

POST

/data/api/v1/resources/ignition/database-translator

Create Database Translator

create-database-translator-post body → 200400401404

DELETE

/data/api/v1/resources/ignition/database-translator/{name}/{signature}

Delete Database Translator

delete-database-translator-delete 4 params → 200400401404

GET

/data/api/v1/resources/list/ignition/database-connection

List Database Connection Resources

list-database-connection-resources-get 5 params → 200400401404

GET

/data/api/v1/resources/list/ignition/database-driver

List JDBC Driver Resources

list-jdbc-driver-resources-get 5 params → 200400401404

GET

/data/api/v1/resources/list/ignition/database-translator

List Database Translator Resources

list-database-translator-resources-get 5 params → 200400401404

GET

/data/api/v1/resources/names/ignition/database-connection

Get Database Connection Names

get-database-connection-names-get 5 params → 200400401404

GET

/data/api/v1/resources/names/ignition/database-driver

Get JDBC Driver Names

get-jdbc-driver-names-get 5 params → 200400401404

GET

/data/api/v1/resources/names/ignition/database-translator

Get Database Translator Names

get-database-translator-names-get 5 params → 200400401404

POST

/data/api/v1/resources/rename/ignition/database-connection/{name}

Rename Database Connection

rename-database-connection-post 2 params body → 200400401404

POST

/data/api/v1/resources/rename/ignition/database-driver/{name}

Rename JDBC Driver

rename-jdbc-driver-post 2 params body → 200400401404

POST

/data/api/v1/resources/rename/ignition/database-translator/{name}

Rename Database Translator

rename-database-translator-post 2 params body → 200400401404

GET

/data/api/v1/resources/type/ignition/database-connection

Describe 'Database Connection' Resource Type

describe-'database-connection'-resource-type-get → 200400401404

GET

/data/api/v1/resources/type/ignition/database-driver

Describe 'JDBC Driver' Resource Type

describe-'jdbc-driver'-resource-type-get → 200400401404

GET

/data/api/v1/resources/type/ignition/database-translator

Describe 'Database Translator' Resource Type

describe-'database-translator'-resource-type-get → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Inductive Automation publishes across the network.

Ignition Gateway REST API

AE Profile APIs.io

Inductive Automation access-control API

AE Profile APIs.io

Inductive Automation agent-group API

AE Profile APIs.io

Inductive Automation agent-management API

AE Profile APIs.io

Inductive Automation alarm-journal-resources API

AE Profile APIs.io

Inductive Automation alarm-notification-profile API

AE Profile APIs.io

Inductive Automation api-token API

AE Profile APIs.io

Inductive Automation audit API

AE Profile APIs.io

Inductive Automation call-script API

AE Profile APIs.io

Inductive Automation certificate-management API

AE Profile APIs.io

Inductive Automation charts-info API

AE Profile APIs.io

Inductive Automation client-pki-certificate-management API

AE Profile APIs.io

#config-databases

← Back to I APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Inductive Automation config-databases API

Metadata

Authentication & Security 1

Paths & Operations 30

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Inductive Automation config-databases API

Metadata

Authentication & Security 1

Paths & Operations 30

Specification

Source

More from Inductive Automation 12

API Details

Provider

Explore more