CircleCI ランナー API

CircleCI ランナーは、https://circleci.com/ja/pricing[Scale プラン]をご利用のお客様と、CircleCI Server v3.1.0 以上をご利用のお客様に提供されています。 Scale プランへのお申し込み方法については、営業担当者へお問い合わせください。

CircleCI ランナー API の外部向けエンドポイント一覧を紹介します。

認証方法

CircleCI ランナー API は、さまざまな認証方法に対応しています。 使用できる認証方法は、エンドポイントや用途によって異なります。 1 つのエンドポイントで複数の認証方法を使用できる場合もあります。

circle-token (個人認証)

この認証方法はパーソナル トークンをベースにしており、CircleCI v2 API と同じルールが適用されます。

名前 説明

circle-token ヘッダー

ユーザー認証に使用される circle-token が含まれたヘッダー

ユーザー名による HTTP Basic 認証

トークンは、Basic 認証のスキームを使用して提供できます。ユーザー名には circle-token を設定し、パスワードは空白のまま残します。

ブラウザー セッション認証

リクエストに含まれる Cookie を使用して開始する Ring セッションです。 この認証方法では、ユーザーが既に circleci.com にログインしている場合に、特定のエンドポイントにシームレスにアクセスできます。

ローンチ トークン

このトークンは、launch-agent のセットアップに使用するものと同じです。

サポートされている方法

名前 説明

HTTP Bearer 認証

Bearer スキームを使用してトークンを送信します。

エンドポイント

GET /api/v2/runner

指定したパラメーターに基づいて利用可能なランナーの一覧を取得できます。 フィルター用パラメーターを 1つ以上使用することが必須です。

認証方法

  • circle-token (個人認証)

  • ブラウザー セッション認証 + この認証方法では、circleci.com に既にログインしているユーザーが circleci.com/api/v2/runner でエンドポイントにアクセスできます。

  • ローンチ トークン

リクエスト
名前 入力 必須? 説明

resource-class

文字列

クエリ

省略可

指定したリソース クラスでランナーの一覧を絞り込みます。

namespace

文字列

クエリ

省略可

指定した名前空間でランナーの一覧を絞り込みます。

curl -X GET https://runner.circleci.com/api/v2/runner?resource-class=test-namespace/test-resource \
    -H 'Circle-Token: secret-token'
curl -X GET https://runner.circleci.com/api/v2/runner?namespace=test-namespace \
    -H 'Circle-Token: secret-token'

応答

ステータス 説明 形式

200

ランナーの一覧

JSON

応答スキーム

名前 必須? 説明

items

オブジェクト配列

必須

ランナーの配列

resource_class

文字列

必須

ランナーのリソース クラス

hostname

文字列

必須

ランナーのホスト名

name

文字列

必須

ランナー名

first_connected

文字列 (日付と時刻)

必須

ランナーが最初に接続した日時

last_connected

文字列 (日付と時刻)

必須

ランナーが最後に接続した日時

last_used

文字列 (日付と時刻)

必須

ジョブの実行にランナーを最後に使用した日時

version

文字列

必須

実行中のローンチ エージェントのバージョン

{
    "items": [
        {
            "resource_class": "test-namespace/test-resource",
            "hostname": "bobby",
            "name": "bobby-sue",
            "first_connected": "2020-05-15T00:00:00Z",
            "last_connected": "2020-05-16T00:00:00Z",
            "last_used": "2020-05-17T00:00:00Z",
            "version": "5.4.3.2.1"
        }
    ]
}

GET /api/v2/runner/tasks

指定したリソース クラスで未処理のタスクの数を取得します。

認証方法

  • circle-token (個人認証)

  • ブラウザー セッション認証 + この認証方法では、circleci.com に既にログインしているユーザーが circleci.com/api/v2/runner でエンドポイントにアクセスできます。

  • ローンチ トークン

リクエスト
名前 入力 必須? 説明

resource-class

文字列

クエリ

必須

指定したリソース クラスでタスクを絞り込みます。

curl -X GET https://runner.circleci.com/api/v2/runner/tasks?resource-class=test-namespace/test-resource \
    -H 'Circle-Token: secret-token'

応答

ステータス 説明 形式

200

未処理のタスクの数

JSON

応答スキーム

名前 必須? 説明

unclaimed_task_count

整数

必須

未処理のタスクの数

{
    "unclaimed_task_count": 42
}


Help make this document better

This guide, as well as the rest of our docs, are open-source and available on GitHub. We welcome your contributions.