コネクション

コネクションを管理するには、次のエンドポイントを使用します。

レート制限

コネクションリソースには、次のレート制限があります:

タイプ	リソース	制限
GET	コネクションを一覧表示: /api/connections	1分あたり60リクエスト
すべて	その他すべてコネクションエンドポイント	1秒あたり1リクエスト

クイックリファレンス

タイプ	リソース	説明
GET	/api/connections	ユーザーに属するコネクションを一覧表示します。
POST	/api/connections	コネクションを作成します。
PUT	/api/connections/:connection_id	コネクションを更新します。
POST	/api/connections/:connection_id/disconnect	コネクションを切断します。
DELETE	/api/connections/:connection_id	コネクションを削除します。

コネクションのリスト表示

認証済みWorkatoユーザーのすべてのコネクションと関連データを返します。

shell

GET /api/connections

クエリパラメーター

名前	タイプ	説明
folder_id	string 任意	コネクションのフォルダID。
parent_id	string 任意	コネクションの親ID。コネクションは同じプロバイダーである必要があります。
project_id	string 任意	コネクションを含むプロジェクトのID。
external_id	string 任意	通常、コネクションを所有するユーザーに付与される外部識別子。
include_runtime_connections	string 任意	`"true"`を指定すると、すべてのランタイムユーザーコネクションも返されます。
includes[]	array of strings optional	レスポンスに含める追加フィールドを指定します。値として`tags`を受け入れます。リクエストで`tags`を指定すると、レスポンスには各コネクションの`tags`フィールドが含まれます。このフィールドには、0個以上のタグハンドル（文字列）の配列が含まれます。
updated_after	string 任意	指定した日時より後に更新されたコネクションのみを含むよう、コネクションのリストをフィルタリングします。日時は、次のパターンに従ってISO 8601形式で指定する必要があります: `YYYY-MM-DDTHH:MM:SSZ`。

サンプルリクエスト

shell

curl  -X GET https://www.workato.com/api/connections?includes[]=tags
      -H 'Authorization: Bearer <api_token>'

レスポンス

json

[
  {
    "application": "salesforce",
    "id": 36,
    "name": "ACME Production Salesforce connection",
    "description": null,
    "authorized_at": "2015-05-26T22:53:52.528Z",
    "authorization_status": "success",
    "authorization_error": null,
    "created_at": "2015-05-26T22:53:52.532Z",
    "updated_at": "2015-05-26T22:53:52.532Z",
    "external_id": null,
    "folder_id": 4515,
    "connection_lost_at": null,
    "connection_lost_reason": null,
    "parent_id": null,
    "project_id": 12314295,
    "on_prem_group_id": null,
    "tags": [
      "tag-ANgeffPL-3gxQwA"
    ]
  },
  {
    "application": "google_sheets",
    "id": 37,
    "name": "ACME google sheet account",
    "description": null,
    "authorized_at": "2015-05-26T22:53:52.528Z",
    "authorization_status": "success",
    "authorization_error": null,
    "created_at": "2015-05-26T22:53:52.532Z",
    "updated_at": "2015-05-26T22:53:52.532Z",
    "external_id": null,
    "folder_id": 4515,
    "connection_lost_at": null,
    "connection_lost_reason": null,
    "parent_id": null,
    "project_id": 12314295,
    "on_prem_group_id": null,
    "tags": null
  },
  {
    "application": "onprem_files",
    "id": 38,
    "name": "ACME on-prem files connection",
    "description": null,
    "authorized_at": "2015-05-26T22:53:52.528Z",
    "authorization_status": "success",
    "authorization_error": null,
    "created_at": "2015-05-26T22:53:52.532Z",
    "updated_at": "2015-05-26T22:53:52.532Z",
    "external_id": null,
    "folder_id": 4515,
    "connection_lost_at": null,
    "connection_lost_reason": null,
    "parent_id": null,
    "project_id": 12314295,
    "on_prem_group_id": 16803,
    "tags": null
  }
]

コネクションの作成

新しいコネクションを作成します。このエンドポイントは、次のアクションをサポートしています:

シェルコネクションの作成
コネクションの作成と認証

OAuthコネクション

Workato APIでは、OAuth 2.0コネクションを作成できます。ただし、oauthやoauth2_auth_code_grantなど、通常はサインイン画面にリダイレクトされるコネクションタイプには、アクセストークンとリフレッシュトークンを含むoauth_token_pairオブジェクトが必要です。クライアント資格情報グラントコネクションには、oauth_token_pairオブジェクトは必要ありません。アクセストークンとリフレッシュトークンがない場合は、シェルコネクションを作成できます。

詳細については、コネクションパラメーターリファレンスページを参照してください。

shell

POST /api/connections

ペイロード

結果をフィルタリングするには、リクエストボディに次のプロパティを含めます:

名前	タイプ	説明
name	string 任意	コネクションの名前。例: `Prod JIRA connection`
provider	string 任意	コネクションのアプリケーションタイプ。例: `jira`
parent_id	string 任意	親コネクションのID。親コネクションは同じ`provider`タイプである必要があります。詳細。
folder_id	string 必須	コネクションを含むプロジェクトまたはフォルダのID。
external_id	string 任意	コネクションに割り当てられた外部ID。通常はコネクションを所有するユーザーに付与されます。
on_prem_group_id	integer optional	このコネクションに関連付けるオンプレミスグループのID。グループIDは、オンプレミスグループの一覧表示エンドポイントから取得できます。
shell_connection	boolean optional	コネクションがシェルコネクションか認証済みコネクションかを指定します。指定しない場合、デフォルトは`false`です。 `shell_connection`が`false`の場合、資格情報が渡され、コネクションがテストおよび確立されます。 `shell_connection`が`true`の場合、資格情報は渡されますが、コネクションはテストまたは確立されず、認証には追加のアクションが必要です。
input	オブジェクト任意	コネクションパラメータ。プロバイダーとコネクションパラメーターのリストについては、プラットフォームAPIコネクションパラメーターリファレンスを参照してください。

2026年05月07日以降、FOLDER_IDが必須

2026年05月07日以降、このエンドポイントではfolder_idパラメータが必須です。値は、Home assetsフォルダ以外のプロジェクトまたはフォルダを参照する必要があります。 folder_idを省略したリクエスト、またはHome assetsフォルダをターゲットとするリクエストは、エラーを返します。

シェルコネクションリクエスト

これにより、Disconnected状態のコネクションが作成されます。

shell

curl  -X POST https://www.workato.com/api/connections \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d  '{
            "name": "Prod JIRA connection",
            "provider": "jira",
            "folder_id": 1892
          }'

認証情報付きコネクション

これにより、コネクションが作成され認証されます。

shell

curl  -X POST https://www.workato.com/api/connections \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d  '{
            "name": "Prod JIRA connection",
            "provider": "jira",
            "folder_id": 1892,
            "input": {
              "host_name": "acme.atlassian.net",
              "auth_type": "api_token",
              "email": "[email protected]",
              "apitoken": "XXXXXXXX"
            }
          }'

オンプレミスコネクション

これにより、オンプレミスグループに関連付けられたコネクションが作成されます。

shell

curl  -X POST https://www.workato.com/api/connections \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d  '{
            "name": "On-prem SQL Server",
            "provider": "sql",
            "folder_id": 1892,
            "on_prem_group_id": 16803,
            "input": {
              "host": "192.0.2.10",
              "port": "1433",
              "database": "production_db",
              "username": "svc_workato"
            }
          }'

レスポンス

json

{
   "application":"jira",
   "id":36,
   "name":"Prod JIRA connection",
   "description":null,
   "authorized_at":"2023-01-26T22:53:52.528Z",
   "authorization_status":"success",
   "authorization_error":null,
   "created_at":"2023-01-26T22:53:52.532Z",
   "updated_at":"2023-01-26T22:53:52.532Z",
   "external_id":null,
   "folder_id":1892,
   "connection_lost_at":null,
   "connection_lost_reason":null,
   "parent_id":null,
   "project_id":12314295,
   "on_prem_group_id":null
}

コネクションを更新

非埋め込みワークスペース内のコネクションを更新します。

shell

PUT /api/connections/:connection_id

URLパラメーター

名前	タイプ	説明
connection_id	string 必須	コネクションのID。

ペイロード

名前	タイプ	説明
name	string 任意	コネクションの名前。例: `Prod Salesforce connection`
parent_id	string 任意	親コネクションのID。詳細。
folder_id	string 任意	コネクションを含むプロジェクトまたはフォルダのID。
external_id	string 任意	コネクションに割り当てられた外部ID。この値は、他のアプリケーションのいずれかのレコードを参照できます。
on_prem_group_id	integer optional	このコネクションに関連付けるオンプレミスグループのID。 `null`に設定すると、オンプレミスグループの関連付けが削除されます。グループIDは、オンプレミスグループの一覧表示エンドポイントから取得できます。
shell_connection	boolean optional	コネクションがシェルコネクションか認証済みコネクションかを指定します。指定しない場合、デフォルトは`false`です。 `shell_connection`が`false`の場合、資格情報が渡され、コネクションがテストおよび確立されます。 `shell_connection`が`true`の場合、資格情報は渡されますが、コネクションはテストまたは確立されず、認証には追加のアクションが必要です。
input	object optional	コネクションパラメータ。プロバイダーとコネクションパラメーターのリストについては、プラットフォームAPIコネクションパラメーターリファレンスを参照してください。

サンプルリクエスト

Jiraコネクションを更新
Outreachコネクションを更新

Jiraコネクションを更新

shell

curl  -X PUT https://www.workato.com/api/connections/1678 \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d  '{
            "name": "jira_connection_latest",
            "folder_id": 28940,
            "input": {
              "host_name": "acme.atlassian.net",
              "api_token_auth": "true",
              "email": "[email protected]",
              "apitoken": "XXXXXXXX"
            }
          }'

レスポンス

json

{
   "application":"jira",
   "id":36,
   "name":"jira_connection",
   "description":null,
   "authorized_at":"2015-05-26T22:53:52.528Z",
   "authorization_status":"success",
   "authorization_error":null,
   "created_at":"2015-05-26T22:53:52.532Z",
   "updated_at":"2015-05-26T22:53:52.532Z",
   "external_id":"U12904",
   "folder_id":4515,
   "connection_lost_at":null,
   "connection_lost_reason":null,
   "parent_id":22318,
   "project_id":12314295,
   "on_prem_group_id":null
}

Outreachコネクションを更新

shell

curl  -X PUT https://www.workato.com/api/connections/1678 \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d  '{
            "name": "Outreach scope connection",
            "provider": "outreach",
            "input": {
              "advanced_settings": {
                "scopes": "sequences.all phoneNumbers.all"
              }
            }
          }'

コネクションを切断

非埋め込みワークスペース内のアクティブなコネクションを切断します。コネクションがすでに切断されている場合、アクションは実行されません。

shell

POST /api/connections/:connection_id/disconnect

URLパラメータ

名前	タイプ	説明
connection_id	string 必須	コネクションのID。
force	boolean optional	アクティブなレシピで使用されているアクティブなコネクションを強制的に切断するには、値を`true`にする必要があります。デフォルトは`false`です。

ペイロード

ペイロードは想定されていません。

サンプルリクエスト

shell

curl -X POST https://www.workato.com/api/connections/1678/disconnect \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{ "force": true }'

レスポンス

アクティブなコネクション、またはすでに切断されているコネクションが正常に切断されました。

json

{
    "success": true,
    "status": "disconnected"

}

指定されたコネクションIDは存在しません

json

{
   "message": "Not found"
}

コネクションを削除

非埋め込みワークスペース内のコネクションを削除します。このメソッドは、アクティブ（認証済み）および切断済みのコネクションを削除します。コネクションがアクティブなレシピまたは監査ログストリーミングの宛先として使用されている場合、このAPIリクエストは失敗します。

shell

DELETE /api/connections/:connection_id

URLパラメータ

名前	タイプ	説明
connection_id	string 必須	コネクションのID。

サンプルリクエスト

shell

curl  -X DELETE https://www.workato.com/api/connections/1678 \
      -H 'Authorization: Bearer <api_token>'

レスポンス

アクティブまたは切断済みコネクションの正常な削除
コネクションがアクティブなレシピで使用されています
コネクションが監査ログストリーミングに使用されています
コネクションIDが存在しません

アクティブまたは切断済みコネクションの正常な削除

アクティブ（認証済み）または切断済みのコネクションを正常に削除すると、このエンドポイントは次のレスポンスを返します:

json

{
    "success": true,
    "status": "deleted"
}

コネクションがアクティブなレシピで使用されています

アクティブなレシピで使用されているコネクションを削除しようとすると、このリクエストは失敗し、エンドポイントは次のレスポンスを返します:

json

{
   "success": false,
   "status": "rejected",
   "message": "You can't delete a connection used by active recipes"
}

コネクションが監査ログストリーミングに使用されています

監査ログストリーミングの宛先として使用されているコネクションを削除しようとすると、このリクエストは失敗し、エンドポイントは次のレスポンスを返します:

json

{
    "success": false,
    "status": "rejected",
    "message": "You can't delete a connection used by audit log streaming"
}

コネクションIDが存在しません

ワークスペースに存在しないコネクションIDを指定すると、このリクエストは失敗し、エンドポイントは次のレスポンスを返します:

json

{
   "message": "Not found"
}

Last updated:

コネクション ​

レート制限 ​

クイックリファレンス ​

コネクションのリスト表示 ​

クエリパラメーター ​

サンプルリクエスト ​

レスポンス ​

コネクションの作成 ​

ペイロード ​

サンプルリクエスト ​

シェルコネクションリクエスト ​

認証情報付きコネクション ​

オンプレミスコネクション ​

レスポンス ​

コネクションを更新 ​

URLパラメーター ​

ペイロード ​

サンプルリクエスト ​

Jiraコネクションを更新 ​

レスポンス ​

Outreachコネクションを更新 ​

コネクションを切断 ​

URLパラメータ ​

ペイロード ​

サンプルリクエスト ​

レスポンス ​

コネクションを削除 ​

URLパラメータ ​

サンプルリクエスト ​

レスポンス ​

アクティブまたは切断済みコネクションの正常な削除 ​

コネクションがアクティブなレシピで使用されています ​

コネクションが監査ログストリーミングに使用されています ​

コネクションIDが存在しません ​

コネクション

レート制限

クイックリファレンス

コネクションのリスト表示

クエリパラメーター

サンプルリクエスト

レスポンス

コネクションの作成

ペイロード

サンプルリクエスト

シェルコネクションリクエスト

認証情報付きコネクション

オンプレミスコネクション

レスポンス

コネクションを更新

URLパラメーター

ペイロード

サンプルリクエスト

Jiraコネクションを更新

レスポンス

Outreachコネクションを更新

コネクションを切断

URLパラメータ

ペイロード

サンプルリクエスト

レスポンス

コネクションを削除

URLパラメータ

サンプルリクエスト

レスポンス

アクティブまたは切断済みコネクションの正常な削除

コネクションがアクティブなレシピで使用されています

コネクションが監査ログストリーミングに使用されています

コネクションIDが存在しません