APIリソース
GitLab APIで利用可能なリソースは、以下のコンテキストにグループ分けすることができます:
こちらも参照してください。
- V3からV4へ。
- 複数プロジェクトのデプロイキーの追加。
- 各種テンプレートのAPIリソースです。
プロジェクトリソース
プロジェクト・コンテキストでは、以下の API リソースを利用できます:
リソース | 利用可能なエンドポイント |
---|---|
アクセスリクエスト |
/projects/:id/access_requests (グループでのご利用も可能です)
|
賞の絵文字 |
/projects/:id/issues/.../award_emoji /projects/:id/merge_requests/.../award_emoji 、/projects/:id/snippets/.../award_emoji
|
ブランチ |
/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/dependencies
|
キーのデプロイ |
/projects/:id/deploy_keys (単体でもご利用いただけます)
|
凍結期間 | /projects/:id/freeze_periods
|
デプロイ | /projects/:id/deployments
|
ディスカッション(スレッドコメント) |
/projects/:id/issues/.../discussions ,/projects/:id/snippets/.../discussions ,/projects/:id/merge_requests/.../discussions ,/projects/:id/commits/.../discussions (グループでのご利用も可能です。)
|
環境 | /projects/:id/environments
|
エラートラッキング | /projects/:id/error_tracking/settings
|
イベント |
/projects/:id/events (ユーザーとスタンドアロンでも利用可能)
|
機能フラグ | /projects/:id/feature_flags
|
機能フラグ ユーザーリスト | /projects/:id/feature_flags_user_lists
|
イシュー |
/projects/:id/issues (グループや単独でもご利用いただけます)
|
イシュー統計 |
/projects/:id/issues_statistics (グループや単独でもご利用いただけます)
|
イシューボード | /projects/:id/boards
|
イシューリンク | /projects/:id/issues/.../links
|
ジョブ |
/projects/:id/jobs ,/projects/:id/pipelines/.../jobs
|
ラベル | /projects/:id/labels
|
マネージドライセンス | /projects/:id/managed_licenses
|
メンバー |
/projects/:id/members (グループでのご利用も可能です)
|
マージリクエスト承認者 |
/projects/:id/approvals ,/projects/:id/merge_requests/.../approvals
|
マージリクエスト |
/projects/:id/merge_requests (グループや単独でもご利用いただけます)
|
備考(コメント) |
/projects/:id/issues/.../notes ,/projects/:id/snippets/.../notes ,/projects/:id/merge_requests/.../notes (グループでのご利用も可能です。)
|
通知設定 |
/projects/:id/notification_settings (グループや単独でもご利用いただけます)
|
パッケージ | /projects/:id/packages
|
ドメイン |
/projects/:id/pages (単体でもご利用いただけます)
|
パイプライン | /projects/:id/pipelines
|
パイプラインスケジュール | /projects/:id/pipeline_schedules
|
パイプラインのトリガー | /projects/:id/triggers
|
Webhookの設定を含むプロジェクト |
/projects /projects/:id/hooks (内部ユーザーも利用可能)
|
プロジェクト・バッジ | /projects/:id/badges
|
プロジェクト・クラスター | /projects/:id/clusters
|
プロジェクトレベルの変数 | /projects/:id/variables
|
プロジェクトのインポート/エクスポート |
/projects/:id/export /projects/import 、/projects/:id/import
|
プロジェクトのマイルストーン | /projects/:id/milestones
|
プロジェクトのスニペット | /projects/:id/snippets
|
プロジェクトテンプレート | /projects/:id/templates
|
保護された環境 | /projects/:id/protected_environments
|
保護ブランチ | /projects/:id/protected_branches
|
保護されたタグ | /projects/:id/protected_tags
|
リリース | /projects/:id/releases
|
リリースリンク | /projects/:id/releases/.../assets/links
|
リモートミラー | /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 (グループでのご利用も可能です。)
|
ランナー |
/projects/:id/runners (単体でもご利用いただけます)
|
検索 |
/projects/:id/search (グループや単独でもご利用いただけます)
|
サービス内容 | /projects/:id/services
|
タグ | /projects/:id/repository/tags
|
ユーザーによるメトリクス・ダッシュボード | /projects/:id/metrics/user_starred_dashboards
|
ビジュアルレビュー・ディスカッション | /projects/:id/merge_requests/:merge_request_id/visual_review_discussions
|
脆弱性 | /vulnerabilities/:id
|
脆弱性輸出 | /projects/:id/vulnerability_exports
|
プロジェクトの脆弱性 | /projects/:id/vulnerabilities
|
脆弱性調査結果 | /projects/:id/vulnerability_findings
|
Wiki | /projects/:id/wikis
|
グループリソース
グループコンテキストでは、以下のAPIリソースを利用できます:
リソース | 利用可能なエンドポイント |
---|---|
アクセスリクエスト |
/groups/:id/access_requests/ (プロジェクトでもご利用いただけます)
|
カスタム属性 |
/groups/:id/custom_attributes (プロジェクトやユーザーも利用可能)
|
ディスカッション(スレッドコメント) |
/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/labels
|
グループレベルの変数 | /groups/:id/variables
|
グループのマイルストーン | /groups/:id/milestones
|
イシュー |
/groups/:id/issues (プロジェクトやスタンドアロンでも利用可能)
|
イシュー統計 |
/groups/:id/issues_statistics (プロジェクトやスタンドアロンでも利用可能)
|
メンバー |
/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
を含む):
リソース | 利用可能なエンドポイント |
---|---|
インスタンスレベルのCI/CD変数 | /admin/ci/variables
|
管理Sidekiqキュー | /admin/sidekiq/queues/:queue_name
|
外観 | /application/appearance
|
アプリケーション | /applications
|
監査イベント | /audit_events
|
アバター | /avatar
|
ブロードキャストメッセージ | /broadcast_messages
|
コードスニペット | /snippets
|
カスタム属性 |
/users/:id/custom_attributes (グループやプロジェクトにもご利用いただけます)
|
キーのデプロイ |
/deploy_keys (プロジェクトでもご利用いただけます)
|
イベント |
/events ,/users/:id/events (プロジェクトにも対応)
|
機能フラグ | /features
|
Geoノード | /geo_nodes
|
グループアクティビティ分析 | /analytics/group_activity/{issues_count | merge_requests_count | new_members_count }
|
GitHubからリポジトリをインポート | /import/github
|
イシュー |
/issues (グループやプロジェクトにもご利用いただけます)
|
イシュー統計 |
/issues_statistics (グループやプロジェクトにもご利用いただけます)
|
鍵 | /keys
|
ライセンス | /license
|
マークダウン | /markdown
|
マージリクエスト |
/merge_requests (グループやプロジェクトにもご利用いただけます)
|
メトリクスダッシュボードの注釈 |
/environments/:id/metrics_dashboard/annotations ,/clusters/:id/metrics_dashboard/annotations
|
名前空間 | /namespaces
|
通知設定 |
/notification_settings (グループやプロジェクトにもご利用いただけます)
|
ドメイン |
/pages/domains (プロジェクトでもご利用いただけます)
|
プロジェクト |
/users/:id/projects (プロジェクトでもご利用いただけます)
|
プロジェクトリポジトリの移動 | /project_repository_storage_moves
|
ランナー |
/runners (プロジェクトでもご利用いただけます)
|
検索 |
/search (グループやプロジェクトにもご利用いただけます)
|
設定 | /application/settings
|
統計 | /application/statistics
|
Sidekiqメトリクス | /sidekiq
|
提案 | /suggestions
|
システムフック | /hooks
|
To-Do | /todos
|
ユーザー | /users
|
.gitlab-ci.yml ファイルの検証
| /lint
|
バージョン | /version
|
テンプレートAPIリソース
エンドポイントが利用できます: