TROCCO APIリファレンス

概要

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

制約

TROCCO API エンドポイント一覧

TROCCO API KEYの作成

TROCCO APIを利用するには、事前にTROCCO上でTROCCO API KEYを作成する必要があります。

1. サイドメニューの外部連携>TROCCO API KEYをクリックします。TROCCO API KEY一覧画面が表示されます。
   

2. 新規作成>保存をクリックします。TROCCO API KEYが作成されます。
   この際、画面上に表示される値をメモしてください。API実行時に利用します。

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

各種設定・ジョブのID

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

転送設定ID（job_definition_id）

転送ジョブID（job_id）

タイムゾーン（time_zone）

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

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

カスタム変数は、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'

APIコール制限について

APIコール数制限に関するレスポンスヘッダー

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