正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

CI/CDジョブトークンの詳細なアクセス許可設定

  • プラン: Free、Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

詳細なアクセス許可設定を使用すると、制限された一連のREST APIエンドポイントへのアクセスを明示的に許可できます。これらの権限は、指定されたプロジェクトのCI/CDジョブトークンに適用されます。

ジョブトークン許可リストにきめ細かい権限を追加する

前提要件:

  • プロジェクトのメンテナー以上のロールを持っている必要があります。
  • プロジェクトできめ細かい権限の使用を有効にする必要があります。

ジョブトークン許可リストのグループとプロジェクトに、きめ細かい権限を追加できます。これにより、ジョブトークンを使用して特定のプロジェクトリソースにアクセスし、これらのグループとプロジェクトで利用できるリソースをより正確に制御できます。

ジョブトークン許可リストのグループまたはプロジェクトに、きめ細かい権限を追加するには、次の手順に従います:

  1. 左側のサイドバーで、検索または移動先を選択して、プロジェクトを見つけます。
  2. 設定 > CI/CDを選択します。
  3. ジョブトークンの権限を展開します。
  4. CI/CDジョブトークン許可リストセクションで、追加を選択します。
  5. ドロップダウンリストから、グループまたはプロジェクトを選択します。
  6. 既存のグループまたはプロジェクトへのパスを入力します。
  7. 詳細なアクセス許可設定を選択します。
  8. 利用可能なAPIエンドポイントに権限を付与します。
  9. 追加を選択します。

GitLabは、指定された権限を持つジョブトークン許可リストにグループまたはプロジェクトを追加します。グループまたはプロジェクトは、現在のプロジェクトで許可されているすべてのリソースにアクセスできるようになりました。

利用可能なAPIエンドポイント

CI/CDジョブトークンは、次のREST APIエンドポイントにアクセスできます:

デプロイエンドポイント

権限APIエンドポイント権限名スコープ
特定のデプロイを取得GET /projects/:id/deployments/:deployment_idREAD_DEPLOYMENTS読み取り
特定のデプロイに関連付けられたマージリクエストの一覧GET /projects/:id/deployments/:deployment_id/merge_requestsREAD_DEPLOYMENTS読み取り
プロジェクトのデプロイの一覧GET /projects/:id/deploymentsREAD_DEPLOYMENTS読み取り
ブロックされたデプロイを承認または拒否POST /projects/:id/deployments/:deployment_id/approvalADMIN_DEPLOYMENTS読み取りと書き込み
デプロイを作成するPOST /projects/:id/deploymentsADMIN_DEPLOYMENTSADMIN_ENVIRONMENTS読み取りと書き込み
特定のデプロイを削除DELETE /projects/:id/deployments/:deployment_idADMIN_DEPLOYMENTS読み取りと書き込み
デプロイを更新するPUT /projects/:id/deployments/:deployment_idADMIN_DEPLOYMENTS読み取りと書き込み

環境エンドポイント

権限APIエンドポイント権限名スコープ
特定の環境を取得GET /projects/:id/environments/:environment_idREAD_ENVIRONMENTS読み取り
環境の一覧GET /projects/:id/environmentsREAD_ENVIRONMENTS読み取り
新しい環境を作成POST /projects/:id/environmentsADMIN_ENVIRONMENTS読み取りと書き込み
環境を削除するDELETE /projects/:id/environments/:environment_idADMIN_ENVIRONMENTS読み取りと書き込み
停止した複数のレビューアプリを削除DELETE /projects/:id/environments/review_appsADMIN_ENVIRONMENTS読み取りと書き込み
環境を停止します。POST /projects/:id/environments/:environment_id/stopADMIN_ENVIRONMENTS読み取りと書き込み
古くなった環境を停止POST /projects/:id/environments/stop_staleADMIN_ENVIRONMENTS読み取りと書き込み
既存の環境を更新PUT /projects/:id/environments/:environment_idADMIN_ENVIRONMENTS読み取りと書き込み

ジョブエンドポイント

権限APIエンドポイント権限名スコープ
アーティファクトアーカイブから特定のファイルをダウンロードGET /projects/:id/jobs/:job_id/artifacts/*artifact_pathREAD_JOBS読み取り
refsからアーティファクトアーカイブから特定のファイルをダウンロードGET /projects/:id/jobs/artifacts/:ref_name/raw/*artifact_pathREAD_JOBS読み取り
ジョブからアーティファクトアーカイブをダウンロードしますGET /projects/:id/jobs/:job_id/artifactsREAD_JOBS読み取り
ジョブからアーティファクトアーカイブをダウンロードしますGET /projects/:id/jobs/artifacts/:ref_name/downloadREAD_JOBS読み取り
ジョブのアーティファクトファイルをダウンロードGET /jobs/:id/artifactsREAD_JOBS読み取り
プロジェクトジョブを取得GET /projects/:id/jobsREAD_JOBS読み取り
パイプラインジョブを取得しますGET /projects/:id/pipelines/:pipeline_id/jobsREAD_JOBS読み取り

マージリクエストエンドポイント

権限APIエンドポイント権限名スコープ
マージリクエストノートのリストを取得しますGET /projects/:id/merge_requests/:noteable_id/notesREAD_MERGE_REQUESTS読み取り
単一のマージリクエストノートを取得するGET /projects/:id/merge_requests/:noteable_id/notes/:note_idREAD_MERGE_REQUESTS読み取り
単一のマージリクエストを取得しますGET /projects/:id/merge_requests/:merge_request_iidREAD_MERGE_REQUESTS読み取り
プロジェクトマージリクエストをリストするGET /projects/:id/merge_requestsREAD_MERGE_REQUESTS読み取り

パッケージエンドポイント

権限APIエンドポイント権限名スコープ
パッケージアーカイブをダウンロードするためのComposerパッケージエンドポイントGET /projects/:id/packages/composer/archives/*package_nameREAD_PACKAGES読み取り
パッケージファイルをダウンロードするGET /projects/:id/packages/:package_id/package_files/:package_file_id/downloadREAD_PACKAGES読み取り
モジュールファイルをダウンロードGET /projects/:id/packages/go/*module_name/@v/:module_version.modREAD_PACKAGES読み取り
モジュールソースをダウンロードGET /projects/:id/packages/go/*module_name/@v/:module_version.zipREAD_PACKAGES読み取り
パッケージファイルをダウンロードGET /projects/:id/packages/generic/:package_name/*package_version/(*path/):file_nameREAD_PACKAGES読み取り
パッケージファイルをダウンロードGET /packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/package/:conan_package_reference/:package_revision/:file_nameREAD_PACKAGES読み取り
パッケージファイルをダウンロードGET /projects/:id/packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/package/:conan_package_reference/:package_revision/:file_nameREAD_PACKAGES読み取り
パッケージファイルをダウンロードGET /projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision/packages/:conan_package_reference/revisions/:package_revision/files/:file_nameREAD_PACKAGES読み取り
レシピファイルをダウンロードGET /packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/export/:file_nameREAD_PACKAGES読み取り
レシピファイルをダウンロードGET /projects/:id/packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/export/:file_nameREAD_PACKAGES読み取り
レシピファイルをダウンロードGET /projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision/files/:file_nameREAD_PACKAGES読み取り
NPM tarballをダウンロードGET /projects/:id/packages/npm/*package_name/-/*file_nameREAD_PACKAGES読み取り
グループレベルでmavenパッケージファイルをダウンロードGET /groups/:id/-/packages/maven/*path/:file_nameREAD_PACKAGES読み取り
プロジェクトレベルでmavenパッケージファイルをダウンロードGET /projects/:id/packages/maven/*path/:file_nameREAD_PACKAGES読み取り
インスタンスレベルでmavenパッケージファイルをダウンロードGET /packages/maven/*path/:file_nameREAD_PACKAGES読み取り
プロジェクトのパッケージのリストを取得するGET /projects/:id/packagesREAD_PACKAGES読み取り
単一のプロジェクトパッケージを取得しますGET /projects/:id/packages/:package_idREAD_PACKAGES読み取り
特定のNPMパッケージに指定されたすべてのタグを取得GET /groups/:id/-/packages/npm/-/package/*package_name/dist-tagsREAD_PACKAGES読み取り
特定のNPMパッケージに指定されたすべてのタグを取得GET /packages/npm/-/package/*package_name/dist-tagsREAD_PACKAGES読み取り
特定のNPMパッケージに指定されたすべてのタグを取得GET /projects/:id/packages/npm/-/package/*package_name/dist-tagsREAD_PACKAGES読み取り
パッケージ参照メタデータを取得GET /packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/searchREAD_PACKAGES読み取り
パッケージ参照メタデータを取得GET /projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/searchREAD_PACKAGES読み取り
パッケージ参照メタデータを取得GET /projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision/searchREAD_PACKAGES読み取り
パッケージ参照メタデータを取得GET /projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/searchREAD_PACKAGES読み取り
最新のパッケージリビジョンを取得GET /projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision/packages/:conan_package_reference/latestREAD_PACKAGES読み取り
最新のレシピリビジョンを取得GET /projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/latestREAD_PACKAGES読み取り
パッケージリビジョンの一覧を取得GET /projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision/packages/:conan_package_reference/revisionsREAD_PACKAGES読み取り
リビジョンの一覧を取得GET /projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisionsREAD_PACKAGES読み取り
リストGET /projects/:id/packages/go/*module_name/@v/listREAD_PACKAGES読み取り
パッケージファイルをリストするGET /projects/:id/packages/:package_id/package_filesREAD_PACKAGES読み取り
パッケージファイルをリストするGET /projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision/packages/:conan_package_reference/revisions/:package_revision/filesREAD_PACKAGES読み取り
レシピファイルの一覧GET /projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision/filesREAD_PACKAGES読み取り
NPMレジストリの一括アドバイザリエンドポイントPOST /groups/:id/-/packages/npm/-/npm/v1/security/advisories/bulkREAD_PACKAGES読み取り
NPMレジストリの一括アドバイザリエンドポイントPOST /packages/npm/-/npm/v1/security/advisories/bulkREAD_PACKAGES読み取り
NPMレジストリの一括アドバイザリエンドポイントPOST /projects/:id/packages/npm/-/npm/v1/security/advisories/bulkREAD_PACKAGES読み取り
NPMレジストリのメタデータエンドポイントGET /projects/:id/packages/npm/*package_nameREAD_PACKAGES読み取り
NPMレジストリのクイック監査エンドポイントPOST /groups/:id/-/packages/npm/-/npm/v1/security/audits/quickREAD_PACKAGES読み取り
NPMレジストリのクイック監査エンドポイントPOST /packages/npm/-/npm/v1/security/audits/quickREAD_PACKAGES読み取り
NPMレジストリのクイック監査エンドポイントPOST /projects/:id/packages/npm/-/npm/v1/security/audits/quickREAD_PACKAGES読み取り
パッケージダイジェストGET /packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_reference/digestREAD_PACKAGES読み取り
パッケージダイジェストGET /projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_reference/digestREAD_PACKAGES読み取り
パッケージダウンロードURLGET /packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_reference/download_urlsREAD_PACKAGES読み取り
パッケージダウンロードURLGET /projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_reference/download_urlsREAD_PACKAGES読み取り
パッケージスナップショットGET /packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_referenceREAD_PACKAGES読み取り
パッケージスナップショットGET /projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_referenceREAD_PACKAGES読み取り
パッケージアップロードURLPOST /packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_reference/upload_urlsREAD_PACKAGES読み取り
パッケージアップロードURLPOST /projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_reference/upload_urlsREAD_PACKAGES読み取り
レシピダイジェストGET /packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/digestREAD_PACKAGES読み取り
レシピダイジェストGET /projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/digestREAD_PACKAGES読み取り
レシピダウンロードURLGET /packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/download_urlsREAD_PACKAGES読み取り
レシピダウンロードURLGET /projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/download_urlsREAD_PACKAGES読み取り
レシピスナップショットGET /packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channelREAD_PACKAGES読み取り
レシピスナップショットGET /projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channelREAD_PACKAGES読み取り
レシピアップロードURLPOST /packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/upload_urlsREAD_PACKAGES読み取り
レシピアップロードURLPOST /projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/upload_urlsREAD_PACKAGES読み取り
PyPi Simple ProjectインデックスエンドポイントGET /projects/:id/packages/pypi/simpleREAD_PACKAGES読み取り
PyPi Simple ProjectパッケージエンドポイントGET /projects/:id/packages/pypi/simple/*package_nameREAD_PACKAGES読み取り
PyPiパッケージダウンロードエンドポイントGET /projects/:id/packages/pypi/files/:sha256/*file_identifierREAD_PACKAGES読み取り
バージョンメタデータGET /projects/:id/packages/go/*module_name/@v/:module_version.infoREAD_PACKAGES読み取り
NPMパッケージのアップロードを承認PUT /projects/:id/packages/npm/:package_name/authorizeADMIN_PACKAGES読み取りと書き込み
workhorseからのPyPiパッケージアップロードを承認POST /projects/:id/packages/pypi/authorizeADMIN_PACKAGES読み取りと書き込み
パッケージを登録するためのComposerパッケージエンドポイントPOST /projects/:id/packages/composerADMIN_PACKAGES読み取りと書き込み
指定されたNPMパッケージとバージョンに対して指定されたタグを作成または更新PUT /groups/:id/-/packages/npm/-/package/*package_name/dist-tags/:tagADMIN_PACKAGES読み取りと書き込み
指定されたNPMパッケージとバージョンに対して指定されたタグを作成または更新PUT /packages/npm/-/package/*package_name/dist-tags/:tagADMIN_PACKAGES読み取りと書き込み
指定されたNPMパッケージとバージョンに対して指定されたタグを作成または更新PUT /projects/:id/packages/npm/-/package/*package_name/dist-tags/:tagADMIN_PACKAGES読み取りと書き込み
NPMパッケージを作成または非推奨にするPUT /projects/:id/packages/npm/:package_nameADMIN_PACKAGES読み取りと書き込み
パッケージを削除DELETE /packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channelADMIN_PACKAGES読み取りと書き込み
パッケージを削除DELETE /projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channelADMIN_PACKAGES読み取りと書き込み
パッケージファイルを削除するDELETE /projects/:id/packages/:package_id/package_files/:package_file_idADMIN_PACKAGES読み取りと書き込み
プロジェクトパッケージを削除するDELETE /projects/:id/packages/:package_idADMIN_PACKAGES読み取りと書き込み
パッケージリビジョンを削除DELETE /projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision/packages/:conan_package_reference/revisions/:package_revisionADMIN_PACKAGES読み取りと書き込み
レシピリビジョンを削除DELETE /projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revisionADMIN_PACKAGES読み取りと書き込み
指定されたタグを削除DELETE /groups/:id/-/packages/npm/-/package/*package_name/dist-tags/:tagADMIN_PACKAGES読み取りと書き込み
指定されたタグを削除DELETE /packages/npm/-/package/*package_name/dist-tags/:tagADMIN_PACKAGES読み取りと書き込み
指定されたタグを削除DELETE /projects/:id/packages/npm/-/package/*package_name/dist-tags/:tagADMIN_PACKAGES読み取りと書き込み
PyPiパッケージアップロードエンドポイントPOST /projects/:id/packages/pypiADMIN_PACKAGES読み取りと書き込み
パッケージファイルをアップロードPUT /projects/:id/packages/generic/:package_name/*package_version/(*path/):file_nameADMIN_PACKAGES読み取りと書き込み
パッケージファイルをアップロードPUT /packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/package/:conan_package_reference/:package_revision/:file_nameADMIN_PACKAGES読み取りと書き込み
パッケージファイルをアップロードPUT /projects/:id/packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/package/:conan_package_reference/:package_revision/:file_nameADMIN_PACKAGES読み取りと書き込み
パッケージファイルをアップロードPUT /projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision/packages/:conan_package_reference/revisions/:package_revision/files/:file_nameADMIN_PACKAGES読み取りと書き込み
パッケージファイルをアップロードPUT /packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/export/:file_nameADMIN_PACKAGES読み取りと書き込み
パッケージファイルをアップロードPUT /projects/:id/packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/export/:file_nameADMIN_PACKAGES読み取りと書き込み
パッケージファイルをアップロードPUT /projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision/files/:file_nameADMIN_PACKAGES読み取りと書き込み
Workhorseは汎用パッケージファイルを承認PUT /projects/:id/packages/maven/*path/:file_nameADMIN_PACKAGES読み取りと書き込み
WorkhorseはConanパッケージファイルを承認PUT /projects/:id/packages/generic/:package_name/*package_version/(*path/):file_name/authorizeADMIN_PACKAGES読み取りと書き込み
WorkhorseはConanパッケージファイルを承認PUT /packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/package/:conan_package_reference/:package_revision/:file_name/authorizeADMIN_PACKAGES読み取りと書き込み
WorkhorseはConanパッケージファイルを承認PUT /projects/:id/packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/package/:conan_package_reference/:package_revision/:file_name/authorizeADMIN_PACKAGES読み取りと書き込み
WorkhorseはConanパッケージファイルを承認PUT /projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision/packages/:conan_package_reference/revisions/:package_revision/files/:file_name/authorizeADMIN_PACKAGES読み取りと書き込み
WorkhorseはConanのレシピファイルを承認PUT /packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/export/:file_name/authorizeADMIN_PACKAGES読み取りと書き込み
WorkhorseはConanのレシピファイルを承認PUT /projects/:id/packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/export/:file_name/authorizeADMIN_PACKAGES読み取りと書き込み
WorkhorseはConanのレシピファイルを承認PUT /projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision/files/:file_name/authorizeADMIN_PACKAGES読み取りと書き込み
パイプラインエンドポイントPUT /projects/:id/packages/maven/*path/:file_name/authorizeADMIN_PACKAGES読み取りと書き込み

パイプラインエンドポイント

権限APIエンドポイント権限名スコープ
プロジェクトのすべてのパイプラインを取得しますGET /projects/:id/pipelinesREAD_PIPELINES読み取り
パイプラインブリッジジョブを取得GET /projects/:id/pipelines/:pipeline_id/bridgesREAD_PIPELINES読み取り
単一プロジェクトのパッケージのパイプラインを取得GET /projects/:id/packages/:package_id/pipelinesREAD_PIPELINES読み取り
プロジェクトの特定のパイプラインを取得GET /projects/:id/pipelines/:pipeline_idREAD_PIPELINES読み取り
パイプラインメタデータを更新PUT /projects/:id/pipelines/:pipeline_id/metadataADMIN_PIPELINES読み取りと書き込み

リリースエンドポイント

権限APIエンドポイント権限名スコープ
プロジェクトリリースリリースアセットファイルをダウンロードGET /projects/:id/releases/:tag_name/downloads/*direct_asset_pathREAD_RELEASES読み取り
リリースの変更履歴セクションを生成して返すGET /projects/:id/repository/changelogREAD_RELEASES読み取り
タグ名でリリースを取得するGET /projects/:id/releases/:tag_nameREAD_RELEASES読み取り
リリースリンクを取得GET /projects/:id/releases/:tag_name/assets/links/:link_idREAD_RELEASES読み取り
最新のプロジェクトリリースを取得GET /projects/:id/releases/permalink/latest(/)(*suffix_path)READ_RELEASES読み取り
リリースをリストするGET /projects/:id/releasesREAD_RELEASES読み取り
リリースのリンクの一覧GET /projects/:id/releases/:tag_name/assets/linksREAD_RELEASES読み取り
リリースエビデンスを収集するPOST /projects/:id/releases/:tag_name/evidenceADMIN_RELEASES読み取りと書き込み
リリースを作成するPOST /projects/:id/releasesADMIN_RELEASES読み取りと書き込み
リリースリンクを作成するPOST /projects/:id/releases/:tag_name/assets/linksADMIN_RELEASES読み取りと書き込み
リリースを削除するDELETE /projects/:id/releases/:tag_nameADMIN_RELEASES読み取りと書き込み
リリースリンクを削除するDELETE /projects/:id/releases/:tag_name/assets/links/:link_idADMIN_RELEASES読み取りと書き込み
新しいコンポーネントプロジェクトリリースをバージョンとしてCI/CDカタログに公開POST /projects/:id/catalog/publishADMIN_RELEASES読み取りと書き込み
リリースを更新するPUT /projects/:id/releases/:tag_nameADMIN_RELEASES読み取りと書き込み
リリースリンクを更新するPUT /projects/:id/releases/:tag_name/assets/links/:link_idADMIN_RELEASES読み取りと書き込み

リポジトリエンドポイント

権限APIエンドポイント権限名スコープ
コミットに関連付けられたマージリクエストを取得GET /projects/:id/repository/commits/:sha/merge_requestsREAD_REPOSITORIES読み取り
プロジェクトリポジトリのブランチを取得GET /projects/:id/repository/branchesREAD_REPOSITORIES読み取り
プロジェクトリポジトリタグを取得するGET /projects/:id/repository/tagsREAD_REPOSITORIES読み取り
プロジェクトの特定のコミットを取得GET /projects/:id/repository/commits/:shaREAD_REPOSITORIES読み取り
リポジトリからrawファイルの内容を取得GET /projects/:id/repository/files/:file_path/rawREAD_REPOSITORIES読み取り

セキュアファイルエンドポイント

権限APIエンドポイント権限名スコープ
セキュアファイルをダウンロードGET /projects/:id/secure_files/:secure_file_id/downloadREAD_SECURE_FILES読み取り
プロジェクト内のセキュアファイルの一覧を取得GET /projects/:id/secure_filesREAD_SECURE_FILES読み取り
プロジェクト内の特定のセキュアファイルの詳細を取得GET /projects/:id/secure_files/:secure_file_idREAD_SECURE_FILES読み取り
セキュアファイルを作成POST /projects/:id/secure_filesADMIN_SECURE_FILES読み取りと書き込み
セキュアファイルを削除DELETE /projects/:id/secure_files/:secure_file_idADMIN_SECURE_FILES読み取りと書き込み

Terraformステートエンドポイント

権限APIエンドポイント権限名スコープ
名前でTerraformステートを取得GET /projects/:id/terraform/state/:nameREAD_TERRAFORM_STATE読み取り
Terraformステートバージョンを取得GET /projects/:id/terraform/state/:name/versions/:serialREAD_TERRAFORM_STATE読み取り
新しいTerraformステートを追加するか、既存のステートを更新POST /projects/:id/terraform/state/:nameADMIN_TERRAFORM_STATE読み取りと書き込み
特定の名前のTerraformステートを削除DELETE /projects/:id/terraform/state/:nameADMIN_TERRAFORM_STATE読み取りと書き込み
Terraformステートバージョンを削除DELETE /projects/:id/terraform/state/:name/versions/:serialADMIN_TERRAFORM_STATE読み取りと書き込み
特定の名前のTerraformステートをロックPOST /projects/:id/terraform/state/:name/lockADMIN_TERRAFORM_STATE読み取りと書き込み
特定の名前のTerraformステートをアンロックDELETE /projects/:id/terraform/state/:name/lockADMIN_TERRAFORM_STATE読み取りと書き込み

作業アイテムエンドポイント

権限APIエンドポイント権限名スコープ
プロジェクトイシューの一覧を取得GET /projects/:id/issuesREAD_WORK_ITEMS読み取り
単一プロジェクトイシューを取得します。GET /projects/:id/issues/:issue_iidREAD_WORK_ITEMS読み取り

利用できないAPIエンドポイント

CI/CDジョブトークンは、以下のエンドポイントにアクセスできません:

権限APIエンドポイント
リポジトリの削除DELETE /projects/:id/registry/repositories/:repository_id
リポジトリタグの一括削除DELETE /projects/:id/registry/repositories/:repository_id/tags
リポジトリタグの削除DELETE /projects/:id/registry/repositories/:repository_id/tags/:tag_name
パッケージバージョンのメタデータ用、グループレベルのComposerパッケージエンドポイントGET /group/:id/-/packages/composer/*package_name
パッケージリストのグループレベルのComposerパッケージエンドポイントGET /group/:id/-/packages/composer/p/:sha
パッケージバージョンのメタデータ用、グループレベルのComposer v2パッケージp2エンドポイントGET /group/:id/-/packages/composer/p2/*package_name
グループレベルのComposerパッケージエンドポイントGET /group/:id/-/packages/composer/packages
NPMレジストリのメタデータエンドポイントGET /groups/:id/-/packages/npm/*package_name
グループからパッケージファイルをダウンロードGET /groups/:id/-/packages/pypi/files/:sha256/*file_identifier
PyPi Simple GroupインデックスエンドポイントGET /groups/:id/-/packages/pypi/simple
PyPi Simple GroupパッケージエンドポイントGET /groups/:id/-/packages/pypi/simple/*package_name
トークンを使用して現在のジョブを取得GET /job
現在のエージェントを取得GET /job/allowed_agents
パッケージの検索GET /packages/conan/v1/conans/search
Conan APIをpingするGET /packages/conan/v1/ping
Conan CLIに対してユーザーを認証するGET /packages/conan/v1/users/authenticate
Conan CLIごとの有効なユーザー認証情報を確認GET /packages/conan/v1/users/check_credentials
NPMレジストリのメタデータエンドポイントGET /packages/npm/*package_name
パッケージの検索GET /projects/:id/packages/conan/v1/conans/search
Conan APIをpingするGET /projects/:id/packages/conan/v1/ping
Conan CLIに対してユーザーを認証するGET /projects/:id/packages/conan/v1/users/authenticate
Conan CLIごとの有効なユーザー認証情報を確認GET /projects/:id/packages/conan/v1/users/check_credentials
パッケージの検索GET /projects/:id/packages/conan/v2/conans/search
Conan CLIに対してユーザーを認証するGET /projects/:id/packages/conan/v2/users/authenticate
Conan CLIごとの有効なユーザー認証情報を確認GET /projects/:id/packages/conan/v2/users/check_credentials
プロジェクト内のコンテナリポジトリの一覧表示GET /projects/:id/registry/repositories
リポジトリのタグの一覧表示GET /projects/:id/registry/repositories/:repository_id/tags
リポジトリタグに関する詳細の取得GET /projects/:id/registry/repositories/:repository_id/tags/:tag_name
DASTサイト検証を新しい状態に移行します。POST /internal/dast/site_validations/:id/transition