---
title: "TROCCO APIリファレンス"
slug: "overview"
updated: 2026-11-02T00:16:22Z
published: 2026-11-02T00:16:22Z
canonical: "documents.trocco.io/overview"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://documents.trocco.io/llms.txt
> Use this file to discover all available pages before exploring further.

# TROCCO APIリファレンス

## 概要

TROCCOは、TROCCO APIを提供しています。 TROCCO APIを利用することで、各種ジョブの実行、各種設定の作成・編集・削除、設定情報の確認を行うことができます。

利用できるプラン

TROCCO APIは、**30日トライアル**プランまたは**Advanced**プラン以上の契約アカウントでのみ、ご利用いただけます。 フリープランおよびStarterプラン・Essentialプランではご利用いただけません。

Terraform Provider for TROCCO

TROCCO APIは、**Terraform Provider for TROCCO**経由でも利用可能です。 Terraform Provider for TROCCOを利用することで、TROCCOの各種リソースをコードで管理できます。 接続情報・転送設定・データマート定義・ワークフロー定義といったジョブに関する設定や、[チームやリソースグループ](/docs/about-team)といった権限に関する設定をコードで管理することで、バージョン管理なども容易となります。

詳しくは、[Terraform Registry Document - trocco Provider](https://registry.terraform.io/providers/trocco-io/trocco/latest/docs)を参照ください。

AIエージェント向けskill集（trocco-agent-skills）

TROCCO APIは、AIエージェント向けのskill集である**trocco-agent-skills**経由でも利用可能です。 Claude CodeやCodexといったAIエージェントにskillをインストールしておけば、TROCCOの運用作業をAIエージェントに頼むだけで実現できます。 たとえば、通知が設定されていない定義への通知の付与、洗い替えの転送設定から差分転送への切り替え、説明が設定されていない定義への説明の付与、失敗したジョブのログ調査などを任せられます。

skillの一覧やインストール方法は、[GitHub - trocco-io/trocco-agent-skills](https://github.com/trocco-io/trocco-agent-skills)を参照ください。

※ 参考実装としてのサンプルです。ご利用にはTROCCO APIが利用可能なプランのご契約が必要です。

外部AIサービスの学習設定

TROCCO APIを外部のAIサービスなどと組み合わせて利用する場合は、外部AIサービスにて入力内容が学習されない設定やプランであることをご確認ください。

## レートリミット

TROCCO APIは以下のレートリミットを設けています。

- 30日トライアルプラン：最大**100コール**/10分
- Advancedプラン以上：最大**3,500**コール/10分

レートリミットを超えたリクエストがあった際には `429( too many requests)` がステータスコードとして返却されます。 レートリミットを考慮しながらAPIクライアントを実装する際には[APIコール数制限に関するレスポンスヘッダー](/apidocs/overview#api%E3%82%B3%E3%83%BC%E3%83%AB%E6%95%B0%E5%88%B6%E9%99%90%E3%81%AB%E9%96%A2%E3%81%99%E3%82%8B%E3%83%AC%E3%82%B9%E3%83%9D%E3%83%B3%E3%82%B9%E3%83%98%E3%83%83%E3%83%80%E3%83%BC)も参照ください。

### レートリミットに関するレスポンスヘッダー

TROCCOのAPIからリクエストを送った際、以下のレスポンスヘッダーが返却されます。 こちらの内容を参考にレートリミットを避けてAPIコールを実行ください。

| ヘッダー | 説明 | サンプル値 |
| --- | --- | --- |
| `X-Rate-Limit-Limit` | 毎時間枠（10分間）内でAPIコールできる回数の上限 | - 30日トライアルプラン：100（固定値） - Advancedプラン以上：3,500（固定値） |
| `X-Rate-Limit-Remaining` | 現在の時間枠においてAPIコールできる残り回数 | 3,450 |
| `X-Rate-Limit-Reset` | レートリミットの時間枠がリセットされる時間（UNIX時間、UTC+9換算） | 1739372400 |

## TROCCO API KEYの作成

TROCCO APIを利用するには、事前にTROCCO上でTROCCO API KEYを作成する必要があります。 TROCCO API KEYは、作成したユーザーと同じ権限で動作します。

1. サイドメニューの**外部連携**>**TROCCO API KEY**をクリックします。TROCCO API KEY一覧画面が表示されます。 ![image.png](https://cdn.document360.io/3a3bae1e-f157-487f-8798-01e9d820e760/Images/Documentation/trocco-api-key-link.png)
2. **新規作成**>**保存**をクリックします。TROCCO API KEYが作成されます。 この際、画面上に表示される値をメモしてください。API実行時に利用します。

TROCCO API KEYの管理主体

TROCCO API KEYはアカウントではなく、ユーザーごとに管理されます。 したがって、自身が作成したTROCCO API KEYは、基本的に(*)他ユーザーには閲覧されることはありません。 なお、ユーザーが削除された場合は、そのユーザーが作成したTROCCO API KEYも削除されます。

* 例外的に、[アカウント特権管理者](/docs/about-super-admin#%E3%82%A2%E3%82%AB%E3%82%A6%E3%83%B3%E3%83%88%E5%86%85%E3%81%AB%E4%BD%9C%E6%88%90%E3%81%95%E3%82%8C%E3%81%9F%E3%81%99%E3%81%B9%E3%81%A6%E3%81%AEapi-key%E3%81%AE%E9%96%B2%E8%A6%A7%E3%82%84%E6%93%8D%E4%BD%9C)のみ、アカウント内に作成されたすべてのTROCCO API KEYを閲覧・編集・削除できます。

TROCCO API KEYのプレフィックス

2025/6/18以降に発行されたTROCCO API KEYにはセキュリティ強化のためプレフィックス（tra_）が付与されます。 プレフィックスが付与されていないTROCCO API KEYも引き続き問題なくご利用いただけます。

## 利用できるAPI

### ベースURL

`https://trocco.io `

### エンドポイント一覧

| 機能 | 処理内容 | メソッド | エンドポイント |
| --- | --- | --- | --- |
| カスタムコネクタ | [カスタムコネクタ一覧取得](/apidocs/get-custom-connectors) | `GET` | `/api/custom_connectors` |
| カスタムコネクタ | [転送元カスタムコネクタ作成](/apidocs/post-custom-connector-input) | `POST` | `/api/custom_connector_inputs` |
| カスタムコネクタ | [転送元カスタムコネクタ詳細取得](/apidocs/get-custom-connector-input) | `GET` | `/api/custom_connector_inputs/{custom_connector_id}` |
| カスタムコネクタ | [転送元カスタムコネクタ更新](/apidocs/patch-custom-connector-input) | `PATCH` | `/api/custom_connector_inputs/{custom_connector_id}` |
| カスタムコネクタ | [転送元カスタムコネクタ削除](/apidocs/delete-custom-connector-input) | `DELETE` | `/api/custom_connector_inputs/{custom_connector_id}` |
| カスタムコネクタ | [転送先カスタムコネクタ作成](/apidocs/post-custom-connector-output) | `POST` | `/api/custom_connector_outputs` |
| カスタムコネクタ | [転送先カスタムコネクタ詳細取得](/apidocs/get-custom-connector-output) | `GET` | `/api/custom_connector_outputs/{custom_connector_id}` |
| カスタムコネクタ | [転送先カスタムコネクタ更新](/apidocs/patch-custom-connector-output) | `PATCH` | `/api/custom_connector_outputs/{custom_connector_id}` |
| カスタムコネクタ | [転送先カスタムコネクタ削除](/apidocs/delete-custom-connector-output) | `DELETE` | `/api/custom_connector_outputs/{custom_connector_id}` |
| 転送ジョブ | [転送ジョブ実行](/apidocs/post-job) | `POST` | `/api/jobs` |
| 転送ジョブ | [転送ジョブ実行結果取得](/apidocs/get-job) | `GET` | `/api/jobs/{job_id}` |
| 転送ジョブ | [転送ジョブ一覧取得](/apidocs/get-jobs) | `GET` | `/api/job_definitions/{job_definition_id}/jobs` |
| 転送ジョブ | [転送ジョブ実行ログ取得](/apidocs/get-job-logs) | `GET` | `/api/jobs/{job_id}/logs` |
| 転送設定 | [転送設定一覧取得](/apidocs/get-job-definitions) | `GET` | `/api/job_definitions` |
| 転送設定 | [転送設定作成](/apidocs/post-job-definition) | `POST` | `/api/job_definitions` |
| 転送設定 | [転送設定詳細取得](/apidocs/get-job-definition) | `GET` | `/api/job_definitions/{job_definition_id}` |
| 転送設定 | [転送設定更新](/apidocs/patch-job-definition) | `PATCH` | `/api/job_definitions/{job_definition_id}` |
| 転送設定 | [転送設定削除](/apidocs/delete-job-definition) | `DELETE` | `/api/job_definitions/{job_definition_id}` |
| データマートジョブ | [データマートジョブ実行](/apidocs/post-datamart-job) | `POST` | `/api/datamart_jobs` |
| データマートジョブ | [データマートジョブ実行結果取得](/apidocs/get-datamart-job) | `GET` | `/api/datamart_jobs/{datamart_job_id}` |
| データマートジョブ | [データマートジョブ実行ログ取得](/apidocs/get-datamart-job-logs) | `GET` | `/api/datamart_jobs/{datamart_job_id}/logs` |
| データマート定義 | [データマート定義一覧取得](/apidocs/get-datamart-definitions) | `GET` | `/api/datamart_definitions` |
| データマート定義 | [データマート定義作成](/apidocs/post-datamart-definition) | `POST` | `/api/datamart_definitions` |
| データマート定義 | [データマート定義詳細取得](/apidocs/get-datamart-definition) | `GET` | `/api/datamart_definitions/{datamart_definition_id}` |
| データマート定義 | [データマート定義更新](/apidocs/patch-datamart-definition) | `PATCH` | `/api/datamart_definitions/{datamart_definition_id}` |
| データマート定義 | [データマート定義削除](/apidocs/delete-datamart-definition) | `DELETE` | `/api/datamart_definitions/{datamart_definition_id}` |
| ワークフロージョブ | [ワークフロージョブ実行](/apidocs/post-pipeline-job) | `POST` | `/api/pipeline_jobs` |
| ワークフロージョブ | [ワークフロージョブ実行結果取得](/apidocs/get-pipeline-job) | `GET` | `/api/pipeline_jobs/{pipeline_job_id}` |
| ワークフロー定義 | [ワークフロー一覧取得](/apidocs/get-pipeline-definitions) | `GET` | `/api/pipeline_definitions` |
| ワークフロー定義 | [ワークフロー作成](/apidocs/post-pipeline-definition) | `POST` | `/api/pipeline_definitions` |
| ワークフロー定義 | [ワークフロー詳細取得](/apidocs/get-pipeline-definition) | `GET` | `/api/pipeline_definitions/{pipeline_definition_id}` |
| ワークフロー定義 | [ワークフロー更新](/apidocs/patch-pipeline-definition) | `PATCH` | `/api/pipeline_definitions/{pipeline_definition_id}` |
| ワークフロー定義 | [ワークフロー削除](/apidocs/delete-pipeline-definition) | `DELETE` | `/api/pipeline_definitions/{pipeline_definition_id}` |
| 接続情報 | [接続情報一覧取得](/apidocs/get-connection-configurations) | `GET` | `/api/connections/{connection_type}` |
| 接続情報 | [接続情報作成](/apidocs/post-connection-configuration) | `POST` | `/api/connections/{connection_type}` |
| 接続情報 | [接続情報詳細取得](/apidocs/get-connection-configuration) | `GET` | `/api/connections/{connection_type}/{connection_id}` |
| 接続情報 | [接続情報更新](/apidocs/patch-connection-configuration) | `PATCH` | `/api/connections/{connection_type}/{connection_id}` |
| 接続情報 | [接続情報削除](/apidocs/delete-connection-configuration) | `DELETE` | `/api/connections/{connection_type}/{connection_id}` |
| 通知先 | [通知先一覧取得](/apidocs/get-notifications) | `GET` | `/api/notification_destinations/{type}` |
| 通知先 | [通知先作成](/apidocs/post-notification) | `POST` | `/api/notification_destinations/{type}` |
| 通知先 | [通知先の取得](/apidocs/get-notification) | `GET` | `/api/notification_destinations/{type}/{notification_destination_id}` |
| 通知先 | [通知先の更新](/apidocs/patch-notification) | `PATCH` | `/api/notification_destinations/{type}/{notification_destination_id}` |
| 通知先 | [通知先の削除](/apidocs/delete-notification) | `DELETE` | `/api/notification_destinations/{type}/{notification_destination_id}` |
| ラベル | [ラベル一覧取得](/apidocs/get-labels) | `GET` | `/api/labels` |
| ラベル | [ラベル作成](/apidocs/post-label) | `POST` | `/api/labels` |
| ラベル | [ラベル詳細取得](/apidocs/get-label) | `GET` | `/api/labels/{label_id}` |
| ラベル | [ラベル更新](/apidocs/patch-label) | `PATCH` | `/api/labels/{label_id}` |
| ラベル | [ラベル削除](/apidocs/delete-label) | `DELETE` | `/api/labels/{label_id}` |
| ユーザー | [ユーザー一覧取得](/apidocs/get-users) | `GET` | `/api/users` |
| ユーザー | [ユーザー作成](/apidocs/post-user) | `POST` | `/api/users` |
| ユーザー | [ユーザー詳細取得](/apidocs/get-user) | `GET` | `/api/users/{user_id}` |
| ユーザー | [ユーザー更新](/apidocs/patch-user) | `PATCH` | `/api/users/{user_id}` |
| ユーザー | [ユーザー削除](/apidocs/delete-user) | `DELETE` | `/api/users/{user_id}` |
| dbt Gitリポジトリ連携 | [dbt Gitリポジトリ一覧取得](/apidocs/get-dbt-git-repositories) | `GET` | `/api/dbt_git_repositories` |
| dbt Gitリポジトリ連携 | [dbt Gitリポジトリ作成](/apidocs/post-dbt-git-repository) | `POST` | `/api/dbt_git_repositories` |
| dbt Gitリポジトリ連携 | [dbt Gitリポジトリ詳細取得](/apidocs/get-dbt-git-repository) | `GET` | `/api/dbt_git_repositories/{dbt_git_repository_id}` |
| dbt Gitリポジトリ連携 | [dbt Gitリポジトリ更新](/apidocs/patch-dbt-git-repository) | `PATCH` | `/api/dbt_git_repositories/{dbt_git_repository_id}` |
| dbt Gitリポジトリ連携 | [dbt Gitリポジトリ削除](/apidocs/delete-dbt-git-repository) | `DELETE` | `/api/dbt_git_repositories/{dbt_git_repository_id}` |
| dbtジョブ設定 | [dbtジョブ設定一覧取得](/apidocs/get-dbt-job-definitions) | `GET` | `/api/dbt_job_definitions` |
| dbtジョブ設定 | [dbtジョブ設定作成](/apidocs/post-dbt-job-definition) | `POST` | `/api/dbt_job_definitions` |
| dbtジョブ設定 | [dbtジョブ設定詳細取得](/apidocs/get-dbt-job-definition) | `GET` | `/api/dbt_job_definitions/{dbt_job_definition_id}` |
| dbtジョブ設定 | [dbtジョブ設定更新](/apidocs/patch-dbt-job-definition) | `PATCH` | `/api/dbt_job_definitions/{dbt_job_definition_id}` |
| dbtジョブ設定 | [dbtジョブ設定削除](/apidocs/delete-dbt-job-definition) | `DELETE` | `/api/dbt_job_definitions/{dbt_job_definition_id}` |
| dbtジョブ | [dbtジョブ実行結果取得](/apidocs/get-dbt-job) | `GET` | `/api/dbt_jobs/{dbt_job_id}` |
| dbtジョブ | [dbtジョブ実行ログ取得](/apidocs/get-dbt-job-logs) | `GET` | `/api/dbt_jobs/{dbt_job_id}/logs` |
| チーム | [チーム一覧取得](/apidocs/get-teams) | `GET` | `/api/teams` |
| チーム | [チーム作成](/apidocs/post-team) | `POST` | `/api/teams` |
| チーム | [チーム詳細取得](/apidocs/get-team) | `GET` | `/api/teams/{team_id}` |
| チーム | [チーム更新](/apidocs/patch-team) | `PATCH` | `/api/teams/{team_id}` |
| チーム | [チーム削除](/apidocs/delete-team) | `DELETE` | `/api/teams/{team_id}` |
| リソースグループ | [リソースグループ一覧取得](/apidocs/get-resource-groups) | `GET` | `/api/resource_groups` |
| リソースグループ | [リソースグループ作成](/apidocs/post-resource-group) | `POST` | `/api/resource_groups` |
| リソースグループ | [リソースグループ詳細取得](/apidocs/get-resource-group) | `GET` | `/api/resource_groups/{resource_group_id}` |
| リソースグループ | [リソースグループ更新](/apidocs/patch-resource-group) | `PATCH` | `/api/resource_groups/{resource_group_id}` |
| リソースグループ | [リソースグループ削除](/apidocs/delete-resource-group) | `DELETE` | `/api/resource_groups/{resource_group_id}` |
| 環境グループ | [環境グループ一覧取得](/apidocs/get-environment-groups) | `GET` | `/api/environment_groups` |
| 環境グループ | [環境グループ作成](/apidocs/post-environment-group) | `POST` | `/api/environment_groups` |
| 環境グループ | [環境グループ詳細取得](/apidocs/get-environment-group) | `GET` | `/api/environment_groups/{environment_group_id}` |
| 環境グループ | [環境グループ更新](/apidocs/patch-environment-group) | `PATCH` | `/api/environment_groups/{environment_group_id}` |
| 環境グループ | [環境グループ削除](/apidocs/delete-environment-group) | `DELETE` | `/api/environment_groups/{environment_group_id}` |
| 環境 | [環境一覧取得](/apidocs/get-environments) | `GET` | `/api/environments` |
| 環境 | [環境作成](/apidocs/post-environment) | `POST` | `/api/environments` |
| 環境 | [環境詳細取得](/apidocs/get-environment) | `GET` | `/api/environments/{environment_id}` |
| 環境 | [環境更新](/apidocs/patch-environment) | `PATCH` | `/api/environments/{environment_id}` |
| 環境 | [環境削除](/apidocs/delete-environment) | `DELETE` | `/api/environments/{environment_id}` |

## API実行時に指定する各種パラメーターの確認方法

### 各種設定・ジョブのID

TROCCO APIの実行対象となるTROCCOの各種設定やジョブのID（例：`job_definition_id`や`job_id`）は、それぞれの詳細画面のURL末尾より確認できます。 以下は転送設定ID（`job_definition_id`）および転送ジョブID（`job_id`）の確認方法の例です。

#### 転送設定ID（`job_definition_id`）

![image.png](https://cdn.document360.io/3a3bae1e-f157-487f-8798-01e9d820e760/Images/Documentation/job-definition-id.png)

#### 転送ジョブID（`job_id`）

![image.png](https://cdn.document360.io/3a3bae1e-f157-487f-8798-01e9d820e760/Images/Documentation/job-id.png)

### タイムゾーン（`time_zone`）

`time_zone`で指定可能な値は、下記「指定できるタイムゾーン一覧」を参照ください。 たとえば、太平洋標準時で2023年8月1日12時を`context_time`として展開したい場合は、`time_zone`に`America/Los_Angeles`、`context_time`に`2023-08-01 12:00:00`を指定ください。 なお、サマータイムを採用しているタイムゾーンでは夏季に標準時間とずれが発生します。ご注意ください。

**指定できるタイムゾーン一覧**

- `Etc/GMT+12`
- `Pacific/Pago_Pago`
- `Pacific/Midway`
- `Pacific/Honolulu`
- `America/Juneau`
- `America/Los_Angeles`
- `America/Tijuana`
- `America/Phoenix`
- `America/Mazatlan`
- `America/Denver`
- `America/Guatemala`
- `America/Chicago`
- `America/Chihuahua`
- `America/Mexico_City`
- `America/Monterrey`
- `America/Regina`
- `America/Bogota`
- `America/New_York`
- `America/Indiana/Indianapolis`
- `America/Lima`
- `America/Halifax`
- `America/Caracas`
- `America/Guyana`
- `America/La_Paz`
- `America/Puerto_Rico`
- `America/Santiago`
- `America/St_Johns`
- `America/Sao_Paulo`
- `America/Argentina/Buenos_Aires`
- `America/Godthab`
- `America/Montevideo`
- `Atlantic/South_Georgia`
- `Atlantic/Azores`
- `Atlantic/Cape_Verde`
- `Europe/London`
- `Europe/Lisbon`
- `Africa/Monrovia`
- `Etc/UTC`
- `Europe/Amsterdam`
- `Europe/Belgrade`
- `Europe/Berlin`
- `Europe/Zurich`
- `Europe/Bratislava`
- `Europe/Brussels`
- `Europe/Budapest`
- `Africa/Casablanca`
- `Europe/Copenhagen`
- `Europe/Dublin`
- `Europe/Ljubljana`
- `Europe/Madrid`
- `Europe/Paris`
- `Europe/Prague`
- `Europe/Rome`
- `Europe/Sarajevo`
- `Europe/Skopje`
- `Europe/Stockholm`
- `Europe/Vienna`
- `Europe/Warsaw`
- `Africa/Algiers`
- `Europe/Zagreb`
- `Europe/Athens`
- `Europe/Bucharest`
- `Africa/Cairo`
- `Africa/Harare`
- `Europe/Helsinki`
- `Asia/Jerusalem`
- `Europe/Kaliningrad`
- `Europe/Kiev`
- `Africa/Johannesburg`
- `Europe/Riga`
- `Europe/Sofia`
- `Europe/Tallinn`
- `Europe/Vilnius`
- `Asia/Baghdad`
- `Europe/Istanbul`
- `Asia/Kuwait`
- `Europe/Minsk`
- `Europe/Moscow`
- `Africa/Nairobi`
- `Asia/Riyadh`
- `Europe/Volgograd`
- `Asia/Tehran`
- `Asia/Muscat`
- `Asia/Baku`
- `Europe/Samara`
- `Asia/Tbilisi`
- `Asia/Yerevan`
- `Asia/Kabul`
- `Asia/Yekaterinburg`
- `Asia/Karachi`
- `Asia/Tashkent`
- `Asia/Kolkata`
- `Asia/Colombo`
- `Asia/Kathmandu`
- `Asia/Almaty`
- `Asia/Dhaka`
- `Asia/Urumqi`
- `Asia/Rangoon`
- `Asia/Bangkok`
- `Asia/Jakarta`
- `Asia/Krasnoyarsk`
- `Asia/Novosibirsk`
- `Asia/Shanghai`
- `Asia/Chongqing`
- `Asia/Hong_Kong`
- `Asia/Irkutsk`
- `Asia/Kuala_Lumpur`
- `Australia/Perth`
- `Asia/Singapore`
- `Asia/Taipei`
- `Asia/Ulaanbaatar`
- `Asia/Tokyo`※デフォルト値
- `Asia/Seoul`
- `Asia/Yakutsk`
- `Australia/Adelaide`
- `Australia/Darwin`
- `Australia/Brisbane`
- `Australia/Melbourne`
- `Pacific/Guam`
- `Australia/Hobart`
- `Pacific/Port_Moresby`
- `Australia/Sydney`
- `Asia/Vladivostok`
- `Asia/Magadan`
- `Pacific/Noumea`
- `Pacific/Guadalcanal`
- `Asia/Srednekolymsk`
- `Pacific/Auckland`
- `Pacific/Fiji`
- `Asia/Kamchatka`
- `Pacific/Majuro`
- `Pacific/Chatham`
- `Pacific/Tongatapu`
- `Pacific/Apia`
- `Pacific/Fakaofo`

### カスタム変数を複数指定する方法

カスタム変数は、array型のパラメーター（`custom_variables`）に、変数名（`name`）と値（`value`）を指定します。 特定の変数名に対する値は、変数名の直後に指定する必要があります。 したがって、カスタム変数を複数指定する場合は、対となる変数名と値を続けて指定し、それを繰り返します。

下記のサンプルは、カスタム変数名`name1`の値に`value1`を、カスタム変数名`name2`の値に`value2`を指定しています。

```
curl 'https://trocco.io/api/jobs?job_definition_id={JOB_DEFINITION_ID}' \
-X POST \
-H 'Authorization:Token {API KEY}' \
-d 'custom_variables[][name]=$name1$' \ 
-d 'custom_variables[][value]=value1' \
-d 'custom_variables[][name]=$name2$' \
-d 'custom_variables[][value]=value2'
```