シークレット
secrets カテゴリの API 操作 3 件を説明します。
| メソッド | パス | 説明 |
|---|---|---|
| GET | /v1/orgs/{orgSlug}/projects/{projectName}/secrets | シークレット名とバージョンの一覧です(runlot secret list) |
| PUT | /v1/orgs/{orgSlug}/projects/{projectName}/secrets/{secretName} | シークレットを作成または更新します(runlot secret set) |
| DELETE | /v1/orgs/{orgSlug}/projects/{projectName}/secrets/{secretName} | シークレットを削除します(runlot secret delete) |
GET /v1/orgs/{orgSlug}/projects/{projectName}/secrets
値はいかなるレスポンスにも含まれません。 値がRunlotの外に出る唯一の方法は、workerの env.<NAME> を通じてです。member 以上の権限が必要です。
operationId listSecrets
| ステータスコード | 説明 | レスポンスボディ |
|---|---|---|
| 200 | 一覧取得 | SecretList |
| 403 | — | — |
| 404 | — | — |
PUT /v1/orgs/{orgSlug}/projects/{projectName}/secrets/{secretName}
これは冪等ではありません — 呼び出すたびに version が上がります。その直後、稼働中のworkerはデプロイと同じ経路で、ダウンタイムなしに新しい環境に置き換わります。再デプロイは不要です。
値は暗号化されて保存され、返されることはありません。secret.set 監査イベントには名前のみが記録されます。
member 以上が必要です。
operationId setSecret
リクエストボディ: application/json ・ object
| ステータスコード | 説明 | レスポンスボディ |
|---|---|---|
| 200 | 保存された名前とバージョンです | SecretMeta |
| 400 | 名前が規則に従っていない場合(bad_request)、または予約された名前である場合(reserved_name: DB、ASSETS、RUNLOT_* — env.db と env.assets バインディングの大文字版、およびノードのプレフィックス) | Error |
| 403 | — | — |
| 404 | — | — |
DELETE /v1/orgs/{orgSlug}/projects/{projectName}/secrets/{secretName}
存在しない名前は404を返します — 何も削除していないのに削除したと主張するレスポンスはありません。member 以上の権限が必要です。secret.delete として監査記録されます。
operationId deleteSecret
| ステータスコード | 説明 | レスポンスボディ |
|---|---|---|
| 204 | 削除済み | — |
| 403 | — | — |
| 404 | — | — |