REST APIリソース
GitLab REST APIで利用可能なリソースは、以下のコンテキストにグループ分けすることができます:
こちらも参照してください。
- 複数のプロジェクトのデプロイキーを追加する」も参照してください。
- 様々なテンプレートのAPIリソース。
プロジェクトリソース
プロジェクトコンテキストでは、以下のAPIリソースを利用できます:
| リソース | 利用可能なエンドポイント |
|---|---|
| アクセス要求 |
/projects/:id/access_requests (グループでも利用可能) |
| アクセストークン |
/projects/:id/access_tokens (グループでも利用可能) |
| エージェント | /projects/:id/cluster_agents |
| ブランチ |
/projects/:id/repository/branches/,/projects/:id/repository/merged_branches
|
| コミット |
/projects/:id/repository/commits,/projects/:id/statuses
|
| コンテナレジストリ | /projects/:id/registry/repositories |
| カスタム属性 |
/projects/:id/custom_attributes (グループとユーザーにも使用可能) |
| ディストリビューション |
/projects/:id/packages/composer (グループでも利用可能) |
| Conanディストリビューション |
/projects/:id/packages/conan (スタンドアロンでも利用可能) |
| Debian ディストリビューション |
/projects/:id/debian_distributions (グループでも利用可能) |
| Debian パッケージ |
/projects/:id/packages/debian (グループでも利用可能) |
| 依存関係 | /projects/:id/dependencies |
| デプロイ・キー |
/projects/:id/deploy_keys (スタンドアロンでも利用可能) |
| デプロイトークン |
/projects/:id/deploy_tokens (グループとスタンドアロンでも利用可能) |
| デプロイ | /projects/:id/deployments |
| ディスカッション(スレッドコメント) |
/projects/:id/issues/.../discussions,/projects/:id/snippets/.../discussions,/projects/:id/merge_requests/.../discussions,/projects/:id/commits/.../discussions (グループでも利用可能) |
| ドラフトノート(コメント) | /projects/:id/merge_requests/.../draft_notes |
| 絵文字のリアクション |
/projects/:id/issues/.../award_emoji,/projects/:id/merge_requests/.../award_emoji 、/projects/:id/snippets/.../award_emoji
|
| 環境 | /projects/:id/environments |
| エラートラッキング | /projects/:id/error_tracking/settings |
| イベント |
/projects/:id/events (ユーザーおよびスタンドアロンでも利用可能) |
| 外部ステータスチェック | /projects/:id/external_status_checks |
| 機能フラグ ユーザーリスト | /projects/:id/feature_flags_user_lists |
| 機能フラグ | /projects/:id/feature_flags |
| フリーズ期間 | /projects/:id/freeze_periods |
| Go プロキシ | /projects/:id/packages/go |
| Helmリポジトリ | /projects/:id/packages/helm_repository |
| インテグレーション(以前の「サービス」) | /projects/:id/integrations |
| 招待状 |
/projects/:id/invitations (グループでも利用可能) |
| イシューボード | /projects/:id/boards |
| イシューリンク | /projects/:id/issues/.../links |
| イシュー統計 |
/projects/:id/issues_statistics (グループとスタンドアロンでも利用可能) |
| イシュー |
/projects/:id/issues (グループとスタンドアロンでも利用可能) |
| 反復 |
/projects/:id/iterations (グループでも利用可能) |
| プロジェクト CI/CD ジョブトークンスコープ | /projects/:id/job_token_scope |
| ジョブ |
/projects/:id/jobs,/projects/:id/pipelines/.../jobs
|
| ジョブ アーティファクト | /projects/:id/jobs/:job_id/artifacts |
| ラベル | /projects/:id/labels |
| Maven リポジトリ |
/projects/:id/packages/maven (グループとスタンドアロンでも利用可能) |
| メンバー |
/projects/:id/members (グループでも利用可能) |
| マージリクエストの承認者 |
/projects/:id/approvals,/projects/:id/merge_requests/.../approvals
|
| マージリクエスト |
/projects/:id/merge_requests (グループとスタンドアロンでも利用可能) |
| マージ列車 | /projects/:id/merge_trains |
| メタデータ | /metadata |
| ノート(コメント) |
/projects/:id/issues/.../notes,/projects/:id/snippets/.../notes,/projects/:id/merge_requests/.../notes (グループも可) |
| 通知設定 |
/projects/:id/notification_settings (グループとスタンドアロンでも利用可能) |
| npm リポジトリ | /projects/:id/packages/npm |
| NuGetパッケージ |
/projects/:id/packages/nuget (グループでも利用可能) |
| パッケージ | /projects/:id/packages |
| ページドメイン |
/projects/:id/pages (スタンドアロンでも利用可能) |
| パイプラインスケジュール | /projects/:id/pipeline_schedules |
| パイプラインのトリガー | /projects/:id/triggers |
| パイプライン | /projects/:id/pipelines |
| プロジェクトバッジ | /projects/:id/badges |
| プロジェクト・クラスター | /projects/:id/clusters |
| プロジェクトのインポート/エクスポート |
/projects/:id/export,/projects/import 、/projects/:id/import
|
| プロジェクトのマイルストーン | /projects/:id/milestones |
| プロジェクトスニペット | /projects/:id/snippets |
| プロジェクトテンプレート | /projects/:id/templates |
| プロジェクトの脆弱性 | /projects/:id/vulnerabilities |
| プロジェクトWiki | /projects/:id/wikis |
| プロジェクトレベルの変数 | /projects/:id/variables |
| Webhookの設定を含むプロジェクト |
/projects /projects/:id/hooks (ユーザーも利用可能) |
| 保護ブランチ | /projects/:id/protected_branches |
| 保護された環境 | /projects/:id/protected_environments |
| 保護されたタグ | /projects/:id/protected_tags |
| PyPI パッケージ |
/projects/:id/packages/pypi (グループでも利用可能) |
| リリースリンク | /projects/:id/releases/.../assets/links |
| リリース | /projects/:id/releases |
| リモートミラー | /projects/:id/remote_mirrors |
| リポジトリ | /projects/:id/repository |
| リポジトリファイル | /projects/:id/repository/files |
| リポジトリサブモジュール | /projects/:id/repository/submodules |
| リソースラベルイベント |
/projects/:id/issues/.../resource_label_events /projects/:id/merge_requests/.../resource_label_events (グループでも利用可能) |
| Ruby gems | /projects/:id/packages/rubygems |
| ランナー |
/projects/:id/runners (スタンドアロンでも利用可能) |
| 検索 |
/projects/:id/search (グループとスタンドアロンでも利用可能) |
| タグ | /projects/:id/repository/tags |
| Terraform モジュール |
/projects/:id/packages/terraform/modules (スタンドアロンでも利用可能) |
| ユーザー評価のメトリクスダッシュボード | /projects/:id/metrics/user_starred_dashboards |
| ビジュアルレビューディスカッション | /projects/:id/merge_requests/:merge_request_id/visual_review_discussions |
| 脆弱性 | /vulnerabilities/:id |
| 脆弱性のエクスポート | /projects/:id/vulnerability_exports |
| 脆弱性の発見 | /projects/:id/vulnerability_findings |
グループリソース
グループコンテキストでは、以下のAPIリソースを利用できます:
| リソース | 利用可能なエンドポイント |
|---|---|
| アクセス要求 |
/groups/:id/access_requests/ (プロジェクトにもご利用いただけます。) |
| アクセストークン |
/groups/:id/access_tokens (プロジェクトにもご利用いただけます。) |
| カスタム属性 |
/groups/:id/custom_attributes (プロジェクトとユーザーでも利用可能) |
| Debian ディストリビューション |
/groups/:id/-/packages/debian (プロジェクトにもご利用いただけます。) |
| デプロイトークン |
/groups/:id/deploy_tokens (プロジェクトやスタンドアロンでも利用可能) |
| ディスカッション(コメントとスレッド) |
/groups/:id/epics/.../discussions (プロジェクトにもご利用いただけます。) |
| エピック・イシュー | /groups/:id/epics/.../issues |
| エピック・リンク | /groups/:id/epics/.../epics |
| エピック | /groups/:id/epics |
| グループ |
/groups,/groups/.../subgroups
|
| グループバッジ | /groups/:id/badges |
| グループイシューボード | /groups/:id/boards |
| グループの反復 |
/groups/:id/iterations (プロジェクトにもご利用いただけます。) |
| グループラベル | /groups/:id/labels |
| グループレベルの変数 | /groups/:id/variables |
| グループのマイルストーン | /groups/:id/milestones |
| グループのリリース | /groups/:id/releases |
| グループWiki | /groups/:id/wikis |
| 招待状 |
/groups/:id/invitations (プロジェクトにもご利用いただけます。) |
| イシュー |
/groups/:id/issues (プロジェクトやスタンドアロンでも利用可能) |
| イシュー統計 |
/groups/:id/issues_statistics (プロジェクトやスタンドアロンでも利用可能) |
| リンクされたエピック | /groups/:id/epics/.../related_epics |
| メンバーのロール | /groups/:id/member_roles |
| メンバー |
/groups/:id/members (プロジェクトにもご利用いただけます。) |
| マージリクエスト |
/groups/:id/merge_requests (プロジェクトやスタンドアロンでも利用可能) |
| ノート(コメント) |
/groups/:id/epics/.../notes (プロジェクトにもご利用いただけます。) |
| 通知設定 |
/groups/:id/notification_settings (プロジェクトやスタンドアロンでも利用可能) |
| リソースラベルイベント |
/groups/:id/epics/.../resource_label_events (プロジェクトにもご利用いただけます。) |
| 検索 |
/groups/:id/search (プロジェクトやスタンドアロンでも利用可能) |
スタンドアロンリソース
以下のAPIリソースは、プロジェクトやグループのコンテキスト外(/users を含む)で利用できます:
| リソース | 利用可能なエンドポイント |
|---|---|
| 外観 | /application/appearance |
| アプリケーション | /applications |
| 監査イベント | /audit_events |
| アバター | /avatar |
| ブロードキャスト・メッセージ | /broadcast_messages |
| コード・スニペット | /snippets |
| コードの提案 | /code_suggestions |
| カスタム属性 |
/users/:id/custom_attributes (グループやプロジェクトでも利用可能) |
| デプロイ・キー |
/deploy_keys (プロジェクトにもご利用いただけます。) |
| デプロイトークン |
/deploy_tokens (プロジェクトやグループでも利用可能) |
| イベント |
/events,/users/:id/events (プロジェクトにもご利用いただけます) |
| 機能フラグ | /features |
| Geoノード | /geo_nodes |
| グループアクティビティ分析 | /analytics/group_activity/{issues_count} |
| グループリポジトリの移動 | /group_repository_storage_moves |
| GitHubからのリポジトリインポート | /import/github |
| Bitbucket Serverからのリポジトリインポート | /import/bitbucket_server |
| インスタンスクラスタ | /admin/clusters |
| インスタンスレベルのCI/CD変数 | /admin/ci/variables |
| イシュー統計 |
/issues_statistics (グループやプロジェクトでも利用可能) |
| イシュー |
/issues (グループやプロジェクトでも利用可能) |
| ジョブ | /job |
| キー | /keys |
| ライセンス | /license |
| マークダウン | /markdown |
| マージリクエスト |
/merge_requests (グループやプロジェクトでも利用可能) |
| メトリクスダッシュボードの注釈 |
/environments/:id/metrics_dashboard/annotations,/clusters/:id/metrics_dashboard/annotations
|
| 名前空間 | /namespaces |
| 通知設定 |
/notification_settings (グループやプロジェクトでも利用可能) |
| ページドメイン |
/pages/domains (プロジェクトにもご利用いただけます。) |
| 個人アクセストークン | /personal_access_tokens |
| プランの制限 | /application/plan_limits |
| プロジェクトリポジトリの移動 | /project_repository_storage_moves |
| プロジェクト |
/users/:id/projects (プロジェクトにもご利用いただけます。) |
| ランナー |
/runners (プロジェクトにもご利用いただけます。) |
| 検索 |
/search (グループやプロジェクトでも利用可能) |
| サービスデータ |
/usage_data (GitLabインスタンス管理者ユーザーのみ) |
| サービス設定 | /application/settings |
| Sidekiqメトリクス | /sidekiq |
| Sidekiqキューの管理 | /admin/sidekiq/queues/:queue_name |
| スニペットリポジトリの移動 | /snippet_repository_storage_moves |
| 統計 | /application/statistics |
| 提案 | /suggestions |
| システムフック | /hooks |
| To-dos | /todos |
| トピックス | /topics |
| ユーザー | /users |
.gitlab-ci.yml ファイルの検証 | /lint |
| バージョン | /version |
テンプレート APIリソース
エンドポイントが利用できます: