Skip to main content
PUT
リポジトリを一括でインデックス化する

権限

サービスユーザーまたはパーソナルアクセストークンが必要です。権限チェックの内容は、組織でのリポジトリアクセスの管理方法によって異なります。
  • 組織レベルの権限: 呼び出し元には、組織レベルの IndexOrgRepositories 権限が必要です。
  • リポジトリ単位の詳細な権限付与: IndexOrgRepositories はチェックされません。呼び出し元には、組織レベルの Read 権限に加えて、リクエストに含まれるすべてのリポジトリに対する repo.use_read と repo.index の両方の権限付与が必要です。いずれかのリポジトリでどちらか一方でも権限付与が不足している場合、リクエスト全体が 403 で拒否され、どのリポジトリもインデックスされません。

挙動

このエンドポイントは冪等です。つまり、同じリポジトリを指定して複数回呼び出しても、重複したインデックス作成ジョブは作成されません。このリクエストでは、リクエスト内の各リポジトリに対してインデックス作成を有効にし、インデックス作成ジョブをトリガーします。 各リポジトリについて、特定のブランチをインデックス作成するためにbranch_namesを任意で指定できます。省略した場合は、デフォルトブランチが利用されます。

承認

Authorization
string
header
必須

サービスユーザーの認証情報(接頭辞: cog_)

パスパラメータ

org_id
string
必須

組織ID(プレフィックス: org-)

例:

"org-abc123def456"

ボディ

application/json
repositories
RepositoryIndexingItem · object[]
必須
Required array length: 1 - 100 elements

レスポンス

成功レスポンス

branches
string[]
必須
indexing_enabled
boolean
必須
repository_path
string
必須
indexing_status
RepoIndexingStatusResponse · object | null