RESTAPI クイックスタート

REST API を使用すると、URL パスを介して TeamCity リソース（エンティティ）にアクセスできます。 REST API を使用するために、外部アプリケーションは TeamCity サーバーに HTTP リクエストを行い、応答を解析します。

メインの API エンドポイントを表示するには、ブラウザーで /app/rest/server を開きます。

認証

サーバーへの要求を正常に実行するには、認証用の資格情報を提供する必要があります。これを行う最良の方法は、アクセストークンを使用することです。TeamCity の設定とツール | アクセストークンでユーザーのトークンを生成できます。このトークンを HTTP ヘッダー Authorization: Bearer <token_value> で渡します。例:

curl --header "Authorization: Bearer <token-value>" /app/rest/builds

提供されたトークンに基づいて、TeamCity は、リクエストの範囲がこのトークンを所有するユーザーに許可されている場合にのみペイロードを返します。

拡張 quide でサポートされている他の認証方法について参照してください。

サポートされている HTTP メソッド

GET : 要求されたデータを取得します。例: .../app/rest/entities は通常、エンティティのリストを取得しますが、.../app/rest/entities/<entity_locator> は単一のエンティティを取得します。
POST : 送信されたペイロードからエンティティを作成します。新しいエンティティを作成するには、定期的に単一のエンティティデータ（GET を介して取得されたもの）を .../app/rest/entities URL に投稿する必要があります。XML を投稿するときは、必ず Content-Type: application/xml HTTP ヘッダーを指定してください。
PUT : 送信されたペイロードからデータを更新します。同じ URL への GET リクエストを介して取得されたものと同じデータ形式を受け入れます。.../app/rest/entities/<entity_locator> などの URL の一部のエンティティでサポートされています。
DELETE : たとえば、.../app/rest/entities/<entity_locator> の URL のデータを削除します。

最初のリクエストを送信する

ブラウザーのアドレスバーを介して、RESTAPI を介してデータをリクエストしてみてください。サーバーに登録されているすべてのユーザーに関するデータをリクエストしましょう。

/app/rest/server を開き、users エンドポイントへのパスを見つけます。
結果の URL をアドレスバーに入力します: /app/rest/users これにより、ID と総数を含む user オブジェクトのリストが開きます。

curl を介して同じ情報にアクセスするには、次を使用します。

curl --header "Authorization: Bearer <token_value>" /app/rest/users

ユーザーを作成する場合は、POST メソッドを使用します。

curl -H "Authorization: Bearer <token_value>" -H "Content-Type: application/xml" -v /app/rest/users  --data-binary "<user username='john.smith' name='John Smith' email='john.smith@teamcity.com' password='secvalue'></user>"

より複雑な例については、一般的な使用例セクションを確認してください。

モデルについて

モデルは TeamCity エンティティの青写真です。プロジェクトからエージェント要件まで、各オブジェクトのデータスキーマを指定します。

自動生成された RESTAPI リファレンス | モデルのドキュメントのセクションには、関連する主要なオブジェクトごとにグループ化されたすべてのオブジェクトモデルがリストされています。このドキュメントでは、次のことができます。

作成するオブジェクトのすべてのフィールドを表示します。
必要なエンティティの適切なオブジェクト名を確認してください。
正しい値の型を使用していることを確認してください。

ロケーターについて

ロケーターは、要求されたオブジェクトのスコープにフィルターを適用します。この概念の詳細な説明については、RESTAPI ロケーターの記事を参照してください。

自動生成された RESTAPI リファレンス | ロケーターセクションには、TeamCity RESTAPI で使用可能なロケーターの自動生成されたドキュメントが含まれています。このセクションの各ドキュメントには、ロケーターの使用可能なすべてのディメンションとそのタイプおよび形式がリストされており、ロケーターの使用例が示されています。

メソッドについて

メソッドは、特定のオブジェクトで使用できる操作です。すべてのメソッドの説明は、自動生成された RESTAPI リファレンス | メソッドのドキュメントセクションにあります。各メソッドについて、このドキュメントは以下を提供します。

簡単な説明
適用する必要のあるエンドポイント
それぞれの HTTP メソッド
サポートされているパラメーターとその型
該当する場合、応答エンティティのモデル

これにより、次のことが可能になります。

必要な操作の正確な名前を見つけます。
応答で期待されるエンティティを受け取ることを確認してください。
メソッドに必要なパラメーターを確認してください。

最終更新日: 2022 年 6 月 01 日

TeamCity RESTAPI リファレンス 2026.1 ヘルプ