On-premise API

Workato API allows you to work with on-prem groups and on-prem agents through the API.

Quick reference

Type	Resource	Description
GET	/api/on_prem_groups	List on-prem groups.
POST	/api/on_prem_groups	Create on-prem group.
GET	/api/on_prem_groups/:id	Get on-prem group details.
PUT	/api/on_prem_groups/:id	Update on-prem group.
DELETE	/api/on_prem_groups/:id	Delete an on-prem group.
GET	/api/on_prem_groups/:id/status	Get on-prem group status.
GET	/api/on_prem_agents	List on-prem agents.
POST	/api/on_prem_agents	Create on-prem agent.
GET	/api/on_prem_agents/:id	Get on-prem agent details.
PUT	/api/on_prem_agents/:id	Update on-prem agent.
DELETE	/api/on_prem_agents/:id	List on-prem agents.
GET	/api/on_prem_agents/:id/status	Get on-prem agent status.
GET	/api/on_prem_agents/search	Search for on-prem agent.

List on-prem groups

List all on-prem groups in your workspace.

GET /api/on_prem_groups

Response

[
  {
    "id": 16803,
    "name": "CRM server",
    "created_at": "2017-09-21T01:51:45.954-07:00"
  }
]

Create on-prem group

Create an on-prem group.

POST /api/on_prem_groups

Payload

Name	Type	Description
name	string	The on-prem group name.

Sample request

curl  -X POST 'https://www.workato.com/api/on_prem_groups' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d  '{
             "name":"CRM server"
          }'

Response

[
  {
    "id": 16803,
    "name": "CRM server",
    "created_at": "2017-09-21T01:51:45.954-07:00"
  }
]

Get on-prem group details

Get details about an on-prem group.

GET /api/on_prem_groups/:id

URL parameters

Name	Type	Description
id	integer	On-prem group ID.

Response

[
  {
    "id": 16803,
    "name": "CRM server",
    "created_at": "2017-09-21T01:51:45.954-07:00"
  }
]

Update on-prem group

Update an on-prem group.

PUT /api/on_prem_groups/:id

URL parameters

Name	Type	Description
id	integer	On-prem group ID.

Payload

Name	Type	Description
name	string	The on-prem group name.

Sample request

curl  -X PUT 'https://www.workato.com/api/on_prem_groups/16803' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d  '{
             "name":"CRM server"
          }'

Response

[
  {
    "id": 16803,
    "name": "CRM server",
    "created_at": "2017-09-21T01:51:45.954-07:00"
  }
]

Delete on-prem group

Delete an on-prem group. All on-prem agents in this group will be deleted.

DELETE /api/on_prem_groups/:id

URL parameters

Name	Type	Description
id	integer	On-prem group ID.

Response

{
  "success": true
}

Get on-prem group status

Get the status of an on-prem group.

GET /api/on_prem_groups/:id/status

URL parameters

Name	Type	Description
id	integer	On-prem group ID.

Response

{
  "agent_count": 4,
  "active_agent_count": 3,
  "profiles": [
    {
      "name": "CRM-Oracle",
      "provider": "oracle",
      "type": "Database",
      "connections": [
        {
          "id": 440724,
          "name": "Oracle CRM DB"
        }
      ]
    }
  ]
}

List on-prem agents

List all on-prem agents in your workspace.

GET /api/on_prem_agents

Response

[
  {
    "id": 12233,
    "on_prem_group_id": 16803,
    "name": "primary agent",
    "cn": "134fd7acd89cf5b8b96deea4870d413d:12233",
    "os": "windows",
    "awaiting_setup": true,
    "enabled": true
  }
]

Response schema

Name	Description
name	The on-prem agent name.
os	The server operating system. Available OS are windows, linux, and mac
on_prem_group_id	The on-prem group ID.
awaiting_setup	True if agent is not configured.
enabled	True if agent is enabled.

Create on-prem agent

Create an on-prem agent.

POST /api/on_prem_agents

Payload

Name	Type	Description
name	string	The on-prem agent name.
os	string	The server operating system.
on_prem_group_id	integer	The on-prem group ID. See List on-prem groups.
awaiting_setup	boolean optional	true if agent should be created in awaiting setup state. Set to false to skip agent setup and get its status right away.

Sample request

curl  -X POST 'https://www.workato.com/api/on_prem_agents' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d  '{
              "name": "US-west-1",
              "on_prem_group_id": 50,
              "os": "windows",
              "awaiting_setup": false
           }'

Response

[
  {
    "id": 12233,
    "on_prem_group_id": 16803,
    "name": "primary agent",
    "cn": "134fd7acd89cf5b8b96deea4870d413d:12233",
    "os": "windows",
    "awaiting_setup": false,
    "enabled": true
  }
]

Get on-prem agent details

Get details of an on-prem agent.

GET /api/on_prem_agents/:id

URL parameters

Name	Type	Description
id	integer	On-prem agent ID.

Response

[
  {
    "id": 12233,
    "on_prem_group_id": 16803,
    "name": "primary agent",
    "cn": "134fd7acd89cf5b8b96deea4870d413d:12233",
    "os": "windows",
    "awaiting_setup": false,
    "enabled": true
  }
]

Update on-prem agent

Update an on-prem agent.

PUT /api/on_prem_agents/:id

URL parameters

Name	Type	Description
id	integer	On-prem agent ID.

Payload

Name	Type	Description
name	string	The on-prem agent name.
os	string	The server operating system.
on_prem_group_id	integer	The on-prem group ID. See List on-prem groups.

Sample request

curl  -X POST 'https://www.workato.com/api/on_prem_agents/12233' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d  '{
              "name": "primary agent"d
           }'

Response

[
  {
    "id": 12233,
    "on_prem_group_id": 16803,
    "name": "primary agent",
    "cn": "134fd7acd89cf5b8b96deea4870d413d:12233",
    "os": "windows",
    "awaiting_setup": false,
    "enabled": true
  }
]

Delete on-prem agent

Delete an on-prem agent.

DELETE /api/on_prem_agents/:id

URL parameters

Name	Type	Description
id	integer	On-prem agent ID.

Response

{
  "success": true
}

Get on-prem agent status

Get status of an on-prem agent.

GET /api/on_prem_agents/:id/status

URL parameters

Name	Type	Description
id	integer	On-prem agent ID.

Response

{
  "active": true
}

Search for on-prem agent by common name

Get on-prem agents that matches a common name.

GET /api/on_prem_agents/search

URL parameters

Name	Type	Description
cn	string	Common name of on-prem agent.

Response

[
  {
    "id": 12233,
    "on_prem_group_id": 16803,
    "name": "primary agent",
    "cn": "134fd7acd89cf5b8b96deea4870d413d:12233",
    "os": "windows",
    "awaiting_setup": false,
    "enabled": true
  }
]