Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
Embedded API
リソース

オンプレミス ​

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

次のエンドポイントを使用して、オンプレミスグループおよびオンプレミスエージェントをプログラムで管理します。

レート制限 ​

オンプレミスリソースには、次のレート制限があります:

タイプリソース制限
すべてすべてのオンプレミスエンドポイント1分あたり60リクエスト

クイックリファレンス ​

タイプリソース説明
GET/api/v2/managed_users/:id/on_prem_groupsカスタマーワークスペース内のオンプレミスグループを一覧表示します。
POST/api/v2/managed_users/:id/on_prem_groupsカスタマーワークスペース内にオンプレミスグループを作成します。
GET/api/v2/managed_users/:id/on_prem_groups/:group_idカスタマーワークスペース内のオンプレミスグループの詳細を取得します。
PUT/api/v2/managed_users/:id/on_prem_groups/:group_idカスタマーワークスペース内のオンプレミスグループを更新します。
DELETE/api/v2/managed_users/:id/on_prem_groups/:group_idカスタマーワークスペース内のオンプレミスグループを削除します。
GET/api/v2/managed_users/:id/on_prem_groups/:group_id/statusカスタマーワークスペース内のオンプレミスグループのステータスを取得します。
GET/api/v2/managed_users/:id/on_prem_agentsカスタマーワークスペース内のオンプレミスエージェントを一覧表示します。
POST/api/v2/managed_users/:id/on_prem_agentsカスタマーワークスペース内にオンプレミスエージェントを作成します。
GET/api/v2/managed_users/:id/on_prem_agents/:agent_idIDを使用して、カスタマーワークスペース内の特定のオンプレミスエージェントの詳細を取得します。
PUT/api/v2/managed_users/:id/on_prem_agents/:agent_idカスタマーワークスペース内のオンプレミスエージェントを更新します。
DELETE/api/v2/managed_users/:id/on_prem_agents/:agent_idカスタマーワークスペース内のオンプレミスエージェントを削除します。
GET/api/v2/managed_users/:id/on_prem_agents/:agent_id/statusカスタマーワークスペース内のオンプレミスエージェントのステータスを取得します。
GET/api/v2/managed_users/:id/on_prem_agents/search共通名に基づいて、カスタマーワークスペース内のオンプレミスエージェントを検索します。

オンプレミスグループの一覧表示 ​

カスタマーワークスペース内のすべてのオンプレミスグループのリストを取得します。

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

URLパラメーター ​

名前タイプ説明
idstring
必須		Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭にEを付ける必要があります（例: EA2300）。

サンプルリクエスト ​

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

レスポンス ​

json
{
    "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,
            "whitelisted_ips": [
              "198.51.100.10",
              "192.0.2.0/24"
            ]
        }
    ]
}

オンプレミスグループの作成 ​

カスタマーワークスペース内にオンプレミスグループを作成します。

shell
POST /api/v2/managed_users/:id/on_prem_groups

URLパラメーター ​

名前タイプ説明
idstring
必須		Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭にEを付ける必要があります（例: EA2300）。

ペイロード ​

名前タイプ説明
namestring
必須		オンプレミスグループの名前。
use_managed_connectionboolean
optional		クラウドプロファイルを使用してオンプレミスグループを設定するにはtrueに設定し、config.ymlファイルを使用して各エージェントを手動で設定するにはfalseに設定します。 指定しない場合、デフォルトはfalseです。
settings_attributes[whitelisted_ips]array of strings
optional		オンプレミスグループで許可リストに登録するIPを定義します。

サンプルリクエスト ​

shell
curl -X POST 'https://www.workato.com/api/v2/managed_users/12345/on_prem_groups' \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
          "name": "CRM server",
          "use_managed_connection": true,
          "settings_attributes": {
            "whitelisted_ips": [
              "198.51.100.10",
              "192.0.2.0/24"
            ]
          }
         }'

サンプルレスポンス ​

json
{
  "data": {
    "id": 16803,
    "name": "CRM server",
    "created_at": "2025-07-24T12:53:23.255-07:00",
    "use_managed_connection": true,
    "config_version": null,
    "in_use": false,
    "logs_enabled": false,
    "whitelisted_ips": [
        "198.51.100.10",
        "192.0.2.0/24"
    ]
  }
}

オンプレミスグループの詳細の取得 ​

カスタマーワークスペース内のオンプレミスグループの詳細を取得します。

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

URLパラメーター ​

名前タイプ説明
idstring
必須		Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭にEを付ける必要があります（例: EA2300）。
group_idinteger
required		取得するオンプレミスグループのID。

サンプルリクエスト ​

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

レスポンス例 ​

json
[
  {
    "id": 16803,
    "name": "CRM server",
    "created_at": "2017-09-21T01:51:45.954-07:00",
    "use_managed_connection": false,
    "config_version": null,
    "in_use": false,
    "logs_enabled": false,
    "whitelisted_ips": [
      "198.51.100.10",
      "192.0.2.0/24"
    ]
  }
]

オンプレミスグループの更新 ​

カスタマーワークスペース内のオンプレミスグループを更新します。

shell
PUT /api/v2/managed_users/:id/on_prem_groups/:group_id

URLパラメーター ​

名前タイプ説明
idstring
必須		Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭にEを付ける必要があります（例: EA2300）。
group_idinteger
required		オンプレミスグループのID。

ペイロード ​

名前タイプ説明
namestring
任意		オンプレミスグループの名前。
settings_attributes[whitelisted_ips]array of strings
optional		オンプレミスグループで許可リストに登録するIPを定義します。

サンプルリクエスト ​

shell
curl -X PUT 'https://www.workato.com/api/v2/managed_users/12345/on_prem_groups/16803' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d  '{
             "name": "CRM server",
             "settings_attributes": {
                "whitelisted_ips": [
                  "198.51.100.55",
                  "192.0.2.0/5"
                ]
              }
            }'

レスポンス例 ​

json
[
  {
    "id": 16803,
    "name": "CRM server",
    "created_at": "2017-09-21T01:51:45.954-07:00",
    "use_managed_connection": false,
    "config_version": null,
    "in_use": false,
    "logs_enabled": false,
    "whitelisted_ips": [
      "198.51.100.55",
      "192.0.2.0/5"
    ]
  }
]

オンプレミスグループの削除 ​

カスタマーワークスペース内のオンプレミスグループを削除します。

shell
DELETE /api/v2/managed_users/:id/on_prem_groups/:group_id

URLパラメーター ​

名前タイプ説明
idstring
必須		Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭にEを付ける必要があります（例: EA2300）。
group_idinteger
required		オンプレミスグループのID。

サンプルリクエスト ​

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

レスポンス例 ​

json
{
  "success": true
}

オンプレミスグループのステータスの取得 ​

カスタマーワークスペース内のオンプレミスグループのステータスを取得します。

shell
GET /api/v2/managed_users/:id/on_prem_groups/:group_id/status

URLパラメーター ​

名前タイプ説明
idstring
必須		Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭にEを付ける必要があります（例: EA2300）。
group_idinteger
required		オンプレミスグループのID。

サンプルリクエスト ​

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

レスポンス例 ​

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

オンプレミスエージェントの一覧表示 ​

カスタマーワークスペース内のすべてのオンプレミスエージェントのリストを取得します。

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

URLパラメーター ​

名前タイプ説明
idstring
必須		Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭にEを付ける必要があります（例: EA2300）。

サンプルリクエスト ​

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

レスポンス ​

json
{
    "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:29104",
            "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:29105",
            "on_prem_group_id": 12345
        }
    ]
}

オンプレミスエージェントの作成 ​

カスタマーワークスペース内にオンプレミスエージェントを作成します。

shell
POST /api/v2/managed_users/:id/on_prem_agents

URLパラメーター ​

名前タイプ説明
idstring
必須		Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭にEを付ける必要があります（例: EA2300）。

ペイロード ​

名前タイプ説明
namestring
必須		オンプレミスエージェントの名前。
osstring
任意		サーバーのオペレーティングシステム。
on_prem_group_idinteger
required		オンプレミスグループのID。 グループIDは、オンプレミスグループの一覧表示エンドポイントのレスポンスから取得できます。
awaiting_setupboolean
optional		エージェントをawaiting_setup状態で作成するにはtrueに設定します。 エージェントのセットアップをスキップしてすぐにステータスを取得するには、falseに設定します。 指定しない場合、デフォルトはtrueです。

サンプルリクエスト ​

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

レスポンス例 ​

json
[
  {
    "id": 71144,
    "name": "US-west-1",
    "os": "windows",
    "installation_method": null,
    "awaiting_setup": false,
    "enabled": true,
    "last_seen_version": null,
    "created_at": "2025-07-16T07:10:32.231-07:00",
    "updated_at": "2025-07-16T07:10:32.487-07:00",
    "state": "connected",
    "activated": false,
    "cn": "30a600473728b596e63ee8b30e3dd648:71144",
    "on_prem_group_id": 33830
  }
]

オンプレミスエージェントの詳細を取得 ​

一意のIDを使用して、カスタマーワークスペース内のオンプレミスエージェントの詳細を取得します。

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

URLパラメーター ​

名前タイプ説明
idstring
必須		Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭にEを付ける必要があります（例: EA2300）。
agent_idnumber
必須		詳細を取得するオンプレミスエージェントのID。

リクエスト例 ​

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

レスポンス ​

json
{
    "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
        }
    ]
}

オンプレミスエージェントの更新 ​

カスタマーワークスペース内のオンプレミスエージェントを更新します。

shell
PUT /api/v2/managed_users/:id/on_prem_agents/:agent_id

URLパラメーター ​

名前タイプ説明
idstring
必須		Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭にEを付ける必要があります（例: EA2300）。
agent_idstring
必須		オンプレミスエージェントのID。

ペイロード ​

名前タイプ説明
namestring
任意		オンプレミスエージェントの名前。
osstring
任意		サーバーのオペレーティングシステム。
on_prem_group_idinteger任意オンプレミスグループのID。 グループIDは、オンプレミスグループの一覧表示エンドポイントのレスポンスから取得できます。

サンプルリクエスト ​

shell
curl -X PUT 'https://www.workato.com/api/v2/managed_users/12345/on_prem_agents/12233' \
      -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
           "name": "primary agent",
           "os": "windows",
           "on_prem_group_id": 16803
         }'

レスポンス例 ​

json
[
  {
    "id": 12233,
    "name": "US-west-1",
    "os": "windows",
    "installation_method": null,
    "awaiting_setup": false,
    "enabled": true,
    "last_seen_version": null,
    "created_at": "2025-07-16T07:10:32.231-07:00",
    "updated_at": "2025-07-16T07:10:32.487-07:00",
    "state": "connected",
    "activated": false,
    "cn": "30a600473728b596e63ee8b30e3dd648:12233",
    "on_prem_group_id": 16803
  }
]

オンプレミスエージェントの削除 ​

カスタマーワークスペース内のオンプレミスエージェントを削除します。

shell
DELETE /api/v2/managed_users/:id/on_prem_agents/:agent_id

URLパラメーター ​

名前タイプ説明
idstring
必須		Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭にEを付ける必要があります（例: EA2300）。
agent_idstring
必須		オンプレミスエージェントのID。

レスポンス例 ​

json
{
  "success": true
}

オンプレミスエージェントのステータスの取得 ​

カスタマーワークスペース内のオンプレミスエージェントのステータスを取得します。

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

URLパラメーター ​

名前タイプ説明
idstring
必須		Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭にEを付ける必要があります（例: EA2300）。
agent_idstring
必須		オンプレミスエージェントのID。

サンプルリクエスト ​

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

レスポンス例 ​

json
{
  "active": true
}

オンプレミスエージェントを検索 ​

共通名に基づいて、カスタマーワークスペース内のオンプレミスエージェントを検索します。

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

URLパラメーター ​

名前タイプ説明
idstring
必須		Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭にEを付ける必要があります（例: EA2300）。
cnstring
任意		取得するオンプレミスエージェントの共通名。 すべてのエージェントを返すには、このパラメーターを省略します。

リクエスト例 ​

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

レスポンス例 ​

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

Last updated: