On-prem

Use the following endpoints to work with On-prem Groups and On-prem Agents programmatically.

Quick reference

Type	Resource	Description
GET	/api/v2/managed_users/:id/on_prem_groups	List On-prem Groups in a customer workspace.
GET	/api/v2/managed_users/:id/on_prem_agents	List On-prem Agents in a customer workspace.
GET	/api/v2/managed_users/:id/on_prem_agents/:agent_id	Retrieve the details of a specific On-prem Agent in a customer workspace using its ID.

List On-prem Groups

Retrieves a list of all On-prem Groups in a customer workspace.

GET /api/v2/managed_users/:id/on_prem_groups

URL parameters

Name	Type	Description
id	string required	Embedded customer ID/external ID. The External ID must be URL encoded and prefixed with an E (for example, EA2300).

Sample request

curl  -X GET 'https://www.workato.com/api/v2/managed_users/12345/on_prem_groups' \
      -H 'Authorization: Bearer <api_token>'

Response

{
    "data": [
        {
            "id": 2159,
            "name": "DevOps Network",
            "created_at": "2024-09-25T13:09:31.292-07:00",
            "use_managed_connection": true,
            "config_version": null,
            "in_use": false,
            "logs_enabled": false
        }
    ]
}

List On-prem Agents

Retrieves a list of all On-prem Agents in a customer workspace.

GET /api/v2/managed_users/:id/on_prem_agents

URL parameters

Name	Type	Description
id	string required	Embedded customer ID/external ID. The External ID must be URL encoded and prefixed with an E (for example, EA2300).

Sample request

curl  -X GET 'https://www.workato.com/api/v2/managed_users/12345/on_prem_agents' \
      -H 'Authorization: Bearer <api_token>'

Response

{
    "data": [
        {
            "id": 29104,
            "name": "Marketing(Cupertino)",
            "os": "mac",
            "installation_method": null,
            "awaiting_setup": true,
            "enabled": true,
            "last_seen_version": null,
            "created_at": "2024-09-25T13:21:43.292-07:00",
            "updated_at": "2024-09-25T13:21:43.292-07:00",
            "state": "awaiting_setup",
            "activated": true,
            "cn": "134fd7acd89cf5b8b96deea4870d413d:12233",
            "on_prem_group_id": 12345
        },
        {
            "id": 29105,
            "name": "Sales(Cupertino)",
            "os": "mac",
            "installation_method": null,
            "awaiting_setup": true,
            "enabled": true,
            "last_seen_version": null,
            "created_at": "2024-09-26T09:15:30.123-07:00",
            "updated_at": "2024-09-26T09:15:30.123-07:00",
            "state": "awaiting_setup",
            "activated": true,
            "cn": "e29f4b6d8e1845e299e5c8cfb7f72d4a:45678",
            "on_prem_group_id": 12345
        }
    ]
}

Get details about an On-prem Agent

Retrieves detailed information about an On-prem Agent within a customer workspace using its unique ID.

GET /api/v2/managed_users/:id/on_prem_agents/:agent_id

URL parameters

Name	Type	Description
id	string required	Embedded customer ID/external ID. The External ID must be URL encoded and prefixed with an E (for example, EA2300).
agent_id	number required	The ID of the On-prem Agent that you plan to retrieve details about.

Sample request

curl  -X GET 'https://www.workato.com/api/v2/managed_users/12345/on_prem_agents/29104' \
      -H 'Authorization: Bearer <api_token>'

Response

{
    "data": [
        {
            "id": 29104,
            "name": "Marketing(Cupertino)",
            "os": "mac",
            "installation_method": null,
            "awaiting_setup": true,
            "enabled": true,
            "last_seen_version": null,
            "created_at": "2024-09-25T13:21:43.292-07:00",
            "updated_at": "2024-09-25T13:21:43.292-07:00",
            "state": "awaiting_setup",
            "activated": true,
            "cn": "134fd7acd89cf5b8b96deea4870d413d:12233",
            "on_prem_group_id": 12345
        }
    ]
}