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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Inductive Automation

Inductive Automation agent-management API

EAM agent management

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 21 operations across 20 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}.

21 operations 20 paths 0 schemas 2 DELETE13 GET5 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
Contact
Inductive Automation Support
License
Commercial
Resource Areas
1

Authentication & Security 1

Inductive Automation agent-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 21

Across 20 paths, the API surfaces 21 operations — 2 DELETE, 13 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

agent-management 21

EAM agent management

PUT
/data/api/v1/resources/com.inductiveautomation.eam/agent-management
Modify Agent Management
modify-agent-management-put 1 param body → 200400401404
POST
/data/api/v1/resources/com.inductiveautomation.eam/agent-management
Create Agent Management
create-agent-management-post 1 param body → 200400401404
DELETE
/data/api/v1/resources/com.inductiveautomation.eam/agent-management/{name}/{signature}
Delete Agent Management
delete-agent-management-delete 4 params → 200400401404
POST
/data/api/v1/resources/delete/com.inductiveautomation.eam/agent-management
Delete Agent Management (multiple)
delete-agent-management-(multiple)-post 1 param body → 200400401404
GET
/data/api/v1/resources/find/com.inductiveautomation.eam/agent-management/{name}
Get Agent Management Config
get-agent-management-config-get 2 params → 200400401404
GET
/data/api/v1/resources/list/com.inductiveautomation.eam/agent-management
List Agent Management Resources
list-agent-management-resources-get 5 params → 200400401404
GET
/data/api/v1/resources/names/com.inductiveautomation.eam/agent-management
Get Agent Management Names
get-agent-management-names-get 5 params → 200400401404
POST
/data/api/v1/resources/rename/com.inductiveautomation.eam/agent-management/{name}
Rename Agent Management
rename-agent-management-post 2 params body → 200400401404
GET
/data/api/v1/resources/type/com.inductiveautomation.eam/agent-management
Describe 'Agent Management' Resource Type
describe-'agent-management'-resource-type-get → 200400401404
GET
/data/eam/api/v1/agent-details/{agentName}
EAM Agent Details Overview
eam-agent-details-overview-get 1 param → 200400401404
GET
/data/eam/api/v1/agent-licenses/{agentName}
EAM Agent License Keys
eam-agent-license-keys-get 1 param → 200400401404
GET
/data/eam/api/v1/agent-management/modules
Retrieve agent modules
retrieve-agent-modules-get 1 param → 200400401404
GET
/data/eam/api/v1/agent-management/project-resources
Retrieve project resources
retrieve-project-resources-get 3 params → 200400401404
GET
/data/eam/api/v1/agent-management/projects
Retrieve projects names
retrieve-projects-names-get 2 params → 200400401404
GET
/data/eam/api/v1/agent-management/upgrade-info
Retrieve agent info for upgrade
retrieve-agent-info-for-upgrade-get 1 param → 200400401404
GET
/data/eam/api/v1/agents
EAM Agents Status
eam-agents-status-get 5 params → 200400401404
GET
/data/eam/api/v1/agents-by-group
EAM Agents by Agent Group
eam-agents-by-agent-group-get 5 params → 200400401404
POST
/data/eam/api/v1/approve-agent/{serverid}
Approve agent
approve-agent-post 1 param → 200400401404
GET
/data/eam/api/v1/quarantined-agents
Quarantined agents
quarantined-agents-get → 200400401404
DELETE
/data/eam/api/v1/quarantined-agents/{serverid}
Delete quarantined agent
delete-quarantined-agent-delete 1 param → 200400401404
POST
/data/eam/api/v1/upgrade-agent/{groupName}/{agentName}
Upgrade Agent
upgrade-agent-post 2 params → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

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 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
Inductive Automation config-alarm API
AE Profile APIs.io
#agent-management
← Back to I APIs
API Details
ID
inductive-automation:inductive-automation-agent-management-api
Base URL
https://{gateway-host}:8088/api
Docs
https://www.docs.inductiveautomation.com/docs/8.3/platform/gateway/openapi
Provider
Inductive Automation
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network