> For the complete documentation index, see [llms.txt](https://stablebuild.gitbook.io/ja/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://stablebuild.gitbook.io/ja/product/public-api-keys.md).

# 公開 API キー

公開 API キーを使うと、オープンソースプロジェクトでも StableBuild を利用できます。キーを Dockerfile や CI の設定にそのまま書いて公開しておけば、誰がプロジェクトをビルドしても、ピン留めした同じ依存関係を StableBuild から取得できます。このキーで取得できるのは許可した依存関係だけで、組織のほかの依存関係にはアクセスできません。

{% hint style="warning" %}
公開キーのトラフィックはすべて、組織の利用分として請求されます。Community プランでは公開キーのトラフィックも組織の月間トラフィック上限に含まれ、上限に達すると公開キーを使ったビルドは失敗します。
{% endhint %}

### 仕組み

公開キーは読み取り専用です。取得できるのは、許可リストに載っていて、かつ StableBuild にキャッシュ済みのファイルだけです。アップストリームから新たにダウンロードすることはありません。

許可リストに項目を追加するには、キーの書き込み期間を開始します。書き込み期間中は通常の API キーと同じように使え、取得したものはすべて許可リストに追加されます。その間にビルドを一度実行し、終わったら書き込み期間を終了してください。

{% hint style="info" %}
書き込み期間中は、キーを知っている人なら誰でも、このキーで何でもプルできます。書き込み期間はできるだけ短くし、ビルドが終わったらすぐに終了してください。
{% endhint %}

### 公開キーの作成

1. [ダッシュボード](https://dashboard.stablebuild.com)を開き、**API キー > 新しいキーを追加** をクリックします。
2. 名前を入力し、**公開キー** にチェックを入れます。公開キーは `your-prefix-pub-` で始まります。
3. **キーを追加する** をクリックします。続けて **書き込み期間を開始** ダイアログが開くので、そのまま[依存関係を記録](#recording-your-dependencies)できます。

キーの一覧では、公開キーに **公開** のラベルが付き、その横に **読み取り専用** か **…まで書き込み可能** のどちらかが表示されます。

### 依存関係の記録 <a href="#recording-your-dependencies" id="recording-your-dependencies"></a>

1. **API キー** ページで、公開キーの三点メニューから **書き込み期間を開始** を選びます。キーを作成した直後なら、このダイアログはすでに開いています。
2. キーの横のボタンでキーをコピーします。書き込み期間が自動で終了するまでの時間を 1 時間、24 時間、7 日間から選び、**書き込み期間を開始する** をクリックします。
3. 公開キーを使ってビルドを一度実行します。例：

{% code overflow="wrap" %}

```docker
FROM your-prefix-pub-myproject.dockermirror.stablebuild.com/python:3.12-slim

ARG SB_API_KEY=your-prefix-pub-myproject
ARG APT_PIN_DATE=2026-09-29T08:40:01Z

COPY ./sb-apt.sh /opt/sb-apt.sh
RUN bash /opt/sb-apt.sh load-apt-sources debian
RUN apt update && apt install -y curl

RUN pip install -i https://your-prefix-pub-myproject.pypimirror.stablebuild.com/2026-09-01/ requests==2.32.3

RUN curl -O "https://your-prefix-pub-myproject.httpcache.stablebuild.com/my-cache-key/https://bootstrap.pypa.io/get-pip.py"
```

{% endcode %}

4. ビルドが終わったら、もう一度三点メニューを開き、**書き込み期間を終了する** をクリックします。

これで、誰でもこのキーを使ってプロジェクトをビルドできます。依存関係が変わったときは、改めて書き込み期間を開始し、ビルドを実行し直してください。

### 許可リストの管理

公開キーでダウンロードできるものは、キーの三点メニューから **許可リスト** を開くと確認できます。項目はミラーごとに分かれていて、それぞれの追加日も表示されます。不要な項目は **削除する** をクリックすると許可リストから外せます。

書き込み期間の終了や項目の削除は、反映されるまでに 5 分ほどかかる場合があります。

公開キーが誰に使われているかは、**請求 > 生の使用ログ** で確認できます。リクエストごとに、どの API キーが使われたかが表示されます。
