Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Inductive Automation config-management API

General configuration management

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

This API exposes 14 operations across 8 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}.

14 operations 8 paths 0 schemas 1 DELETE5 GET7 POST1 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
License
Resource Areas
1

Authentication & Security 1

Inductive Automation config-management 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 14

Across 8 paths, the API surfaces 14 operations — 1 DELETE, 5 GET, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

config-management 14

General configuration management

GET
/data/api/v1/mode
Deployment Modes
deployment-modes-get 5 params → 200400401404
POST
/data/api/v1/mode
Create Deployment Mode
create-deployment-mode-post body → 200400401404
PUT
/data/api/v1/mode/{name}
Update Deployment Mode
update-deployment-mode-put 1 param body → 200400401404
DELETE
/data/api/v1/mode/{name}
Delete Deployment Mode
delete-deployment-mode-delete 1 param → 200400401404
POST
/data/api/v1/resources/copy
Copy a Resource
copy-a-resource-post 6 params → 200400401404
POST
/data/api/v1/resources/move
Move a Resource
move-a-resource-post 5 params → 200400401404
GET
/data/api/v1/scan-lock/config
Configuration Scan Lock Info
configuration-scan-lock-info-get → 200400401404
POST
/data/api/v1/scan-lock/config
Acquire Configuration Scan Lock
acquire-configuration-scan-lock-post body → 200400401404
GET
/data/api/v1/scan-lock/projects
Project Scan Lock Info
project-scan-lock-info-get → 200400401404
POST
/data/api/v1/scan-lock/projects
Acquire Project Scan Lock
acquire-project-scan-lock-post body → 200400401404
GET
/data/api/v1/scan/config
Configuration Scan Status
configuration-scan-status-get → 200400401404
POST
/data/api/v1/scan/config
Request Configuration Scan
request-configuration-scan-post → 200400401404
GET
/data/api/v1/scan/projects
Project Scan Status
project-scan-status-get → 200400401404
POST
/data/api/v1/scan/projects
Request Project Scan
request-project-scan-post → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

inductive-automation-config-management-api-openapi.yml Raw ↑

Other APIs Inductive Automation publishes across the network.

Ignition Gateway REST API
Inductive Automation access-control API
Inductive Automation agent-group API
Inductive Automation agent-management API
Inductive Automation alarm-journal-resources API
Inductive Automation alarm-notification-profile API
Inductive Automation api-token API
Inductive Automation audit API
Inductive Automation call-script API
Inductive Automation certificate-management API
Inductive Automation charts-info API
Inductive Automation client-pki-certificate-management API