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 eam-tasks API

Enterprise Administration Module task management

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

This API exposes 17 operations across 16 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}.

17 operations 16 paths 0 schemas 2 DELETE7 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 eam-tasks 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 17

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

eam-tasks 17

Enterprise Administration Module task management

PUT
/data/api/v1/resources/com.inductiveautomation.eam/eam-tasks
Modify EAM Agent Task
modify-eam-agent-task-put body → 200400401404
POST
/data/api/v1/resources/com.inductiveautomation.eam/eam-tasks
Create EAM Agent Task
create-eam-agent-task-post body → 200400401404
DELETE
/data/api/v1/resources/com.inductiveautomation.eam/eam-tasks/{name}/{signature}
Delete EAM Agent Task
delete-eam-agent-task-delete 4 params → 200400401404
POST
/data/api/v1/resources/delete/com.inductiveautomation.eam/eam-tasks
Delete EAM Agent Task (multiple)
delete-eam-agent-task-(multiple)-post 1 param body → 200400401404
GET
/data/api/v1/resources/find/com.inductiveautomation.eam/eam-tasks/{name}
Get EAM Agent Task Config
get-eam-agent-task-config-get 2 params → 200400401404
GET
/data/api/v1/resources/list/com.inductiveautomation.eam/eam-tasks
List EAM Agent Task Resources
list-eam-agent-task-resources-get 5 params → 200400401404
GET
/data/api/v1/resources/names/com.inductiveautomation.eam/eam-tasks
Get EAM Agent Task Names
get-eam-agent-task-names-get 5 params → 200400401404
POST
/data/api/v1/resources/rename/com.inductiveautomation.eam/eam-tasks/{name}
Rename EAM Agent Task
rename-eam-agent-task-post 2 params body → 200400401404
GET
/data/api/v1/resources/type/com.inductiveautomation.eam/eam-tasks
Describe 'EAM Agent Task' Resource Type
describe-'eam-agent-task'-resource-type-get → 200400401404
POST
/data/eam/api/v1/eam-tasks/cancel/{name}
Cancel task
cancel-task-post 1 param → 200400401404
DELETE
/data/eam/api/v1/eam-tasks/clear-retry/{name}
Clear retry task data
clear-retry-task-data-delete 1 param → 200400401404
POST
/data/eam/api/v1/eam-tasks/force/{owner}/{name}
Force task execution
force-task-execution-post 3 params → 200400401404
GET
/data/eam/api/v1/eam-tasks/history
Task History
task-history-get 5 params → 200400401404
POST
/data/eam/api/v1/eam-tasks/resume/{name}
Resume task
resume-task-post 1 param → 200400401404
GET
/data/eam/api/v1/eam-tasks/retry
Get retry tasks
get-retry-tasks-get → 200400401404
GET
/data/eam/api/v1/eam-tasks/scheduled/{running}
Running or Scheduled Tasks
running-or-scheduled-tasks-get 6 params → 200400401404
POST
/data/eam/api/v1/eam-tasks/suspend/{name}
Suspend task
suspend-task-post 1 param → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

inductive-automation-eam-tasks-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