On-premise API

Workato API allows you to work with On-prem Groups and On-prem Agents through the API.

Quick reference

TypeResourceDescription
GET/api/on_prem_agentsList On-prem agents
POST/api/on_prem_agentsCreate On-prem agent
GET/api/on_prem_agents/searchSearch for On-prem agent by common name
DELETE/api/on_prem_agents/:idDelete On-prem agent
GET/api/on_prem_agents/:id/activation_codeGet on-prem agent activation code.
GET/api/on_prem_agents/:idGet On-prem agent details
PUT/api/on_prem_agents/:idUpdate On-prem agent
GET/api/on_prem_agents/:id/statusGet On-prem agent status
GET/api/on_prem_groupsList On-prem groups
POST/api/on_prem_groupsCreate On-prem group
DELETE/api/on_prem_groups/:idDelete On-prem group
GET/api/on_prem_groups/:idGet On-prem group details
PUT/api/on_prem_groups/:idUpdate On-prem group
GET/api/on_prem_groups/:id/statusGet On-prem group status