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

プロジェクトAPI

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

このAPIを使用して、GitLabプロジェクトとそれに関連する設定を管理します。プロジェクトは、コードを保存し、イシューを追跡し、チームのアクティビティを編成できる、コラボレーションの中心的なハブです。詳細については、プロジェクトを作成するを参照してください。

プロジェクトAPIには、次のエンドポイントが含まれています。

  • プロジェクトの情報とメタデータを取得する
  • プロジェクトを作成、編集、削除する
  • プロジェクトの表示レベル、アクセス権限、セキュリティ設定を制御する
  • イシュートラッキング、マージリクエスト、CI/CDなどのプロジェクト機能を管理する
  • プロジェクトをアーカイブおよびアーカイブ解除する
  • ネームスペース間でプロジェクトを転送する
  • デプロイとコンテナレジストリの設定を管理する

前提条件

  • プロジェクトのプロパティを読み取るための、プロジェクト上の任意のデフォルトロール。
  • プロジェクトのプロパティを編集するには、プロジェクトのオーナーまたはメンテナーロールが必要です。

プロジェクトの表示レベル

GitLabのプロジェクトには、次のいずれかの表示レベルを設定できます。

  • 非公開
  • 内部
  • 公開

表示レベルは、プロジェクトのvisibilityフィールドによって決まります。

詳細については、プロジェクトの表示レベルを参照してください。

応答で返されるフィールドは、認証済みユーザーの権限によって異なります。

プロジェクト機能の表示レベル

プロジェクトを作成または編集する際に、プロジェクトの設定の可用性を制御できます。たとえば、既存のプロジェクトに対してforking_access_levelを無効にするには、次のようにします:

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --data '{"forking_access_level": "disabled"}' \
  --url "https://gitlab.example.com/api/v4/projects/<project_id>"

各設定は個別に定義でき、次の値を許容します:

  • disabled: 機能を無効にします。
  • private: 機能を有効にして、プロジェクトメンバーのみに設定します。
  • enabled: 機能を有効にして、アクセスできる人すべてに設定します。
  • public: 機能を有効にして、全員に設定します。pages_access_levelにのみ利用可能です。

詳細については、プロジェクト内の個々の機能の表示設定を変更するを参照してください。

属性型必須説明
analytics_access_level文字列いいえ分析の表示レベルを設定します。
builds_access_level文字列いいえパイプラインの表示レベルを設定します。
container_registry_access_level文字列いいえコンテナレジストリの表示レベルを設定します。
environments_access_level文字列いいえ環境の表示レベルを設定します。
feature_flags_access_level文字列いいえ機能フラグの表示レベルを設定します。
forking_access_level文字列いいえフォークの表示レベルを設定します。
infrastructure_access_level文字列いいえインフラストラクチャ管理の表示レベルを設定します。
issues_access_level文字列いいえイシューの表示レベルを設定します。
merge_requests_access_level文字列いいえマージリクエストの表示レベルを設定します。
model_experiments_access_level文字列いいえ機械学習モデル実験の表示レベルを設定します。
model_registry_access_level文字列いいえ機械学習モデルレジストリの表示レベルを設定します。
monitor_access_level文字列いいえアプリケーションパフォーマンスモニタリングの表示レベルを設定します。
pages_access_level文字列いいえGitLab Pagesの表示レベルを設定します。
releases_access_level文字列いいえリリースの表示レベルを設定します。
repository_access_level文字列いいえリポジトリの表示レベルを設定します。
requirements_access_level文字列いいえ要件管理の表示レベルを設定します。
security_and_compliance_access_level文字列いいえセキュリティとコンプライアンスの表示レベルを設定します。
snippets_access_level文字列いいえスニペットの表示レベルを設定します。
wiki_access_level文字列いいえWikiの表示レベルを設定します。

非推奨の属性

以下の属性は非推奨であり、REST APIの将来のバージョンで削除される可能性があります。代わりに代替属性を使用してください。

非推奨の属性代替
tag_list代わりにtopicsを使用してください。
marked_for_deletion_at代わりにmarked_for_deletion_onを使用してください。PremiumおよびUltimateのみです。
approvals_before_mergeGitLab 16.0で非推奨になりました。代わりにマージリクエスト承認APIを使用してください。PremiumおよびUltimateのみです。
packages_enabledGitLab 17.10で非推奨になりました。代わりにpackage_registry_access_levelを使用してください。
container_registry_enabled代わりにcontainer_registry_access_levelを使用してください。
public_builds代わりにpublic_jobsを使用してください。
emails_disabled代わりにemails_enabledを使用してください。
issues_enabled代わりにissues_access_levelを使用してください。
jobs_enabled代わりにbuilds_access_levelを使用してください。
merge_requests_enabled代わりにmerge_request_access_levelを使用してください。
snippets_enabled代わりにsnippets_access_levelを使用してください。
wiki_enabled代わりにwiki_access_levelを使用してください。
restrict_user_defined_variablesGitLab 17.7で非推奨になりました。代わりにci_pipeline_variables_minimum_override_roleを使用してください。

プロジェクトを取得する

指定されたプロジェクトを取得します。プロジェクトが公開されている場合、このエンドポイントには認証なしでアクセスできます。

GET /projects/:id

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
licenseブール値いいえプロジェクトのライセンスデータを含めます。
statisticsブール値いいえプロジェクトの統計を含めます。レポーター、デベロッパー、メンテナー、またはオーナーのロールを持つユーザーのみ利用可能です。
with_custom_attributesブール値いいえ応答にカスタム属性を含めます。管理者アクセス権が必要です。

成功した場合、200 OKと次のレスポンス属性を返します:

属性型説明
id整数プロジェクトのID。
description文字列プロジェクトの説明。
description_html文字列HTML形式でのプロジェクトの説明。
name文字列プロジェクト名。
name_with_namespace文字列ネームスペースを含むプロジェクト名。
path文字列プロジェクトのパス。
path_with_namespace文字列ネームスペースを含むプロジェクトのパス。
created_at日時プロジェクトが作成された日時。
default_branch文字列プロジェクトのデフォルトブランチ。
tag_list文字列の配列非推奨。代わりにtopicsを使用してください。プロジェクトのタグのリスト。
topics文字列の配列プロジェクトのトピックのリスト。
ssh_url_to_repo文字列リポジトリをクローンするためのSSH URL。
http_url_to_repo文字列リポジトリをクローンするためのHTTP URL。
web_url文字列ブラウザでプロジェクトにアクセスするためのURL。
readme_url文字列プロジェクトのReadmeファイルへのURL。
forks_count整数プロジェクトのフォーク数。
avatar_url文字列プロジェクトのアバター画像へのURL。
star_count整数プロジェクトが受け取ったスターの数。
last_activity_at日時プロジェクトの最終アクティビティのタイムスタンプ。
visibility文字列プロジェクトの表示レベル。設定可能な値: private、internal、またはpublic。
namespaceオブジェクトプロジェクトのネームスペース情報。
namespace.id整数ネームスペースのID。
namespace.name文字列ネームスペースの名前。
namespace.path文字列ネームスペースのパス。
namespace.kind文字列ネームスペースの種類。設定可能な値: userまたはgroup。
namespace.full_path文字列ネームスペースのフルパス。
namespace.parent_id整数該当する場合、親ネームスペースのID。
namespace.avatar_url文字列ネームスペースのアバター画像へのURL。
namespace.web_url文字列ブラウザでネームスペースにアクセスするためのURL。
container_registry_image_prefix文字列コンテナレジストリイメージのプレフィックス。
_linksオブジェクトプロジェクトに関連するAPIエンドポイントリンクのコレクション。
_links.self文字列プロジェクトリソースへのURL。
_links.issues文字列プロジェクトのイシューへのURL。
_links.merge_requests文字列プロジェクトのマージリクエストへのURL。
_links.repo_branches文字列プロジェクトのリポジトリのブランチへのURL。
_links.labels文字列プロジェクトのラベルへのURL。
_links.events文字列プロジェクトのイベントへのURL。
_links.members文字列プロジェクトのメンバーへのURL。
_links.cluster_agents文字列プロジェクトのクラスターエージェントへのURL。
marked_for_deletion_at日付非推奨。代わりにmarked_for_deletion_onを使用してください。プロジェクトの削除予定日。
marked_for_deletion_on日付プロジェクトの削除予定日。
packages_enabledブール値プロジェクトでパッケージレジストリが有効になっているかどうか。
empty_repoブール値リポジトリが空であるかどうか。
archivedブール値プロジェクトがアーカイブされているかどうか。
ownerオブジェクトプロジェクトオーナーに関する情報。
owner.id整数プロジェクトオーナーのID。
owner.username文字列オーナーのユーザー名。
owner.public_email文字列オーナーの公開メールアドレス。
owner.name文字列プロジェクトオーナーの名前。
owner.state文字列オーナーアカウントの現在の状態。
owner.lockedブール値オーナーアカウントがロックされているかどうかを示します。
owner.avatar_url文字列オーナーのアバター画像へのURL。
owner.web_url文字列オーナーのプロファイルへのWeb URL。
owner.created_at日時オーナーが作成された日時。
resolve_outdated_diff_discussionsブール値最新ではない差分ディスカッションが自動的に解決されるかどうか。
container_expiration_policyオブジェクトコンテナイメージのポリシーの有効期限に関する設定。
container_expiration_policy.cadence文字列コンテナの有効期限ポリシーが実行される頻度。
container_expiration_policy.enabledブール値コンテナの有効期限ポリシーが有効になっているかどうか。
container_expiration_policy.keep_n整数保持するコンテナイメージの数。
container_expiration_policy.older_than文字列この値よりも古いコンテナイメージを削除します。
container_expiration_policy.name_regex文字列非推奨。代わりにname_regex_deleteを使用してください。コンテナイメージ名に一致する正規表現。
container_expiration_policy.name_regex_delete文字列削除するコンテナイメージ名に一致する正規表現。
container_expiration_policy.name_regex_keep文字列保持するコンテナイメージ名に一致する正規表現。
container_expiration_policy.next_run_at日時次回のポリシー実行予定時刻のタイムスタンプ。
repository_object_format文字列リポジトリで使用されるオブジェクト形式。設定可能な値: sha1またはsha256。
issues_enabledブール値プロジェクトでイシューが有効になっているかどうか。
merge_requests_enabledブール値プロジェクトでマージリクエストが有効になっているかどうか。
wiki_enabledブール値プロジェクトでWikiが有効になっているかどうか。
jobs_enabledブール値プロジェクトでジョブが有効になっているかどうか。
snippets_enabledブール値プロジェクトでスニペットが有効になっているかどうか。
container_registry_enabledブール値非推奨。代わりにcontainer_registry_access_levelを使用してください。コンテナレジストリが有効になっているかどうか。
service_desk_enabledブール値プロジェクトでサービスデスクが有効になっているかどうか。
service_desk_address文字列サービスデスクのメールアドレス。
can_create_merge_request_inブール値現在のユーザーがプロジェクトでマージリクエストを作成できるかどうか。
issues_access_level文字列イシュー機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
repository_access_level文字列リポジトリ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
merge_requests_access_level文字列マージリクエスト機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
forking_access_level文字列プロジェクトをフォークするためのアクセスレベル。設定可能な値: disabled、private、またはenabled。
wiki_access_level文字列Wiki機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
builds_access_level文字列CI/CDビルド機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
snippets_access_level文字列スニペット機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
pages_access_level文字列GitLab Pagesのアクセスレベル。設定可能な値: disabled、private、enabled、またはpublic。
analytics_access_level文字列分析機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
container_registry_access_level文字列コンテナレジストリのアクセスレベル。設定可能な値: disabled、private、またはenabled。
security_and_compliance_access_level文字列セキュリティおよびコンプライアンス機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
releases_access_level文字列リリース機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
environments_access_level文字列環境機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
feature_flags_access_level文字列機能フラグ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
infrastructure_access_level文字列インフラストラクチャ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
monitor_access_level文字列監視機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
model_experiments_access_level文字列モデル実験機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
model_registry_access_level文字列モデルレジストリ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
package_registry_access_level文字列パッケージレジストリ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
emails_disabledブール値プロジェクトのメールが無効になっているかどうかを示します。
emails_enabledブール値プロジェクトのメールが有効になっているかどうかを示します。
show_diff_preview_in_emailブール値メール通知で差分プレビューが表示されるかどうかを示します。
shared_runners_enabledブール値プロジェクトで共有Runnerが有効になっているかどうか。
lfs_enabledブール値プロジェクトでGit LFSが有効になっているかどうかを示します。
creator_id整数プロジェクトを作成したユーザーのID。
import_url文字列プロジェクトがインポートされたURL。
import_type文字列プロジェクトに使用されたインポートの種類。
import_status文字列プロジェクトインポートのステータス。
import_error文字列インポートが失敗した場合のエラーメッセージ。
open_issues_count整数未解決のイシューの数。
updated_at日時プロジェクトが最後に更新された日時。
ci_default_git_depth整数CI/CDパイプラインのデフォルトのGit深度。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
ci_delete_pipelines_in_seconds整数古いパイプラインが削除されるまでの時間（秒単位）。
ci_forward_deployment_enabledブール値フォワードデプロイが有効になっているかどうか。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
ci_forward_deployment_rollback_allowedブール値フォワードデプロイメントでロールバックが許可されているかどうか。
ci_job_token_scope_enabledブール値CI/CDジョブトークンスコープが有効になっているかどうかを示します。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
ci_separated_cachesブール値CI/CDキャッシュがブランチごとに分離されているかどうか。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
ci_allow_fork_pipelines_to_run_in_parent_projectブール値フォークパイプラインが親プロジェクトで実行できるかどうか。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
ci_id_token_sub_claim_components文字列の配列CI/CDIDトークンのサブジェクトクレームに含まれるコンポーネント。
build_git_strategy文字列CI/CDのビルドに使用されるGit戦略（フェッチまたはクローン）。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
keep_latest_artifactブール値新しいアーティファクトが作成されたときに、最新のアーティファクトが保持されるかどうかを示します。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
restrict_user_defined_variablesブール値ユーザー定義の変数が制限されているかどうか。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
ci_pipeline_variables_minimum_override_role文字列パイプライン変数をオーバーライドするために必要な最小ロール。
runner_token_expiration_interval整数Runnerトークンの有効期限間隔（秒単位）。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
group_runners_enabledブール値プロジェクトでグループRunnerが有効になっているかどうか。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
resource_group_default_process_mode文字列リソースグループのデフォルト処理モード。
auto_cancel_pending_pipelines文字列保留中のパイプラインを自動的にキャンセルするための設定。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
build_timeout整数CI/CDジョブのタイムアウト（秒単位）。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
auto_devops_enabledブール値プロジェクトでAuto DevOpsが有効になっているかどうか。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
auto_devops_deploy_strategy文字列Auto DevOpsのデプロイ戦略。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
ci_push_repository_for_job_token_allowedブール値ジョブトークンを使用してリポジトリへのプッシュが許可されているかどうか。
runners_token文字列プロジェクトにRunnerを登録するためのトークン。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
ci_config_path文字列CI/CD設定ファイルへのパス。
public_jobsブール値ジョブログが公開アクセス可能かどうか。
shared_with_groupsオブジェクトの配列プロジェクトが共有されているグループのリスト。
shared_with_groups[].group_id整数プロジェクトが共有されているグループのID。
shared_with_groups[].group_name文字列プロジェクトが共有されているグループの名前。
shared_with_groups[].group_full_path文字列プロジェクトが共有されているグループのフルパス。
shared_with_groups[].group_access_level整数グループに付与されたアクセスレベル。
only_allow_merge_if_pipeline_succeedsブール値パイプラインが成功した場合にのみマージが許可されるかどうか。
allow_merge_on_skipped_pipelineブール値パイプラインがスキップされた場合にマージが許可されるかどうか。
request_access_enabledブール値ユーザーがプロジェクトへのアクセスをリクエストできるかどうか。
only_allow_merge_if_all_discussions_are_resolvedブール値すべてのディスカッションが解決される場合にのみマージが許可されるかどうか。
remove_source_branch_after_mergeブール値マージ後にソースブランチが自動的に削除されるかどうか。
printing_merge_request_link_enabledブール値プッシュ後にマージリクエストのリンクが出力されるかどうかを示します。
printing_merge_requests_link_enabledブール値プッシュ後にマージリクエストのリンクが出力されるかどうか。
merge_method文字列プロジェクトに使用されるマージメソッド。設定可能な値: merge、rebase_merge、またはff。
merge_request_title_regex文字列マージリクエストのタイトルを検証するための正規表現パターン。
merge_request_title_regex_description文字列マージリクエストのタイトル正規表現の検証の説明。
squash_option文字列マージリクエストのスカッシュオプション。
enforce_auth_checks_on_uploadsブール値アップロード時に認証チェックが強制されるかどうか。
suggestion_commit_message文字列提案のカスタムコミットメッセージ。
merge_commit_template文字列マージコミットメッセージのテンプレート。
squash_commit_template文字列スカッシュコミットメッセージのテンプレート。
issue_branch_template文字列イシューから作成されたブランチ名のテンプレート。
warn_about_potentially_unwanted_charactersブール値潜在的に不要な文字の使用について警告するかどうか。
autoclose_referenced_issuesブール値参照されたイシューが自動的に閉じられるかどうか。
max_artifacts_size整数CI/CDアーティファクトの最大サイズ（MB）。
approvals_before_merge整数非推奨。代わりにマージリクエスト承認APIを使用してください。マージ前に必要な承認の数。
mirrorブール値プロジェクトがミラーであるかどうか。
external_authorization_classification_label文字列外部認可分類ラベル。
requirements_enabledブール値要件管理が有効になっているかどうかを示します。
requirements_access_level文字列要件機能のアクセスレベル。
security_and_compliance_enabledブール値セキュリティおよびコンプライアンス機能が有効になっているかどうかを示します。
secret_push_protection_enabledブール値シークレットプッシュ保護が有効になっているかどうか。
pre_receive_secret_detection_enabledブール値プレ受信シークレット検出が有効になっているかどうかを示します。
compliance_frameworks文字列の配列プロジェクトに適用されるコンプライアンスフレームワーク。
issues_template文字列イシューのデフォルトの説明。説明は、GitLab Flavored Markdownを使用して解析されます。PremiumおよびUltimateのみです。
merge_requests_template文字列マージリクエストの説明のテンプレート。PremiumおよびUltimateのみです。
ci_restrict_pipeline_cancellation_role文字列パイプラインをキャンセルするために必要な最小ロール。
merge_pipelines_enabledブール値マージパイプラインが有効になっているかどうかを示します。
merge_trains_enabledブール値マージトレインが有効になっているかどうかを示します。
merge_trains_skip_train_allowedブール値マージトレインのスキップが許可されているかどうかを示します。
only_allow_merge_if_all_status_checks_passedブール値すべてのステータスチェックが合格した場合にのみマージが許可されるかどうか。Ultimateのみです。
allow_pipeline_trigger_approve_deploymentブール値パイプライントリガーがデプロイを承認できるかどうか。
prevent_merge_without_jira_issueブール値マージに、関連付けられたJiraイシューが必要かどうかを示します。
duo_remote_flows_enabledブール値GitLab Duoのリモートフローが有効になっているかどうかを示します。
duo_foundational_flows_enabledブール値GitLab Duoの基本フローが有効になっているかどうかを示します。
duo_sast_fp_detection_enabledブール値GitLab Duo SASTの誤検出判定が有効になっているかどうかを示します。
web_based_commit_signing_enabledブール値Webベースのコミット署名が有効になっているかどうかを示します。
spp_repository_pipeline_accessブール値セキュリティポリシーのリポジトリパイプラインアクセス。セキュリティオーケストレーションポリシー機能が利用可能な場合にのみ表示されます。
permissionsオブジェクトプロジェクトのユーザー権限。
permissions.project_accessオブジェクトユーザーのプロジェクトレベルのアクセス権。
permissions.project_access.access_level整数プロジェクトのアクセスレベル。
permissions.project_access.notification_level整数プロジェクトの通知レベル。
permissions.group_accessオブジェクトユーザーのグループレベルのアクセス権。
permissions.group_access.access_level整数グループのアクセスレベル。
permissions.group_access.notification_level整数グループの通知レベル。
license_url文字列プロジェクトのライセンスファイルへのURL。
license.key文字列ライセンスのキー識別子。
license.name文字列ライセンスのフルネーム。
license.nickname文字列ライセンスのニックネーム。
license.html_url文字列ライセンスの詳細を表示するためのURL。
license.source_url文字列ライセンスのソーステキストへのURL。
repository_storage文字列プロジェクトのリポジトリの保存場所。
mirror_user_id整数ミラーを設定したユーザーのID。
mirror_trigger_buildsブール値ミラーの更新がビルドをトリガーするかどうか。
only_mirror_protected_branchesブール値保護ブランチのみがミラーされるかどうか。
mirror_overwrites_diverged_branchesブール値ミラーが分岐したブランチを上書きするかどうか。
statistics.commit_count整数プロジェクト内のコミット数。
statistics.storage_size整数合計ストレージサイズ（バイト単位）。
statistics.repository_size整数リポジトリストレージのサイズ（バイト単位）。
statistics.wiki_size整数Wikiストレージのサイズ（バイト単位）。
statistics.lfs_objects_size整数LFSオブジェクトストレージのサイズ（バイト単位）。
statistics.job_artifacts_size整数ジョブアーティファクトストレージのサイズ（バイト単位）。
statistics.pipeline_artifacts_size整数パイプラインアーティファクトストレージのサイズ（バイト単位）。
statistics.packages_size整数パッケージストレージのサイズ（バイト単位）。
statistics.snippets_size整数スニペットストレージのサイズ（バイト単位）。
statistics.uploads_size整数アップロードストレージのサイズ（バイト単位）。
statistics.container_registry_size整数コンテナレジストリストレージのサイズ（バイト単位）。1
forked_from_projectオブジェクトこのプロジェクトがフォークしたアップストリームプロジェクト。アップストリームプロジェクトがプライベートの場合、このフィールドを表示するには認証トークンが必要です。
mr_default_target_selfブール値マージリクエストがデフォルトでこのプロジェクトをターゲットとするかどうか。falseの場合、マージリクエストはアップストリームプロジェクトをターゲットとします。プロジェクトがフォークの場合にのみ表示されます。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/projects/<project_id>"

レスポンス例:

{
  "id": 3,
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
  "description_html": "<p data-sourcepos=\"1:1-1:56\" dir=\"auto\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
  "default_branch": "main",
  "visibility": "private",
  "ssh_url_to_repo": "git@example.com:diaspora/diaspora-project-site.git",
  "http_url_to_repo": "http://example.com/diaspora/diaspora-project-site.git",
  "web_url": "http://example.com/diaspora/diaspora-project-site",
  "readme_url": "http://example.com/diaspora/diaspora-project-site/blob/main/README.md",
  "tag_list": [ //deprecated, use `topics` instead
    "example",
    "disapora project"
  ],
  "topics": [
    "example",
    "disapora project"
  ],
  "owner": {
    "id": 3,
    "name": "Diaspora",
    "created_at": "2013-09-30T13:46:02Z"
  },
  "name": "Diaspora Project Site",
  "name_with_namespace": "Diaspora / Diaspora Project Site",
  "path": "diaspora-project-site",
  "path_with_namespace": "diaspora/diaspora-project-site",
  "issues_enabled": true,
  "open_issues_count": 1,
  "merge_requests_enabled": true,
  "jobs_enabled": true,
  "wiki_enabled": true,
  "snippets_enabled": false,
  "can_create_merge_request_in": true,
  "resolve_outdated_diff_discussions": false,
  "container_registry_enabled": false, // deprecated, use container_registry_access_level instead
  "container_registry_access_level": "disabled",
  "security_and_compliance_access_level": "disabled",
  "container_expiration_policy": {
    "cadence": "7d",
    "enabled": false,
    "keep_n": null,
    "older_than": null,
    "name_regex": null, // to be deprecated in GitLab 13.0 in favor of `name_regex_delete`
    "name_regex_delete": null,
    "name_regex_keep": null,
    "next_run_at": "2020-01-07T21:42:58.658Z"
  },
  "created_at": "2013-09-30T13:46:02Z",
  "updated_at": "2013-09-30T13:46:02Z",
  "last_activity_at": "2013-09-30T13:46:02Z",
  "creator_id": 3,
  "namespace": {
    "id": 3,
    "name": "Diaspora",
    "path": "diaspora",
    "kind": "group",
    "full_path": "diaspora",
    "avatar_url": "http://localhost:3000/uploads/group/avatar/3/foo.jpg",
    "web_url": "http://localhost:3000/groups/diaspora"
  },
  "import_url": null,
  "import_type": null,
  "import_status": "none",
  "import_error": null,
  "permissions": {
    "project_access": {
      "access_level": 10,
      "notification_level": 3
    },
    "group_access": {
      "access_level": 50,
      "notification_level": 3
    }
  },
  "archived": false,
  "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
  "license_url": "http://example.com/diaspora/diaspora-client/blob/main/LICENSE",
  "license": {
    "key": "lgpl-3.0",
    "name": "GNU Lesser General Public License v3.0",
    "nickname": "GNU LGPLv3",
    "html_url": "http://choosealicense.com/licenses/lgpl-3.0/",
    "source_url": "http://www.gnu.org/licenses/lgpl-3.0.txt"
  },
  "shared_runners_enabled": true,
  "group_runners_enabled": true,
  "forks_count": 0,
  "star_count": 0,
  "runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b",
  "ci_default_git_depth": 50,
  "ci_forward_deployment_enabled": true,
  "ci_forward_deployment_rollback_allowed": true,
  "ci_allow_fork_pipelines_to_run_in_parent_project": true,
  "ci_id_token_sub_claim_components": ["project_path", "ref_type", "ref"],
  "ci_separated_caches": true,
  "ci_restrict_pipeline_cancellation_role": "developer",
  "ci_pipeline_variables_minimum_override_role": "maintainer",
  "ci_push_repository_for_job_token_allowed": false,
  "ci_display_pipeline_variables": false,
  "protect_merge_request_pipelines": true,
  "public_jobs": true,
  "shared_with_groups": [
    {
      "group_id": 4,
      "group_name": "Twitter",
      "group_full_path": "twitter",
      "group_access_level": 30
    },
    {
      "group_id": 3,
      "group_name": "Gitlab Org",
      "group_full_path": "gitlab-org",
      "group_access_level": 10
    }
  ],
  "repository_storage": "default",
  "only_allow_merge_if_pipeline_succeeds": false,
  "allow_merge_on_skipped_pipeline": false,
  "allow_pipeline_trigger_approve_deployment": false,
  "restrict_user_defined_variables": false,
  "only_allow_merge_if_all_discussions_are_resolved": false,
  "remove_source_branch_after_merge": false,
  "printing_merge_requests_link_enabled": true,
  "request_access_enabled": false,
  "merge_method": "merge",
  "squash_option": "default_on",
  "auto_devops_enabled": true,
  "auto_devops_deploy_strategy": "continuous",
  "approvals_before_merge": 0, // Deprecated. Use merge request approvals API instead.
  "mirror": false,
  "mirror_user_id": 45,
  "mirror_trigger_builds": false,
  "only_mirror_protected_branches": false,
  "mirror_overwrites_diverged_branches": false,
  "external_authorization_classification_label": null,
  "packages_enabled": true,
  "empty_repo": false,
  "service_desk_enabled": false,
  "service_desk_address": null,
  "autoclose_referenced_issues": true,
  "suggestion_commit_message": null,
  "enforce_auth_checks_on_uploads": true,
  "merge_commit_template": null,
  "squash_commit_template": null,
  "issue_branch_template": "gitlab/%{id}-%{title}",
  "marked_for_deletion_at": "2020-04-03", // Deprecated in favor of marked_for_deletion_on. Planned for removal in a future version of the REST API.
  "marked_for_deletion_on": "2020-04-03",
  "compliance_frameworks": [ "sox" ],
  "warn_about_potentially_unwanted_characters": true,
  "secret_push_protection_enabled": false,
  "statistics": {
    "commit_count": 37,
    "storage_size": 1038090,
    "repository_size": 1038090,
    "wiki_size" : 0,
    "lfs_objects_size": 0,
    "job_artifacts_size": 0,
    "pipeline_artifacts_size": 0,
    "packages_size": 0,
    "snippets_size": 0,
    "uploads_size": 0,
    "container_registry_size": 0
  },
  "container_registry_image_prefix": "registry.example.com/diaspora/diaspora-client",
  "_links": {
    "self": "http://example.com/api/v4/projects",
    "issues": "http://example.com/api/v4/projects/1/issues",
    "merge_requests": "http://example.com/api/v4/projects/1/merge_requests",
    "repo_branches": "http://example.com/api/v4/projects/1/repository_branches",
    "labels": "http://example.com/api/v4/projects/1/labels",
    "events": "http://example.com/api/v4/projects/1/events",
    "members": "http://example.com/api/v4/projects/1/members",
    "cluster_agents": "http://example.com/api/v4/projects/1/cluster_agents"
  },
  "spp_repository_pipeline_access": false // Only visible if the security_orchestration_policies feature is available
}

プロジェクトのリストを取得する

プロジェクトとプロジェクトの属性をリスト表示します。

すべてのプロジェクトのリストを取得する

認証済みユーザーがアクセス可能なインスタンス上のすべてのプロジェクトをリスト表示します。未認証のリクエストは、属性の限定されたサブセットを持つ公開プロジェクトのみを返します。

カスタム属性で応答をフィルタリングできます。

このエンドポイントはページネーションをサポートしています:

  • オフセットベースのページネーションを使用して、最大50,000のプロジェクトにアクセスします。
  • キーセットベースのページネーションを使用して、50,000以上のプロジェクトをリスト表示します。

詳細については、ページネーションを参照してください。

GET /projects

サポートされている属性は以下のとおりです:

属性型必須説明
archivedブール値いいえアーカイブステータスで制限します。
id_after整数いいえ指定されたIDより大きいIDを持つプロジェクトに結果を制限します。
id_before整数いいえ指定されたIDより小さいIDを持つプロジェクトに結果を制限します。
importedブール値いいえ現在のユーザーによって外部システムからインポートされたプロジェクトに結果を制限します。
include_hiddenブール値いいえ非表示プロジェクトを含めます。_（管理者のみ）_PremiumおよびUltimateのみ。
include_pending_deleteブール値いいえ削除保留中のプロジェクトを含めます。（管理者のみ）
last_activity_after日時いいえ指定された時刻以降に最後のアクティビティが行われたプロジェクトに結果を制限します。形式: ISO 8601（YYYY-MM-DDTHH:MM:SSZ）
last_activity_before日時いいえ指定された時刻以前に最後のアクティビティが行われたプロジェクトに結果を制限します。形式: ISO 8601（YYYY-MM-DDTHH:MM:SSZ）
membershipブール値いいえ現在のユーザーがメンバーであるプロジェクトで制限します。
min_access_level整数いいえ現在のユーザーが指定されたアクセスレベル以上を持つプロジェクトに限定します。使用可能な値: 5 (最小アクセス)、10 (ゲスト)、15 (プランナー)、20 (レポーター)、30 (デベロッパー)、40 (メンテナー)、または50 (オーナー)。
order_by文字列いいえid、name、path、created_at、updated_at、star_count、last_activity_at、またはsimilarityフィールドで並べ替えられたプロジェクトを返します。repository_size、storage_size、packages_size、またはwiki_sizeフィールドは、管理者のみが使用できます。similarityは検索時にのみ使用可能であり、現在のユーザーがメンバーであるプロジェクトに限定されます。デフォルトはcreated_atです。
ownedブール値いいえ現在のユーザーが明示的に所有するプロジェクトで制限します。
repository_checksum_failedブール値いいえリポジトリチェックサムの計算に失敗したプロジェクトを制限します。PremiumおよびUltimateのみです。
repository_storage文字列いいえrepository_storageに保存されているプロジェクトに結果を制限します。（管理者のみ）
search_namespacesブール値いいえ検索条件に一致するときに、祖先のネームスペースを含めます。デフォルトはfalseです。
search文字列いいえpath、name、またはdescriptionが検索条件（大文字と小文字は区別されない、部分文字列一致）に一致するプロジェクトのリストを返します。複数の用語は、エスケープされたスペース（+または%20）で区切って指定できます。これらの用語はANDで結合されます。たとえばone+twoは、部分文字列oneおよびtwo（順不同）に一致します。
simpleブール値いいえtrueの場合、各プロジェクトの限られたフィールドのみを返します。simpleが設定されていない場合でも、未認証のリクエストは、限られたフィールドを持つ公開プロジェクトのみを返します。
sort文字列いいえascまたはdescの順にソートされたプロジェクトを返します。デフォルトはdescです。
starredブール値いいえ現在のユーザーがStar付きに登録したプロジェクトで制限します。
statisticsブール値いいえプロジェクトの統計を含めます。レポーター、デベロッパー、メンテナー、またはオーナーのロールを持つユーザーのみ利用可能です。
topic_id整数いいえトピックIDで指定された、割り当てられたトピックを含むプロジェクトに結果を制限します。
topic文字列いいえカンマ区切りのトピック名。指定されたすべてのトピックに一致するプロジェクトに結果を制限します。topics属性を参照してください。
updated_after日時いいえ指定された時刻以降に最終更新が行われたプロジェクトに結果を制限します。形式: ISO 8601（YYYY-MM-DDTHH:MM:SSZ）。GitLab 15.10で導入されました。このフィルターを機能させるには、updated_atをorder_by属性として指定する必要もあります。
updated_before日時いいえ指定された時刻以前に最終更新が行われたプロジェクトに結果を制限します。形式: ISO 8601（YYYY-MM-DDTHH:MM:SSZ）。GitLab 15.10で導入されました。このフィルターを機能させるには、updated_atをorder_by属性として指定する必要もあります。
visibility文字列いいえ表示レベル（public、internal、private）で制限します。
wiki_checksum_failedブール値いいえWikiチェックサムの計算に失敗したプロジェクトを制限します。PremiumおよびUltimateのみです。
with_custom_attributesブール値いいえ応答にカスタム属性を含めます。（管理者のみ）
with_issues_enabledブール値いいえ有効になっているイシュー機能で制限します。
with_merge_requests_enabledブール値いいえ有効になっているマージリクエスト機能で制限します。
with_programming_language文字列いいえ指定されているプログラミング言語を使用するプロジェクトで制限します。
marked_for_deletion_on日付いいえプロジェクトが削除対象としてマークされた日付でフィルタリングします。GitLab 17.1で導入されました。PremiumおよびUltimateのみです。
activeブール値いいえアーカイブされておらず、削除対象としてマークされていないプロジェクトで制限します。

成功した場合、200 OKと次のレスポンス属性を返します:

属性型説明
id整数プロジェクトのID。
description文字列プロジェクトの説明。
name文字列プロジェクト名。
name_with_namespace文字列ネームスペースを含むプロジェクト名。
path文字列プロジェクトのパス。
path_with_namespace文字列ネームスペースを含むプロジェクトのパス。
created_at日時プロジェクトが作成された日時。
default_branch文字列プロジェクトのデフォルトブランチ。
tag_list文字列の配列非推奨。代わりにtopicsを使用してください。プロジェクトのタグのリスト。
topics文字列の配列プロジェクトのトピックのリスト。
ssh_url_to_repo文字列リポジトリをクローンするためのSSH URL。
http_url_to_repo文字列リポジトリをクローンするためのHTTP URL。
web_url文字列ブラウザでプロジェクトにアクセスするためのURL。
readme_url文字列プロジェクトのReadmeファイルへのURL。
forks_count整数プロジェクトのフォーク数。
avatar_url文字列プロジェクトのアバター画像へのURL。
star_count整数プロジェクトが受け取ったスターの数。
last_activity_at日時プロジェクトの最終アクティビティのタイムスタンプ。
visibility文字列プロジェクトの表示レベル。設定可能な値: private、internal、またはpublic。
namespaceオブジェクトプロジェクトのネームスペース情報。
namespace.id整数ネームスペースのID。
namespace.name文字列ネームスペースの名前。
namespace.path文字列ネームスペースのパス。
namespace.kind文字列ネームスペースの種類。設定可能な値: userまたはgroup。
namespace.full_path文字列ネームスペースのフルパス。
namespace.parent_id整数該当する場合、親ネームスペースのID。
namespace.avatar_url文字列ネームスペースのアバター画像へのURL。
namespace.web_url文字列ブラウザでネームスペースにアクセスするためのURL。
container_registry_image_prefix文字列コンテナレジストリイメージのプレフィックス。
_linksオブジェクトプロジェクトに関連するAPIエンドポイントリンクのコレクション。
_links.self文字列プロジェクトリソースへのURL。
_links.issues文字列プロジェクトのイシューへのURL。
_links.merge_requests文字列プロジェクトのマージリクエストへのURL。
_links.repo_branches文字列プロジェクトのリポジトリのブランチへのURL。
_links.labels文字列プロジェクトのラベルへのURL。
_links.events文字列プロジェクトのイベントへのURL。
_links.members文字列プロジェクトのメンバーへのURL。
_links.cluster_agents文字列プロジェクトのクラスターエージェントへのURL。
marked_for_deletion_at日付非推奨。代わりにmarked_for_deletion_onを使用してください。プロジェクトの削除予定日。
marked_for_deletion_on日付プロジェクトの削除予定日。
packages_enabledブール値プロジェクトでパッケージレジストリが有効になっているかどうか。
empty_repoブール値リポジトリが空であるかどうか。
archivedブール値プロジェクトがアーカイブされているかどうか。
resolve_outdated_diff_discussionsブール値最新ではない差分ディスカッションが自動的に解決されるかどうか。
container_expiration_policyオブジェクトコンテナイメージのポリシーの有効期限に関する設定。
container_expiration_policy.cadence文字列コンテナの有効期限ポリシーが実行される頻度。
container_expiration_policy.enabledブール値コンテナの有効期限ポリシーが有効になっているかどうか。
container_expiration_policy.keep_n整数保持するコンテナイメージの数。
container_expiration_policy.older_than文字列この値よりも古いコンテナイメージを削除します。
container_expiration_policy.name_regex文字列非推奨。代わりにname_regex_deleteを使用してください。コンテナイメージ名に一致する正規表現。
container_expiration_policy.name_regex_keep文字列保持するコンテナイメージ名に一致する正規表現。
container_expiration_policy.next_run_at日時次回のポリシー実行予定時刻のタイムスタンプ。
repository_object_format文字列リポジトリで使用されるオブジェクト形式（sha1またはsha256）。
issues_enabledブール値プロジェクトでイシューが有効になっているかどうか。
merge_requests_enabledブール値プロジェクトでマージリクエストが有効になっているかどうか。
wiki_enabledブール値プロジェクトでWikiが有効になっているかどうか。
jobs_enabledブール値プロジェクトでジョブが有効になっているかどうか。
snippets_enabledブール値プロジェクトでスニペットが有効になっているかどうか。
container_registry_enabledブール値非推奨。代わりにcontainer_registry_access_levelを使用してください。コンテナレジストリが有効になっているかどうか。
service_desk_enabledブール値プロジェクトでサービスデスクが有効になっているかどうか。
can_create_merge_request_inブール値現在のユーザーがプロジェクトでマージリクエストを作成できるかどうか。
issues_access_level文字列イシュー機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
repository_access_level文字列リポジトリ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
merge_requests_access_level文字列マージリクエスト機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
forking_access_level文字列プロジェクトをフォークするためのアクセスレベル。設定可能な値: disabled、private、またはenabled。
wiki_access_level文字列Wiki機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
builds_access_level文字列CI/CDビルド機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
snippets_access_level文字列スニペット機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
pages_access_level文字列GitLab Pagesのアクセスレベル。設定可能な値: disabled、private、enabled、またはpublic。
analytics_access_level文字列分析機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
container_registry_access_level文字列コンテナレジストリのアクセスレベル。設定可能な値: disabled、private、またはenabled。
security_and_compliance_access_level文字列セキュリティおよびコンプライアンス機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
releases_access_level文字列リリース機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
environments_access_level文字列環境機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
feature_flags_access_level文字列機能フラグ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
infrastructure_access_level文字列インフラストラクチャ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
monitor_access_level文字列監視機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
model_experiments_access_level文字列モデル実験機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
model_registry_access_level文字列モデルレジストリ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
package_registry_access_level文字列パッケージレジストリ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
emails_disabledブール値プロジェクトのメールが無効になっているかどうかを示します。
emails_enabledブール値プロジェクトのメールが有効になっているかどうかを示します。
show_diff_preview_in_emailブール値メール通知で差分プレビューが表示されるかどうかを示します。
shared_runners_enabledブール値プロジェクトで共有Runnerが有効になっているかどうか。
lfs_enabledブール値プロジェクトでGit LFSが有効になっているかどうかを示します。
creator_id整数プロジェクトを作成したユーザーのID。
import_status文字列プロジェクトインポートのステータス。
open_issues_count整数未解決のイシューの数。
description_html文字列HTML形式でのプロジェクトの説明。
updated_at日時プロジェクトが最後に更新された日時。
ci_config_path文字列CI/CD設定ファイルへのパス。
public_jobsブール値ジョブログが公開アクセス可能かどうか。
shared_with_groupsオブジェクトの配列プロジェクトが共有されているグループのリスト。
only_allow_merge_if_pipeline_succeedsブール値パイプラインが成功した場合にのみマージが許可されるかどうか。
allow_merge_on_skipped_pipelineブール値パイプラインがスキップされた場合にマージが許可されるかどうか。
request_access_enabledブール値ユーザーがプロジェクトへのアクセスをリクエストできるかどうか。
only_allow_merge_if_all_discussions_are_resolvedブール値すべてのディスカッションが解決される場合にのみマージが許可されるかどうか。
remove_source_branch_after_mergeブール値マージ後にソースブランチが自動的に削除されるかどうか。
printing_merge_request_link_enabledブール値プッシュ後にマージリクエストのリンクが出力されるかどうかを示します。
merge_method文字列プロジェクトに使用されるマージメソッド。設定可能な値: merge、rebase_merge、またはff。
merge_request_title_regex文字列マージリクエストのタイトルを検証するための正規表現パターン。
merge_request_title_regex_description文字列マージリクエストのタイトル正規表現の検証の説明。
squash_option文字列マージリクエストのスカッシュオプション。
enforce_auth_checks_on_uploadsブール値アップロード時に認証チェックが強制されるかどうか。
suggestion_commit_message文字列提案のカスタムコミットメッセージ。
merge_commit_template文字列マージコミットメッセージのテンプレート。
squash_commit_template文字列スカッシュコミットメッセージのテンプレート。
issue_branch_template文字列イシューから作成されたブランチ名のテンプレート。
warn_about_potentially_unwanted_charactersブール値潜在的に不要な文字の使用について警告するかどうか。
autoclose_referenced_issuesブール値参照されたイシューが自動的に閉じられるかどうか。
max_artifacts_size整数CI/CDアーティファクトの最大サイズ（MB）。
approvals_before_merge整数非推奨。代わりにマージリクエスト承認APIを使用してください。マージ前に必要な承認の数。
mirrorブール値プロジェクトがミラーであるかどうか。
external_authorization_classification_label文字列外部認可分類ラベル。
requirements_enabledブール値要件管理が有効になっているかどうかを示します。
requirements_access_level文字列要件機能のアクセスレベル。
security_and_compliance_enabledブール値セキュリティおよびコンプライアンス機能が有効になっているかどうかを示します。
compliance_frameworks文字列の配列プロジェクトに適用されるコンプライアンスフレームワーク。
issues_template文字列イシューのデフォルトの説明。説明は、GitLab Flavored Markdownを使用して解析されます。PremiumおよびUltimateのみです。
merge_requests_template文字列マージリクエストの説明のテンプレート。PremiumおよびUltimateのみです。
merge_pipelines_enabledブール値マージパイプラインが有効になっているかどうかを示します。
merge_trains_enabledブール値マージトレインが有効になっているかどうかを示します。
merge_trains_skip_train_allowedブール値マージトレインのスキップが許可されているかどうかを示します。
only_allow_merge_if_all_status_checks_passedブール値すべてのステータスチェックが合格した場合にのみマージが許可されるかどうか。Ultimateのみです。
allow_pipeline_trigger_approve_deploymentブール値パイプライントリガーがデプロイを承認できるかどうか。
prevent_merge_without_jira_issueブール値マージに、関連付けられたJiraイシューが必要かどうかを示します。
duo_remote_flows_enabledブール値GitLab Duoのリモートフローが有効になっているかどうかを示します。
duo_foundational_flows_enabledブール値GitLab Duoの基本フローが有効になっているかどうかを示します。
duo_sast_fp_detection_enabledブール値GitLab Duo SASTの誤検出判定が有効になっているかどうかを示します。
spp_repository_pipeline_accessブール値セキュリティポリシーのリポジトリパイプラインアクセス。セキュリティオーケストレーションポリシー機能が利用可能な場合にのみ表示されます。
permissionsオブジェクトプロジェクトのユーザー権限。
permissions.project_accessオブジェクトユーザーのプロジェクトアクセス権限。
permissions.group_accessオブジェクトユーザーのグループアクセス権限。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/projects

レスポンス例:

[
  {
    "id": 4,
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
    "description_html": "<p data-sourcepos=\"1:1-1:56\" dir=\"auto\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
    "name": "Diaspora Client",
    "name_with_namespace": "Diaspora / Diaspora Client",
    "path": "diaspora-client",
    "path_with_namespace": "diaspora/diaspora-client",
    "created_at": "2013-09-30T13:46:02Z",
    "updated_at": "2013-09-30T13:46:02Z",
    "default_branch": "main",
    "tag_list": [ //deprecated, use `topics` instead
      "example",
      "disapora client"
    ],
    "topics": [
      "example",
      "disapora client"
    ],
    "ssh_url_to_repo": "git@gitlab.example.com:diaspora/diaspora-client.git",
    "http_url_to_repo": "https://gitlab.example.com/diaspora/diaspora-client.git",
    "web_url": "https://gitlab.example.com/diaspora/diaspora-client",
    "readme_url": "https://gitlab.example.com/diaspora/diaspora-client/blob/main/README.md",
    "avatar_url": "https://gitlab.example.com/uploads/project/avatar/4/uploads/avatar.png",
    "forks_count": 0,
    "star_count": 0,
    "last_activity_at": "2022-06-24T17:11:26.841Z",
    "namespace": {
      "id": 3,
      "name": "Diaspora",
      "path": "diaspora",
      "kind": "group",
      "full_path": "diaspora",
      "parent_id": null,
      "avatar_url": "https://gitlab.example.com/uploads/project/avatar/6/uploads/avatar.png",
      "web_url": "https://gitlab.example.com/diaspora"
    },
    "container_registry_image_prefix": "registry.gitlab.example.com/diaspora/diaspora-client",
    "_links": {
      "self": "https://gitlab.example.com/api/v4/projects/4",
      "issues": "https://gitlab.example.com/api/v4/projects/4/issues",
      "merge_requests": "https://gitlab.example.com/api/v4/projects/4/merge_requests",
      "repo_branches": "https://gitlab.example.com/api/v4/projects/4/repository/branches",
      "labels": "https://gitlab.example.com/api/v4/projects/4/labels",
      "events": "https://gitlab.example.com/api/v4/projects/4/events",
      "members": "https://gitlab.example.com/api/v4/projects/4/members",
      "cluster_agents": "https://gitlab.example.com/api/v4/projects/4/cluster_agents"
    },
    "packages_enabled": true, // deprecated, use package_registry_access_level instead
    "package_registry_access_level": "enabled",
    "empty_repo": false,
    "archived": false,
    "visibility": "public",
    "resolve_outdated_diff_discussions": false,
    "container_expiration_policy": {
      "cadence": "1month",
      "enabled": true,
      "keep_n": 1,
      "older_than": "14d",
      "name_regex": "",
      "name_regex_keep": ".*-main",
      "next_run_at": "2022-06-25T17:11:26.865Z"
    },
    "issues_enabled": true,
    "merge_requests_enabled": true,
    "wiki_enabled": true,
    "jobs_enabled": true,
    "snippets_enabled": true,
    "container_registry_enabled": true,
    "service_desk_enabled": true,
    "can_create_merge_request_in": true,
    "issues_access_level": "enabled",
    "repository_access_level": "enabled",
    "merge_requests_access_level": "enabled",
    "forking_access_level": "enabled",
    "wiki_access_level": "enabled",
    "builds_access_level": "enabled",
    "snippets_access_level": "enabled",
    "pages_access_level": "enabled",
    "analytics_access_level": "enabled",
    "container_registry_access_level": "enabled",
    "security_and_compliance_access_level": "private",
    "emails_disabled": null,
    "emails_enabled": null,
    "shared_runners_enabled": true,
    "group_runners_enabled": true,
    "lfs_enabled": true,
    "creator_id": 1,
    "import_url": null,
    "import_type": null,
    "import_status": "none",
    "import_error": null,
    "open_issues_count": 0,
    "ci_default_git_depth": 20,
    "ci_forward_deployment_enabled": true,
    "ci_forward_deployment_rollback_allowed": true,
    "ci_allow_fork_pipelines_to_run_in_parent_project": true,
    "ci_id_token_sub_claim_components": ["project_path", "ref_type", "ref"],
    "ci_job_token_scope_enabled": false,
    "ci_separated_caches": true,
    "ci_restrict_pipeline_cancellation_role": "developer",
    "ci_pipeline_variables_minimum_override_role": "maintainer",
    "ci_push_repository_for_job_token_allowed": false,
    "ci_display_pipeline_variables": false,
    "protect_merge_request_pipelines": true,
    "public_jobs": true,
    "build_timeout": 3600,
    "auto_cancel_pending_pipelines": "enabled",
    "ci_config_path": "",
    "shared_with_groups": [],
    "only_allow_merge_if_pipeline_succeeds": false,
    "allow_merge_on_skipped_pipeline": null,
    "allow_pipeline_trigger_approve_deployment": false,
    "restrict_user_defined_variables": false,
    "request_access_enabled": true,
    "only_allow_merge_if_all_discussions_are_resolved": false,
    "remove_source_branch_after_merge": true,
    "printing_merge_request_link_enabled": true,
    "merge_method": "merge",
    "squash_option": "default_off",
    "enforce_auth_checks_on_uploads": true,
    "suggestion_commit_message": null,
    "merge_commit_template": null,
    "squash_commit_template": null,
    "issue_branch_template": "gitlab/%{id}-%{title}",
    "auto_devops_enabled": false,
    "auto_devops_deploy_strategy": "continuous",
    "autoclose_referenced_issues": true,
    "keep_latest_artifact": true,
    "runner_token_expiration_interval": null,
    "external_authorization_classification_label": "",
    "requirements_enabled": false,
    "requirements_access_level": "enabled",
    "security_and_compliance_enabled": false,
    "secret_push_protection_enabled": false,
    "compliance_frameworks": [],
    "warn_about_potentially_unwanted_characters": true,
    "permissions": {
      "project_access": null,
      "group_access": null
    }
  },
  {
    ...
  }
]

ユーザーのすべての個人プロジェクトをリスト表示

指定されたユーザーのすべての個人プロジェクトをリスト表示します。次の制限が適用されます。

  • ユーザーの個人ネームスペース内のプロジェクトのみを返し、グループまたはサブグループプロジェクトは返しません。
  • ユーザープロファイルがプライベートの場合、空のリストを返します。
  • 未認証のリクエストは、公開プロジェクトのみを返します。

このエンドポイントはページネーションをサポートしています:

  • オフセットベースのページネーションを使用して、最大50,000のプロジェクトにアクセスします。
  • キーセットベースのページネーションを使用して、50,000以上のプロジェクトをリスト表示します。

詳細については、ページネーションを参照してください。

GET /users/:user_id/projects

サポートされている属性は以下のとおりです:

属性型必須説明
user_id文字列はいユーザーのIDまたはユーザー名。
archivedブール値いいえアーカイブステータスで制限します。
id_after整数いいえ指定されたIDより大きいIDを持つプロジェクトに結果を制限します。
id_before整数いいえ指定されたIDより小さいIDを持つプロジェクトに結果を制限します。
membershipブール値いいえ現在のユーザーがメンバーであるプロジェクトで制限します。
min_access_level整数いいえ現在のユーザーが指定されたアクセスレベル以上を持つプロジェクトに限定します。使用可能な値: 5 (最小アクセス)、10 (ゲスト)、15 (プランナー)、20 (レポーター)、30 (デベロッパー)、40 (メンテナー)、または50 (オーナー)。
order_by文字列いいえid、name、path、created_at、updated_at、star_count、またはlast_activity_atのフィールドで並べ替えられたプロジェクトを返します。デフォルトはcreated_atです。
ownedブール値いいえ現在のユーザーが明示的に所有するプロジェクトで制限します。
search文字列いいえ検索条件に一致するプロジェクトのリストを返します。
simpleブール値いいえtrueの場合、各プロジェクトの限られたフィールドのみを返します。simpleが設定されていない場合でも、未認証のリクエストは、限られたフィールドを持つ公開プロジェクトのみを返します。
sort文字列いいえascまたはdescの順にソートされたプロジェクトを返します。デフォルトはdescです。
starredブール値いいえ現在のユーザーがStar付きに登録したプロジェクトで制限します。
statisticsブール値いいえプロジェクトの統計を含めます。レポーター、デベロッパー、メンテナー、またはオーナーのロールを持つユーザーのみ利用可能です。
updated_after日時いいえ指定された時刻以降に最終更新が行われたプロジェクトに結果を制限します。形式: ISO 8601（YYYY-MM-DDTHH:MM:SSZ）。
updated_before日時いいえ指定された時刻以前に最終更新が行われたプロジェクトに結果を制限します。形式: ISO 8601（YYYY-MM-DDTHH:MM:SSZ）。
visibility文字列いいえ表示レベルで制限します。設定可能な値: public、internal、またはprivate。
with_custom_attributesブール値いいえ応答にカスタム属性を含めます。管理者アクセス権が必要です。
with_issues_enabledブール値いいえ有効になっているイシュー機能で制限します。
with_merge_requests_enabledブール値いいえ有効になっているマージリクエスト機能で制限します。
with_programming_language文字列いいえ指定されているプログラミング言語を使用するプロジェクトで制限します。

成功した場合、200 OKと次のレスポンス属性を返します:

属性型説明
id整数プロジェクトのID。
description文字列プロジェクトの説明。
name文字列プロジェクト名。
name_with_namespace文字列ネームスペースを含むプロジェクト名。
path文字列プロジェクトのパス。
path_with_namespace文字列ネームスペースを含むプロジェクトのパス。
created_at日時プロジェクトが作成された日時。
default_branch文字列プロジェクトのデフォルトブランチ。
tag_list文字列の配列非推奨。代わりにtopicsを使用してください。プロジェクトのタグのリスト。
topics文字列の配列プロジェクトのトピックのリスト。
ssh_url_to_repo文字列リポジトリをクローンするためのSSH URL。
http_url_to_repo文字列リポジトリをクローンするためのHTTP URL。
web_url文字列ブラウザでプロジェクトにアクセスするためのURL。
readme_url文字列プロジェクトのReadmeファイルへのURL。
forks_count整数プロジェクトのフォーク数。
avatar_url文字列プロジェクトのアバター画像へのURL。
star_count整数プロジェクトが受け取ったスターの数。
last_activity_at日時プロジェクトの最終アクティビティのタイムスタンプ。
visibility文字列プロジェクトの表示レベル。設定可能な値: private、internal、またはpublic。
namespaceオブジェクトプロジェクトのネームスペース情報。
namespace.id整数ネームスペースのID。
namespace.name文字列ネームスペースの名前。
namespace.path文字列ネームスペースのパス。
namespace.kind文字列ネームスペースの種類。設定可能な値: userまたはgroup。
namespace.full_path文字列ネームスペースのフルパス。
namespace.parent_id整数該当する場合、親ネームスペースのID。
namespace.avatar_url文字列ネームスペースのアバター画像へのURL。
namespace.web_url文字列ブラウザでネームスペースにアクセスするためのURL。
container_registry_image_prefix文字列コンテナレジストリイメージのプレフィックス。
_linksオブジェクトプロジェクトに関連するAPIエンドポイントリンクのコレクション。
_links.self文字列プロジェクトリソースへのURL。
_links.issues文字列プロジェクトのイシューへのURL。
_links.merge_requests文字列プロジェクトのマージリクエストへのURL。
_links.repo_branches文字列プロジェクトのリポジトリのブランチへのURL。
_links.labels文字列プロジェクトのラベルへのURL。
_links.events文字列プロジェクトのイベントへのURL。
_links.members文字列プロジェクトのメンバーへのURL。
_links.cluster_agents文字列プロジェクトのクラスターエージェントへのURL。
marked_for_deletion_at日付非推奨。代わりにmarked_for_deletion_onを使用してください。プロジェクトの削除予定日。
marked_for_deletion_on日付プロジェクトの削除予定日。
packages_enabledブール値プロジェクトでパッケージレジストリが有効になっているかどうか。
empty_repoブール値リポジトリが空であるかどうか。
archivedブール値プロジェクトがアーカイブされているかどうか。
resolve_outdated_diff_discussionsブール値最新ではない差分ディスカッションが自動的に解決されるかどうか。
container_expiration_policyオブジェクトコンテナイメージのポリシーの有効期限に関する設定。
container_expiration_policy.cadence文字列コンテナの有効期限ポリシーが実行される頻度。
container_expiration_policy.enabledブール値コンテナの有効期限ポリシーが有効になっているかどうか。
container_expiration_policy.keep_n整数保持するコンテナイメージの数。
container_expiration_policy.older_than文字列この値よりも古いコンテナイメージを削除します。
container_expiration_policy.name_regex文字列非推奨。代わりにname_regex_deleteを使用してください。コンテナイメージ名に一致する正規表現。
container_expiration_policy.name_regex_keep文字列保持するコンテナイメージ名に一致する正規表現。
container_expiration_policy.next_run_at日時次回のポリシー実行予定時刻のタイムスタンプ。
repository_object_format文字列リポジトリで使用されるオブジェクト形式（sha1またはsha256）。
issues_enabledブール値プロジェクトでイシューが有効になっているかどうか。
merge_requests_enabledブール値プロジェクトでマージリクエストが有効になっているかどうか。
wiki_enabledブール値プロジェクトでWikiが有効になっているかどうか。
jobs_enabledブール値プロジェクトでジョブが有効になっているかどうか。
snippets_enabledブール値プロジェクトでスニペットが有効になっているかどうか。
container_registry_enabledブール値非推奨。代わりにcontainer_registry_access_levelを使用してください。コンテナレジストリが有効になっているかどうか。
service_desk_enabledブール値プロジェクトでサービスデスクが有効になっているかどうか。
can_create_merge_request_inブール値現在のユーザーがプロジェクトでマージリクエストを作成できるかどうか。
issues_access_level文字列イシュー機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
repository_access_level文字列リポジトリ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
merge_requests_access_level文字列マージリクエスト機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
forking_access_level文字列プロジェクトをフォークするためのアクセスレベル。設定可能な値: disabled、private、またはenabled。
wiki_access_level文字列Wiki機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
builds_access_level文字列CI/CDビルド機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
snippets_access_level文字列スニペット機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
pages_access_level文字列GitLab Pagesのアクセスレベル。設定可能な値: disabled、private、enabled、またはpublic。
analytics_access_level文字列分析機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
container_registry_access_level文字列コンテナレジストリのアクセスレベル。設定可能な値: disabled、private、またはenabled。
security_and_compliance_access_level文字列セキュリティおよびコンプライアンス機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
releases_access_level文字列リリース機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
environments_access_level文字列環境機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
feature_flags_access_level文字列機能フラグ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
infrastructure_access_level文字列インフラストラクチャ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
monitor_access_level文字列監視機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
model_experiments_access_level文字列モデル実験機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
model_registry_access_level文字列モデルレジストリ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
package_registry_access_level文字列パッケージレジストリ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
emails_disabledブール値プロジェクトのメールが無効になっているかどうかを示します。
emails_enabledブール値プロジェクトのメールが有効になっているかどうかを示します。
show_diff_preview_in_emailブール値メール通知で差分プレビューが表示されるかどうかを示します。
shared_runners_enabledブール値プロジェクトで共有Runnerが有効になっているかどうか。
lfs_enabledブール値プロジェクトでGit LFSが有効になっているかどうかを示します。
creator_id整数プロジェクトを作成したユーザーのID。
import_status文字列プロジェクトインポートのステータス。
open_issues_count整数未解決のイシューの数。
description_html文字列HTML形式でのプロジェクトの説明。
updated_at日時プロジェクトが最後に更新された日時。
ci_default_git_depth整数CI/CDパイプラインのデフォルトのGit深度。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
ci_forward_deployment_enabledブール値フォワードデプロイが有効になっているかどうか。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
ci_job_token_scope_enabledブール値CI/CDジョブトークンスコープが有効になっているかどうかを示します。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
ci_separated_cachesブール値CI/CDキャッシュがブランチごとに分離されているかどうか。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
ci_allow_fork_pipelines_to_run_in_parent_projectブール値フォークパイプラインが親プロジェクトで実行できるかどうか。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
build_git_strategy文字列CI/CDのビルドに使用されるGit戦略（フェッチまたはクローン）。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
keep_latest_artifactブール値新しいアーティファクトが作成されたときに、最新のアーティファクトが保持されるかどうかを示します。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
restrict_user_defined_variablesブール値ユーザー定義の変数が制限されているかどうか。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
runners_token文字列プロジェクトにRunnerを登録するためのトークン。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
runner_token_expiration_interval整数Runnerトークンの有効期限間隔（秒単位）。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
group_runners_enabledブール値プロジェクトでグループRunnerが有効になっているかどうか。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
auto_cancel_pending_pipelines文字列保留中のパイプラインを自動的にキャンセルするための設定。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
build_timeout整数CI/CDジョブのタイムアウト（秒単位）。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
auto_devops_enabledブール値プロジェクトでAuto DevOpsが有効になっているかどうか。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
auto_devops_deploy_strategy文字列Auto DevOpsのデプロイ戦略。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
ci_config_path文字列CI/CD設定ファイルへのパス。
public_jobsブール値ジョブログが公開アクセス可能かどうか。
shared_with_groupsオブジェクトの配列プロジェクトが共有されているグループのリスト。
only_allow_merge_if_pipeline_succeedsブール値パイプラインが成功した場合にのみマージが許可されるかどうか。
allow_merge_on_skipped_pipelineブール値パイプラインがスキップされた場合にマージが許可されるかどうか。
request_access_enabledブール値ユーザーがプロジェクトへのアクセスをリクエストできるかどうか。
only_allow_merge_if_all_discussions_are_resolvedブール値すべてのディスカッションが解決される場合にのみマージが許可されるかどうか。
remove_source_branch_after_mergeブール値マージ後にソースブランチが自動的に削除されるかどうか。
printing_merge_request_link_enabledブール値プッシュ後にマージリクエストのリンクが出力されるかどうかを示します。
merge_method文字列プロジェクトに使用されるマージメソッド。設定可能な値: merge、rebase_merge、またはff。
merge_request_title_regex文字列マージリクエストのタイトルを検証するための正規表現パターン。
merge_request_title_regex_description文字列マージリクエストのタイトル正規表現の検証の説明。
squash_option文字列マージリクエストのスカッシュオプション。
enforce_auth_checks_on_uploadsブール値アップロード時に認証チェックが強制されるかどうか。
suggestion_commit_message文字列提案のカスタムコミットメッセージ。
merge_commit_template文字列マージコミットメッセージのテンプレート。
squash_commit_template文字列スカッシュコミットメッセージのテンプレート。
issue_branch_template文字列イシューから作成されたブランチ名のテンプレート。
warn_about_potentially_unwanted_charactersブール値潜在的に不要な文字の使用について警告するかどうか。
autoclose_referenced_issuesブール値参照されたイシューが自動的に閉じられるかどうか。
max_artifacts_size整数CI/CDアーティファクトの最大サイズ（MB）。
approvals_before_merge整数非推奨。代わりにマージリクエスト承認APIを使用してください。マージ前に必要な承認の数。
mirrorブール値プロジェクトがミラーであるかどうか。
external_authorization_classification_label文字列外部認可分類ラベル。
requirements_enabledブール値要件管理が有効になっているかどうかを示します。
requirements_access_level文字列要件機能のアクセスレベル。
security_and_compliance_enabledブール値セキュリティおよびコンプライアンス機能が有効になっているかどうかを示します。
compliance_frameworks文字列の配列プロジェクトに適用されるコンプライアンスフレームワーク。
issues_template文字列イシューのデフォルトの説明。説明は、GitLab Flavored Markdownを使用して解析されます。PremiumおよびUltimateのみです。
merge_requests_template文字列マージリクエストの説明のテンプレート。PremiumおよびUltimateのみです。
merge_pipelines_enabledブール値マージパイプラインが有効になっているかどうかを示します。
merge_trains_enabledブール値マージトレインが有効になっているかどうかを示します。
merge_trains_skip_train_allowedブール値マージトレインのスキップが許可されているかどうかを示します。
only_allow_merge_if_all_status_checks_passedブール値すべてのステータスチェックが合格した場合にのみマージが許可されるかどうか。Ultimateのみです。
allow_pipeline_trigger_approve_deploymentブール値パイプライントリガーがデプロイを承認できるかどうか。
prevent_merge_without_jira_issueブール値マージに、関連付けられたJiraイシューが必要かどうかを示します。
duo_remote_flows_enabledブール値GitLab Duoのリモートフローが有効になっているかどうかを示します。
duo_foundational_flows_enabledブール値GitLab Duoの基本フローが有効になっているかどうかを示します。
duo_sast_fp_detection_enabledブール値GitLab Duo SASTの誤検出判定が有効になっているかどうかを示します。
spp_repository_pipeline_accessブール値セキュリティポリシーのリポジトリパイプラインアクセス。セキュリティオーケストレーションポリシー機能が利用可能な場合にのみ表示されます。
permissionsオブジェクトプロジェクトのユーザー権限。
permissions.project_accessオブジェクトユーザーのプロジェクトアクセス権限。
permissions.group_accessオブジェクトユーザーのグループアクセス権限。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Accept: application/json" \
     --url "https://gitlab.example.com/api/v4/users/:user_id/projects

レスポンス例:

[
  {
    "id": 4,
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
    "description_html": "<p data-sourcepos=\"1:1-1:56\" dir=\"auto\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
    "default_branch": "main",
    "visibility": "private",
    "ssh_url_to_repo": "git@example.com:diaspora/diaspora-client.git",
    "http_url_to_repo": "http://example.com/diaspora/diaspora-client.git",
    "web_url": "http://example.com/diaspora/diaspora-client",
    "readme_url": "http://example.com/diaspora/diaspora-client/blob/main/README.md",
    "tag_list": [ //deprecated, use `topics` instead
      "example",
      "disapora client"
    ],
    "topics": [
      "example",
      "disapora client"
    ],
    "owner": {
      "id": 3,
      "name": "Diaspora",
      "created_at": "2013-09-30T13:46:02Z"
    },
    "name": "Diaspora Client",
    "name_with_namespace": "Diaspora / Diaspora Client",
    "path": "diaspora-client",
    "path_with_namespace": "diaspora/diaspora-client",
    "issues_enabled": true,
    "open_issues_count": 1,
    "merge_requests_enabled": true,
    "jobs_enabled": true,
    "wiki_enabled": true,
    "snippets_enabled": false,
    "can_create_merge_request_in": true,
    "resolve_outdated_diff_discussions": false,
    "container_registry_enabled": false, // deprecated, use container_registry_access_level instead
    "container_registry_access_level": "disabled",
    "security_and_compliance_access_level": "disabled",
    "created_at": "2013-09-30T13:46:02Z",
    "updated_at": "2013-09-30T13:46:02Z",
    "last_activity_at": "2013-09-30T13:46:02Z",
    "creator_id": 3,
    "import_url": null,
    "import_type": null,
    "import_status": "none",
    "import_error": null,
    "namespace": {
      "id": 3,
      "name": "Diaspora",
      "path": "diaspora",
      "kind": "group",
      "full_path": "diaspora"
    },
    "import_status": "none",
    "archived": false,
    "avatar_url": "http://example.com/uploads/project/avatar/4/uploads/avatar.png",
    "shared_runners_enabled": true,
    "group_runners_enabled": true,
    "forks_count": 0,
    "star_count": 0,
    "runners_token": "b8547b1dc37721d05889db52fa2f02",
    "ci_default_git_depth": 50,
    "ci_forward_deployment_enabled": true,
    "ci_forward_deployment_rollback_allowed": true,
    "ci_allow_fork_pipelines_to_run_in_parent_project": true,
    "ci_id_token_sub_claim_components": ["project_path", "ref_type", "ref"],
    "ci_separated_caches": true,
    "ci_restrict_pipeline_cancellation_role": "developer",
    "ci_pipeline_variables_minimum_override_role": "maintainer",
    "ci_push_repository_for_job_token_allowed": false,
    "ci_display_pipeline_variables": false,
    "protect_merge_request_pipelines": true,
    "public_jobs": true,
    "shared_with_groups": [],
    "only_allow_merge_if_pipeline_succeeds": false,
    "allow_merge_on_skipped_pipeline": false,
    "allow_pipeline_trigger_approve_deployment": false,
    "restrict_user_defined_variables": false,
    "only_allow_merge_if_all_discussions_are_resolved": false,
    "remove_source_branch_after_merge": false,
    "request_access_enabled": false,
    "merge_method": "merge",
    "squash_option": "default_on",
    "autoclose_referenced_issues": true,
    "enforce_auth_checks_on_uploads": true,
    "suggestion_commit_message": null,
    "merge_commit_template": null,
    "squash_commit_template": null,
    "secret_push_protection_enabled": false,
    "issue_branch_template": "gitlab/%{id}-%{title}",
    "marked_for_deletion_at": "2020-04-03", // Deprecated in favor of marked_for_deletion_on. Planned for removal in a future version of the REST API.
    "marked_for_deletion_on": "2020-04-03",
    "statistics": {
      "commit_count": 37,
      "storage_size": 1038090,
      "repository_size": 1038090,
      "wiki_size" : 0,
      "lfs_objects_size": 0,
      "job_artifacts_size": 0,
      "pipeline_artifacts_size": 0,
      "packages_size": 0,
      "snippets_size": 0,
      "uploads_size": 0,
      "container_registry_size": 0
    },
    "container_registry_image_prefix": "registry.example.com/diaspora/diaspora-client",
    "_links": {
      "self": "http://example.com/api/v4/projects",
      "issues": "http://example.com/api/v4/projects/1/issues",
      "merge_requests": "http://example.com/api/v4/projects/1/merge_requests",
      "repo_branches": "http://example.com/api/v4/projects/1/repository_branches",
      "labels": "http://example.com/api/v4/projects/1/labels",
      "events": "http://example.com/api/v4/projects/1/events",
      "members": "http://example.com/api/v4/projects/1/members",
      "cluster_agents": "http://example.com/api/v4/projects/1/cluster_agents"
    }
  },
  {
    "id": 6,
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
    "description_html": "<p data-sourcepos=\"1:1-1:56\" dir=\"auto\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
    "default_branch": "main",
    "visibility": "private",
    "ssh_url_to_repo": "git@example.com:brightbox/puppet.git",
    "http_url_to_repo": "http://example.com/brightbox/puppet.git",
    "web_url": "http://example.com/brightbox/puppet",
    "readme_url": "http://example.com/brightbox/puppet/blob/main/README.md",
    "tag_list": [ //deprecated, use `topics` instead
      "example",
      "puppet"
    ],
    "topics": [
      "example",
      "puppet"
    ],
    "owner": {
      "id": 4,
      "name": "Brightbox",
      "created_at": "2013-09-30T13:46:02Z"
    },
    "name": "Puppet",
    "name_with_namespace": "Brightbox / Puppet",
    "path": "puppet",
    "path_with_namespace": "brightbox/puppet",
    "issues_enabled": true,
    "open_issues_count": 1,
    "merge_requests_enabled": true,
    "jobs_enabled": true,
    "wiki_enabled": true,
    "snippets_enabled": false,
    "can_create_merge_request_in": true,
    "resolve_outdated_diff_discussions": false,
    "container_registry_enabled": false, // deprecated, use container_registry_access_level instead
    "container_registry_access_level": "disabled",
    "security_and_compliance_access_level": "disabled",
    "created_at": "2013-09-30T13:46:02Z",
    "updated_at": "2013-09-30T13:46:02Z",
    "last_activity_at": "2013-09-30T13:46:02Z",
    "creator_id": 3,
    "import_url": null,
    "import_type": null,
    "import_status": "none",
    "import_error": null,
    "namespace": {
      "id": 4,
      "name": "Brightbox",
      "path": "brightbox",
      "kind": "group",
      "full_path": "brightbox"
    },
    "import_status": "none",
    "import_error": null,
    "permissions": {
      "project_access": {
        "access_level": 10,
        "notification_level": 3
      },
      "group_access": {
        "access_level": 50,
        "notification_level": 3
      }
    },
    "archived": false,
    "avatar_url": null,
    "shared_runners_enabled": true,
    "group_runners_enabled": true,
    "forks_count": 0,
    "star_count": 0,
    "runners_token": "b8547b1dc37721d05889db52fa2f02",
    "ci_default_git_depth": 0,
    "ci_forward_deployment_enabled": true,
    "ci_forward_deployment_rollback_allowed": true,
    "ci_allow_fork_pipelines_to_run_in_parent_project": true,
    "ci_id_token_sub_claim_components": ["project_path", "ref_type", "ref"],
    "ci_separated_caches": true,
    "ci_restrict_pipeline_cancellation_role": "developer",
    "ci_pipeline_variables_minimum_override_role": "maintainer",
    "ci_push_repository_for_job_token_allowed": false,
    "ci_display_pipeline_variables": false,
    "protect_merge_request_pipelines": true,
    "public_jobs": true,
    "shared_with_groups": [],
    "only_allow_merge_if_pipeline_succeeds": false,
    "allow_merge_on_skipped_pipeline": false,
    "allow_pipeline_trigger_approve_deployment": false,
    "restrict_user_defined_variables": false,
    "only_allow_merge_if_all_discussions_are_resolved": false,
    "remove_source_branch_after_merge": false,
    "request_access_enabled": false,
    "merge_method": "merge",
    "squash_option": "default_on",
    "auto_devops_enabled": true,
    "auto_devops_deploy_strategy": "continuous",
    "repository_storage": "default",
    "approvals_before_merge": 0, // Deprecated. Use merge request approvals API instead.
    "mirror": false,
    "mirror_user_id": 45,
    "mirror_trigger_builds": false,
    "only_mirror_protected_branches": false,
    "mirror_overwrites_diverged_branches": false,
    "external_authorization_classification_label": null,
    "packages_enabled": true, // deprecated, use package_registry_access_level instead
    "empty_repo": false,
    "package_registry_access_level": "enabled",
    "service_desk_enabled": false,
    "service_desk_address": null,
    "autoclose_referenced_issues": true,
    "enforce_auth_checks_on_uploads": true,
    "suggestion_commit_message": null,
    "merge_commit_template": null,
    "squash_commit_template": null,
    "secret_push_protection_enabled": false,
    "issue_branch_template": "gitlab/%{id}-%{title}",
    "statistics": {
      "commit_count": 12,
      "storage_size": 2066080,
      "repository_size": 2066080,
      "wiki_size" : 0,
      "lfs_objects_size": 0,
      "job_artifacts_size": 0,
      "pipeline_artifacts_size": 0,
      "packages_size": 0,
      "snippets_size": 0,
      "uploads_size": 0,
      "container_registry_size": 0
    },
    "container_registry_image_prefix": "registry.example.com/brightbox/puppet",
    "_links": {
      "self": "http://example.com/api/v4/projects",
      "issues": "http://example.com/api/v4/projects/1/issues",
      "merge_requests": "http://example.com/api/v4/projects/1/merge_requests",
      "repo_branches": "http://example.com/api/v4/projects/1/repository_branches",
      "labels": "http://example.com/api/v4/projects/1/labels",
      "events": "http://example.com/api/v4/projects/1/events",
      "members": "http://example.com/api/v4/projects/1/members",
      "cluster_agents": "http://example.com/api/v4/projects/1/cluster_agents"
    }
  }
]

ユーザーのすべてのプロジェクトコントリビュートをリスト表示

指定されたユーザーの、表示可能なプロジェクトへのすべてのコントリビュートをリスト表示します。過去1年間のコントリビュートのみを返します。コントリビュートとしてカウントされるものの詳細については、View projects you work withを参照してください。

GET /users/:user_id/contributed_projects

サポートされている属性は以下のとおりです:

属性型必須説明
user_id文字列はいユーザーのIDまたはユーザー名。
order_by文字列いいえid、name、path、created_at、updated_at、star_count、またはlast_activity_atのフィールドで並べ替えられたプロジェクトを返します。デフォルトはcreated_atです。
simpleブール値いいえtrueの場合、各プロジェクトの限られたフィールドのみを返します。simpleが設定されていない場合でも、未認証のリクエストは、限られたフィールドを持つ公開プロジェクトのみを返します。
sort文字列いいえascまたはdescの順にソートされたプロジェクトを返します。デフォルトはdescです。

成功した場合、200 OKと次のレスポンス属性を返します:

属性型説明
id整数プロジェクトのID。
description文字列プロジェクトの説明。
name文字列プロジェクト名。
name_with_namespace文字列ネームスペースを含むプロジェクト名。
path文字列プロジェクトのパス。
path_with_namespace文字列ネームスペースを含むプロジェクトのパス。
created_at日時プロジェクトが作成された日時。
default_branch文字列プロジェクトのデフォルトブランチ。
tag_list文字列の配列非推奨。代わりにtopicsを使用してください。プロジェクトのタグのリスト。
topics文字列の配列プロジェクトのトピックのリスト。
ssh_url_to_repo文字列リポジトリをクローンするためのSSH URL。
http_url_to_repo文字列リポジトリをクローンするためのHTTP URL。
web_url文字列ブラウザでプロジェクトにアクセスするためのURL。
readme_url文字列プロジェクトのReadmeファイルへのURL。
forks_count整数プロジェクトのフォーク数。
avatar_url文字列プロジェクトのアバター画像へのURL。
star_count整数プロジェクトが受け取ったスターの数。
last_activity_at日時プロジェクトの最終アクティビティのタイムスタンプ。
visibility文字列プロジェクトの表示レベル。設定可能な値: private、internal、またはpublic。
namespaceオブジェクトプロジェクトのネームスペース情報。
namespace.id整数ネームスペースのID。
namespace.name文字列ネームスペースの名前。
namespace.path文字列ネームスペースのパス。
namespace.kind文字列ネームスペースの種類。設定可能な値: userまたはgroup。
namespace.full_path文字列ネームスペースのフルパス。
namespace.parent_id整数該当する場合、親ネームスペースのID。
namespace.avatar_url文字列ネームスペースのアバター画像へのURL。
namespace.web_url文字列ブラウザでネームスペースにアクセスするためのURL。
container_registry_image_prefix文字列コンテナレジストリイメージのプレフィックス。
_linksオブジェクトプロジェクトに関連するAPIエンドポイントリンクのコレクション。
_links.self文字列プロジェクトリソースへのURL。
_links.issues文字列プロジェクトのイシューへのURL。
_links.merge_requests文字列プロジェクトのマージリクエストへのURL。
_links.repo_branches文字列プロジェクトのリポジトリのブランチへのURL。
_links.labels文字列プロジェクトのラベルへのURL。
_links.events文字列プロジェクトのイベントへのURL。
_links.members文字列プロジェクトのメンバーへのURL。
_links.cluster_agents文字列プロジェクトのクラスターエージェントへのURL。
marked_for_deletion_at日付非推奨。代わりにmarked_for_deletion_onを使用してください。プロジェクトの削除予定日。
marked_for_deletion_on日付プロジェクトの削除予定日。
packages_enabledブール値プロジェクトでパッケージレジストリが有効になっているかどうか。
empty_repoブール値リポジトリが空であるかどうか。
archivedブール値プロジェクトがアーカイブされているかどうか。
resolve_outdated_diff_discussionsブール値最新ではない差分ディスカッションが自動的に解決されるかどうか。
container_expiration_policyオブジェクトコンテナイメージのポリシーの有効期限に関する設定。
container_expiration_policy.cadence文字列コンテナの有効期限ポリシーが実行される頻度。
container_expiration_policy.enabledブール値コンテナの有効期限ポリシーが有効になっているかどうか。
container_expiration_policy.keep_n整数保持するコンテナイメージの数。
container_expiration_policy.older_than文字列この値よりも古いコンテナイメージを削除します。
container_expiration_policy.name_regex文字列非推奨。代わりにname_regex_deleteを使用してください。コンテナイメージ名に一致する正規表現。
container_expiration_policy.name_regex_keep文字列保持するコンテナイメージ名に一致する正規表現。
container_expiration_policy.next_run_at日時次回のポリシー実行予定時刻のタイムスタンプ。
repository_object_format文字列リポジトリで使用されるオブジェクト形式（sha1またはsha256）。
issues_enabledブール値プロジェクトでイシューが有効になっているかどうか。
merge_requests_enabledブール値プロジェクトでマージリクエストが有効になっているかどうか。
wiki_enabledブール値プロジェクトでWikiが有効になっているかどうか。
jobs_enabledブール値プロジェクトでジョブが有効になっているかどうか。
snippets_enabledブール値プロジェクトでスニペットが有効になっているかどうか。
container_registry_enabledブール値非推奨。代わりにcontainer_registry_access_levelを使用してください。コンテナレジストリが有効になっているかどうか。
service_desk_enabledブール値プロジェクトでサービスデスクが有効になっているかどうか。
can_create_merge_request_inブール値現在のユーザーがプロジェクトでマージリクエストを作成できるかどうか。
issues_access_level文字列イシュー機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
repository_access_level文字列リポジトリ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
merge_requests_access_level文字列マージリクエスト機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
forking_access_level文字列プロジェクトをフォークするためのアクセスレベル。設定可能な値: disabled、private、またはenabled。
wiki_access_level文字列Wiki機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
builds_access_level文字列CI/CDビルド機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
snippets_access_level文字列スニペット機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
pages_access_level文字列GitLab Pagesのアクセスレベル。設定可能な値: disabled、private、enabled、またはpublic。
analytics_access_level文字列分析機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
container_registry_access_level文字列コンテナレジストリのアクセスレベル。設定可能な値: disabled、private、またはenabled。
security_and_compliance_access_level文字列セキュリティおよびコンプライアンス機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
releases_access_level文字列リリース機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
environments_access_level文字列環境機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
feature_flags_access_level文字列機能フラグ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
infrastructure_access_level文字列インフラストラクチャ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
monitor_access_level文字列監視機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
model_experiments_access_level文字列モデル実験機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
model_registry_access_level文字列モデルレジストリ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
package_registry_access_level文字列パッケージレジストリ機能のアクセスレベル。設定可能な値: disabled、private、またはenabled。
emails_disabledブール値プロジェクトのメールが無効になっているかどうかを示します。
emails_enabledブール値プロジェクトのメールが有効になっているかどうかを示します。
show_diff_preview_in_emailブール値メール通知で差分プレビューが表示されるかどうかを示します。
shared_runners_enabledブール値プロジェクトで共有Runnerが有効になっているかどうか。
lfs_enabledブール値プロジェクトでGit LFSが有効になっているかどうかを示します。
creator_id整数プロジェクトを作成したユーザーのID。
import_status文字列プロジェクトインポートのステータス。
open_issues_count整数未解決のイシューの数。
description_html文字列HTML形式でのプロジェクトの説明。
updated_at日時プロジェクトが最後に更新された日時。
ci_default_git_depth整数CI/CDパイプラインのデフォルトのGit深度。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
ci_forward_deployment_enabledブール値フォワードデプロイが有効になっているかどうか。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
ci_job_token_scope_enabledブール値CI/CDジョブトークンスコープが有効になっているかどうかを示します。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
ci_separated_cachesブール値CI/CDキャッシュがブランチごとに分離されているかどうか。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
ci_allow_fork_pipelines_to_run_in_parent_projectブール値フォークパイプラインが親プロジェクトで実行できるかどうか。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
build_git_strategy文字列CI/CDのビルドに使用されるGit戦略（フェッチまたはクローン）。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
keep_latest_artifactブール値新しいアーティファクトが作成されたときに、最新のアーティファクトが保持されるかどうかを示します。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
restrict_user_defined_variablesブール値ユーザー定義の変数が制限されているかどうか。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
runners_token文字列プロジェクトにRunnerを登録するためのトークン。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
runner_token_expiration_interval整数Runnerトークンの有効期限間隔（秒単位）。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
group_runners_enabledブール値プロジェクトでグループRunnerが有効になっているかどうか。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
auto_cancel_pending_pipelines文字列保留中のパイプラインを自動的にキャンセルするための設定。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
build_timeout整数CI/CDジョブのタイムアウト（秒単位）。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
auto_devops_enabledブール値プロジェクトでAuto DevOpsが有効になっているかどうか。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
auto_devops_deploy_strategy文字列Auto DevOpsのデプロイ戦略。管理者アクセス権、またはプロジェクトのオーナーロールを持つ場合にのみ表示されます。
ci_config_path文字列CI/CD設定ファイルへのパス。
public_jobsブール値ジョブログが公開アクセス可能かどうか。
shared_with_groupsオブジェクトの配列プロジェクトが共有されているグループのリスト。
only_allow_merge_if_pipeline_succeedsブール値パイプラインが成功した場合にのみマージが許可されるかどうか。
allow_merge_on_skipped_pipelineブール値パイプラインがスキップされた場合にマージが許可されるかどうか。
request_access_enabledブール値ユーザーがプロジェクトへのアクセスをリクエストできるかどうか。
only_allow_merge_if_all_discussions_are_resolvedブール値すべてのディスカッションが解決される場合にのみマージが許可されるかどうか。
remove_source_branch_after_mergeブール値マージ後にソースブランチが自動的に削除されるかどうか。
printing_merge_request_link_enabledブール値プッシュ後にマージリクエストのリンクが出力されるかどうかを示します。
merge_method文字列プロジェクトに使用されるマージメソッド。設定可能な値: merge、rebase_merge、またはff。
merge_request_title_regex文字列マージリクエストのタイトルを検証するための正規表現パターン。
merge_request_title_regex_description文字列マージリクエストのタイトル正規表現の検証の説明。
squash_option文字列マージリクエストのスカッシュオプション。
enforce_auth_checks_on_uploadsブール値アップロード時に認証チェックが強制されるかどうか。
suggestion_commit_message文字列提案のカスタムコミットメッセージ。
merge_commit_template文字列マージコミットメッセージのテンプレート。
squash_commit_template文字列スカッシュコミットメッセージのテンプレート。
issue_branch_template文字列イシューから作成されたブランチ名のテンプレート。
warn_about_potentially_unwanted_charactersブール値潜在的に不要な文字の使用について警告するかどうか。
autoclose_referenced_issuesブール値参照されたイシューが自動的に閉じられるかどうか。
max_artifacts_size整数CI/CDアーティファクトの最大サイズ（MB）。
approvals_before_merge整数非推奨。代わりにマージリクエスト承認APIを使用してください。マージ前に必要な承認の数。
mirrorブール値プロジェクトがミラーであるかどうか。
external_authorization_classification_label文字列外部認可分類ラベル。
requirements_enabledブール値要件管理が有効になっているかどうかを示します。
requirements_access_level文字列要件機能のアクセスレベル。
security_and_compliance_enabledブール値セキュリティおよびコンプライアンス機能が有効になっているかどうかを示します。
compliance_frameworks文字列の配列プロジェクトに適用されるコンプライアンスフレームワーク。
issues_template文字列イシューのデフォルトの説明。説明は、GitLab Flavored Markdownを使用して解析されます。PremiumおよびUltimateのみです。
merge_requests_template文字列マージリクエストの説明のテンプレート。PremiumおよびUltimateのみです。
merge_pipelines_enabledブール値マージパイプラインが有効になっているかどうかを示します。
merge_trains_enabledブール値マージトレインが有効になっているかどうかを示します。
merge_trains_skip_train_allowedブール値マージトレインのスキップが許可されているかどうかを示します。
only_allow_merge_if_all_status_checks_passedブール値すべてのステータスチェックが合格した場合にのみマージが許可されるかどうか。Ultimateのみです。
allow_pipeline_trigger_approve_deploymentブール値パイプライントリガーがデプロイを承認できるかどうか。
prevent_merge_without_jira_issueブール値マージに、関連付けられたJiraイシューが必要かどうかを示します。
duo_remote_flows_enabledブール値GitLab Duoのリモートフローが有効になっているかどうかを示します。
duo_foundational_flows_enabledブール値GitLab Duoの基本フローが有効になっているかどうかを示します。
duo_sast_fp_detection_enabledブール値GitLab Duo SASTの誤検出判定が有効になっているかどうかを示します。
spp_repository_pipeline_accessブール値セキュリティポリシーのリポジトリパイプラインアクセス。セキュリティオーケストレーションポリシー機能が利用可能な場合にのみ表示されます。
permissionsオブジェクトプロジェクトのユーザー権限。
permissions.project_accessオブジェクトユーザーのプロジェクトアクセス権限。
permissions.group_accessオブジェクトユーザーのグループアクセス権限。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/users/5/contributed_projects"

レスポンス例:

[
  {
    "id": 4,
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
    "description_html": "<p data-sourcepos=\"1:1-1:56\" dir=\"auto\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
    "default_branch": "main",
    "visibility": "private",
    "ssh_url_to_repo": "git@example.com:diaspora/diaspora-client.git",
    "http_url_to_repo": "http://example.com/diaspora/diaspora-client.git",
    "web_url": "http://example.com/diaspora/diaspora-client",
    "readme_url": "http://example.com/diaspora/diaspora-client/blob/main/README.md",
    "tag_list": [ //deprecated, use `topics` instead
      "example",
      "disapora client"
    ],
    "topics": [
      "example",
      "disapora client"
    ],
    "owner": {
      "id": 3,
      "name": "Diaspora",
      "created_at": "2013-09-30T13:46:02Z"
    },
    "name": "Diaspora Client",
    "name_with_namespace": "Diaspora / Diaspora Client",
    "path": "diaspora-client",
    "path_with_namespace": "diaspora/diaspora-client",
    "issues_enabled": true,
    "open_issues_count": 1,
    "merge_requests_enabled": true,
    "jobs_enabled": true,
    "wiki_enabled": true,
    "snippets_enabled": false,
    "can_create_merge_request_in": true,
    "resolve_outdated_diff_discussions": false,
    "container_registry_enabled": false, // deprecated, use container_registry_access_level instead
    "container_registry_access_level": "disabled",
    "security_and_compliance_access_level": "disabled",
    "created_at": "2013-09-30T13:46:02Z",
    "updated_at": "2013-09-30T13:46:02Z",
    "last_activity_at": "2013-09-30T13:46:02Z",
    "creator_id": 3,
    "namespace": {
      "id": 3,
      "name": "Diaspora",
      "path": "diaspora",
      "kind": "group",
      "full_path": "diaspora"
    },
    "import_status": "none",
    "archived": false,
    "avatar_url": "http://example.com/uploads/project/avatar/4/uploads/avatar.png",
    "shared_runners_enabled": true,
    "group_runners_enabled": true,
    "forks_count": 0,
    "star_count": 0,
    "runners_token": "b8547b1dc37721d05889db52fa2f02",
    "public_jobs": true,
    "shared_with_groups": [],
    "only_allow_merge_if_pipeline_succeeds": false,
    "allow_merge_on_skipped_pipeline": false,
    "allow_pipeline_trigger_approve_deployment": false,
    "restrict_user_defined_variables": false,
    "only_allow_merge_if_all_discussions_are_resolved": false,
    "remove_source_branch_after_merge": false,
    "request_access_enabled": false,
    "merge_method": "merge",
    "squash_option": "default_on",
    "autoclose_referenced_issues": true,
    "enforce_auth_checks_on_uploads": true,
    "suggestion_commit_message": null,
    "merge_commit_template": null,
    "squash_commit_template": null,
    "secret_push_protection_enabled": false,
    "issue_branch_template": "gitlab/%{id}-%{title}",
    "statistics": {
      "commit_count": 37,
      "storage_size": 1038090,
      "repository_size": 1038090,
      "lfs_objects_size": 0,
      "job_artifacts_size": 0,
      "pipeline_artifacts_size": 0,
      "packages_size": 0,
      "snippets_size": 0,
      "uploads_size": 0,
      "container_registry_size": 0
    },
    "container_registry_image_prefix": "registry.example.com/diaspora/diaspora-client",
    "_links": {
      "self": "http://example.com/api/v4/projects",
      "issues": "http://example.com/api/v4/projects/1/issues",
      "merge_requests": "http://example.com/api/v4/projects/1/merge_requests",
      "repo_branches": "http://example.com/api/v4/projects/1/repository_branches",
      "labels": "http://example.com/api/v4/projects/1/labels",
      "events": "http://example.com/api/v4/projects/1/events",
      "members": "http://example.com/api/v4/projects/1/members",
      "cluster_agents": "http://example.com/api/v4/projects/1/cluster_agents"
    }
  },
  {
    "id": 6,
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
    "description_html": "<p data-sourcepos=\"1:1-1:56\" dir=\"auto\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
    "default_branch": "main",
    "visibility": "private",
    "ssh_url_to_repo": "git@example.com:brightbox/puppet.git",
    "http_url_to_repo": "http://example.com/brightbox/puppet.git",
    "web_url": "http://example.com/brightbox/puppet",
    "readme_url": "http://example.com/brightbox/puppet/blob/main/README.md",
    "tag_list": [ //deprecated, use `topics` instead
      "example",
      "puppet"
    ],
    "topics": [
      "example",
      "puppet"
    ],
    "owner": {
      "id": 4,
      "name": "Brightbox",
      "created_at": "2013-09-30T13:46:02Z"
    },
    "name": "Puppet",
    "name_with_namespace": "Brightbox / Puppet",
    "path": "puppet",
    "path_with_namespace": "brightbox/puppet",
    "issues_enabled": true,
    "open_issues_count": 1,
    "merge_requests_enabled": true,
    "jobs_enabled": true,
    "wiki_enabled": true,
    "snippets_enabled": false,
    "can_create_merge_request_in": true,
    "resolve_outdated_diff_discussions": false,
    "container_registry_enabled": false, // deprecated, use container_registry_access_level instead
    "container_registry_access_level": "disabled",
    "security_and_compliance_access_level": "disabled",
    "created_at": "2013-09-30T13:46:02Z",
    "updated_at": "2013-09-30T13:46:02Z",
    "last_activity_at": "2013-09-30T13:46:02Z",
    "creator_id": 3,
    "namespace": {
      "id": 4,
      "name": "Brightbox",
      "path": "brightbox",
      "kind": "group",
      "full_path": "brightbox"
    },
    "import_status": "none",
    "import_error": null,
    "permissions": {
      "project_access": {
        "access_level": 10,
        "notification_level": 3
      },
      "group_access": {
        "access_level": 50,
        "notification_level": 3
      }
    },
    "archived": false,
    "avatar_url": null,
    "shared_runners_enabled": true,
    "group_runners_enabled": true,
    "forks_count": 0,
    "star_count": 0,
    "runners_token": "b8547b1dc37721d05889db52fa2f02",
    "public_jobs": true,
    "shared_with_groups": [],
    "only_allow_merge_if_pipeline_succeeds": false,
    "allow_merge_on_skipped_pipeline": false,
    "allow_pipeline_trigger_approve_deployment": false,
    "restrict_user_defined_variables": false,
    "only_allow_merge_if_all_discussions_are_resolved": false,
    "remove_source_branch_after_merge": false,
    "request_access_enabled": false,
    "merge_method": "merge",
    "squash_option": "default_on",
    "auto_devops_enabled": true,
    "auto_devops_deploy_strategy": "continuous",
    "repository_storage": "default",
    "approvals_before_merge": 0, // Deprecated. Use merge request approvals API instead.
    "mirror": false,
    "mirror_user_id": 45,
    "mirror_trigger_builds": false,
    "only_mirror_protected_branches": false,
    "mirror_overwrites_diverged_branches": false,
    "external_authorization_classification_label": null,
    "packages_enabled": true, // deprecated, use package_registry_access_level instead
    "empty_repo": false,
    "package_registry_access_level": "enabled",
    "service_desk_enabled": false,
    "service_desk_address": null,
    "autoclose_referenced_issues": true,
    "enforce_auth_checks_on_uploads": true,
    "suggestion_commit_message": null,
    "merge_commit_template": null,
    "squash_commit_template": null,
    "secret_push_protection_enabled": false,
    "issue_branch_template": "gitlab/%{id}-%{title}",
    "statistics": {
      "commit_count": 12,
      "storage_size": 2066080,
      "repository_size": 2066080,
      "lfs_objects_size": 0,
      "job_artifacts_size": 0,
      "pipeline_artifacts_size": 0,
      "packages_size": 0,
      "snippets_size": 0,
      "uploads_size": 0,
      "container_registry_size": 0
    },
    "container_registry_image_prefix": "registry.example.com/brightbox/puppet",
    "_links": {
      "self": "http://example.com/api/v4/projects",
      "issues": "http://example.com/api/v4/projects/1/issues",
      "merge_requests": "http://example.com/api/v4/projects/1/merge_requests",
      "repo_branches": "http://example.com/api/v4/projects/1/repository_branches",
      "labels": "http://example.com/api/v4/projects/1/labels",
      "events": "http://example.com/api/v4/projects/1/events",
      "members": "http://example.com/api/v4/projects/1/members",
      "cluster_agents": "http://example.com/api/v4/projects/1/cluster_agents"
    }
  }
]

属性のリストを取得する

プロジェクトの属性のリストを取得します。

プロジェクトのすべてのメンバーをリストする

指定されたプロジェクトへのアクセス権限を持つすべてのメンバーをリスト表示します。

GET /projects/:id/users

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
search文字列いいえusernameまたはnameで特定のメンバーを検索します。
skip_users整数の配列いいえ指定されたIDを持つメンバーを除外します。

成功した場合、200 OKと次のレスポンス属性を返します:

属性型説明
id整数ユーザーのID。
username文字列ユーザーのユーザー名。
name文字列ユーザーのフルネーム。
state文字列ユーザーアカウントの状態。設定可能な値: activeまたはblocked。
avatar_url文字列ユーザーのアバター画像へのURL。
web_url文字列ブラウザでユーザーのプロフィールにアクセスするためのURL。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --url "https://gitlab.com/api/v4/projects/<project_id>/users" \

レスポンス例:

[
  {
    "id": 1,
    "username": "john_smith",
    "name": "John Smith",
    "state": "active",
    "avatar_url": "http://localhost:3000/uploads/user/avatar/1/cd8.jpeg",
    "web_url": "http://localhost:3000/john_smith"
  },
  {
    "id": 2,
    "username": "jack_smith",
    "name": "Jack Smith",
    "state": "blocked",
    "avatar_url": "http://gravatar.com/../e32131cd8.jpeg",
    "web_url": "http://localhost:3000/jack_smith"
  }
]

すべての祖先グループをリスト表示

指定されたプロジェクトのすべての祖先グループをリスト表示します。

GET /projects/:id/groups

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
search文字列いいえグループIDで特定のグループを検索します。
shared_min_access_level整数いいえ指定されたアクセスレベル以上の共有グループに限定します。使用可能な値: 5 (最小アクセス)、10 (ゲスト)、15 (プランナー)、20 (レポーター)、30 (デベロッパー)、40 (メンテナー)、または50 (オーナー)。
shared_visible_onlyブール値いいえtrueの場合、認証済みユーザーがアクセスできる共有グループのみを返します。
skip_groups整数の配列いいえ渡されたグループIDをスキップします。
with_sharedブール値いいえこのグループと共有されているプロジェクトを含めます。デフォルトはfalseです。

成功した場合、200 OKと次のレスポンス属性を返します:

属性型説明
id整数グループのID。
name文字列グループの名前。
avatar_url文字列グループのアバター画像へのURL。
web_url文字列ブラウザでグループにアクセスするためのURL。
full_name文字列グループの正式名称。
full_path文字列グループのフルパス。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --url "https://gitlab.example.com/api/v4/projects/<project_id>/groups"

レスポンス例:

[
  {
    "id": 1,
    "name": "Foobar Group",
    "avatar_url": "http://localhost:3000/uploads/group/avatar/1/foo.jpg",
    "web_url": "http://localhost:3000/groups/foo-bar",
    "full_name": "Foobar Group",
    "full_path": "foo-bar"
  },
  {
    "id": 2,
    "name": "Shared Group",
    "avatar_url": "http://gitlab.example.com/uploads/group/avatar/1/bar.jpg",
    "web_url": "http://gitlab.example.com/groups/foo/bar",
    "full_name": "Shared Group",
    "full_path": "foo/shared"
  }
]

プロジェクトに招待できるすべてのグループをリスト表示

プロジェクトに招待できるすべてのグループをリスト表示します。

GET /projects/:id/share_locations

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
search文字列いいえグループIDで特定のグループを検索します。

成功した場合、200 OKと次のレスポンス属性を返します:

属性型説明
id整数グループのID。
web_url文字列ブラウザでグループにアクセスするためのURL。
name文字列グループの名前。
avatar_url文字列グループのアバター画像へのURL。
full_name文字列グループの正式名称。
full_path文字列グループのフルパス。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --url "https://gitlab.example.com/api/v4/projects/<project_id>/share_locations"

レスポンス例:

[
  {
    "id": 22,
    "web_url": "http://127.0.0.1:3000/groups/gitlab-org",
    "name": "Gitlab Org",
    "avatar_url": null,
    "full_name": "Gitlab Org",
    "full_path": "gitlab-org"
  },
  {
    "id": 25,
    "web_url": "http://127.0.0.1:3000/groups/gnuwget",
    "name": "Gnuwget",
    "avatar_url": null,
    "full_name": "Gnuwget",
    "full_path": "gnuwget"
  }
]

プロジェクト内の招待されたすべてのグループをリスト表示

プロジェクト内の招待されたすべてのグループをリスト表示します。認証なしでアクセスした場合、公開されている招待グループのみを返します。このエンドポイントは、次の項目ごとに1分あたり60件のリクエストにレート制限されています。

  • 認証済みユーザー用のユーザー
  • 未認証ユーザーのIPアドレス

このエンドポイントはページネーションをサポートしています:

  • オフセットベースのページネーションを使用して、最大50,000のプロジェクトにアクセスします。
  • キーセットベースのページネーションを使用して、50,000以上のプロジェクトをリスト表示します。

詳細については、ページネーションを参照してください。

GET /projects/:id/invited_groups

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス。
search文字列いいえ検索条件に一致する認証済みグループのリストを返します。
min_access_level整数いいえ指定されたアクセスレベル以上のグループに限定します。使用可能な値: 5 (最小アクセス)、10 (ゲスト)、15 (プランナー)、20 (レポーター)、30 (デベロッパー)、40 (メンテナー)、または50 (オーナー)。
relation文字列の配列いいえ関連によってグループをフィルターします。設定可能な値: directまたはinherited。
with_custom_attributesブール値いいえtrueの場合、レスポンスでカスタム属性を返します。管理者アクセスが必要です。

成功した場合、200 OKと次のレスポンス属性を返します:

属性型説明
id整数グループのID。
web_url文字列ブラウザでグループにアクセスするためのURL。
name文字列グループの名前。
avatar_url文字列グループのアバター画像へのURL。
full_name文字列グループの正式名称。
full_path文字列グループのフルパス。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     --url "https://gitlab.example.com/api/v4/projects/<project_id>/invited_groups"

レスポンス例:

[
  {
    "id": 35,
    "web_url": "https://gitlab.example.com/groups/twitter",
    "name": "Twitter",
    "avatar_url": null,
    "full_name": "Twitter",
    "full_path": "twitter"
  }
]

プログラミング言語の使用状況情報を取得する

指定されたプロジェクトで使用されているすべてのプログラミング言語に関する情報を取得します。

GET /projects/:id/languages

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。

成功した場合、200 OKおよびプログラミング言語と使用率のリストを返します。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/languages"

レスポンス例:

{
  "Ruby": 66.69,
  "JavaScript": 22.98,
  "HTML": 7.91,
  "CoffeeScript": 2.42
}

プロジェクトを管理する

プロジェクトを管理します（作成、削除、アーカイブなど）。

プロジェクトを作成する

認証済みユーザーが所有する新しいプロジェクトを作成します。

HTTPリポジトリが公開されていない場合は、URL https://username:password@gitlab.company.com/group/project.gitに認証情報を追加します。ここで、passwordはapiスコープが有効な公開アクセスキーです。

POST /projects

サポートされている一般的なプロジェクトの属性:

属性型必須説明
name文字列はい（pathが指定されていない場合）新しいプロジェクトの名前。指定されていない場合はパスと等しくなります。
path文字列はい（nameが指定されていない場合）新しいプロジェクトのリポジトリ名。指定されていない場合は、名前に基づいて生成されます（小文字とダッシュを使用して生成）。パスの先頭と末尾には特殊文字を使用できません。また、連続する特殊文字を含めることはできません。
allow_merge_on_skipped_pipelineブール値いいえスキップされたジョブでマージリクエストをマージできるかどうかを設定します。
approvals_before_merge整数いいえデフォルトでマージリクエストを承認する必要がある承認者の数。承認ルールを設定するには、マージリクエスト承認APIを参照してください。GitLab 16.0で非推奨になりました。PremiumおよびUltimateのみです。
auto_cancel_pending_pipelines文字列いいえ保留中のパイプラインを自動的にキャンセルします。このアクションは、有効状態と無効状態を切り替えます。ブール値ではありません。
auto_devops_deploy_strategy文字列いいえ自動デプロイ戦略（continuous、manual、またはtimed_incremental）。
auto_devops_enabledブール値いいえこのプロジェクトに対してAuto DevOpsを有効にします。
autoclose_referenced_issuesブール値いいえデフォルトブランチで参照されているイシューを自動的にクローズするかどうかを設定します。
avatar混合いいえプロジェクトのアバターの画像ファイル。
build_git_strategy文字列いいえGit戦略。fetchがデフォルトです。
build_timeout整数いいえジョブの最大実行可能時間（秒単位）。
ci_config_path文字列いいえCI設定ファイルへのパス。
container_expiration_policy_attributesハッシュいいえこのプロジェクト用のイメージのクリーンアップポリシーを更新します。cadence（文字列）、keep_n（整数）、older_than（文字列）、name_regex（文字列）、name_regex_delete（文字列）、name_regex_keep（文字列）、enabled（ブール値）を指定できます。cadence、keep_n、older_thanの値の詳細については、コンテナレジストリのドキュメントを参照してください。
container_registry_enabledブール値いいえ_（非推奨）_このプロジェクトのコンテナレジストリを有効にします。代わりにcontainer_registry_access_levelを使用してください。
default_branch文字列いいえデフォルトブランチ名。ブランチ名（例: main）または完全修飾参照（例: refs/heads/main）を受け入れます。完全修飾参照が提供された場合、APIはrefs/heads/プレフィックスを削除します。initialize_with_readmeがtrueである必要があります。
description文字列いいえプロジェクトの短い説明。
emails_disabledブール値いいえ_（非推奨）_メール通知を無効にします。代わりにemails_enabledを使用してください。
emails_enabledブール値いいえメール通知を有効にします。
external_authorization_classification_label文字列いいえプロジェクトの分類ラベル。PremiumおよびUltimateのみです。
group_runners_enabledブール値いいえこのプロジェクトのグループRunnerを有効にします。
group_with_project_templates_id整数いいえグループレベルのカスタムテンプレートの場合、すべてのカスタムプロジェクトテンプレートのソースとなるグループのIDを指定します。インスタンスレベルのテンプレートの場合は空のままにします。use_custom_templateがtrueである必要があります。PremiumおよびUltimateのみです。
import_url文字列いいえリポジトリのインポート元のURL。URLの値が空でない場合は、initialize_with_readmeをtrueに設定しないでください。エラー（not a git repository）が発生する可能性があります。
initialize_with_readmeブール値いいえREADME.mdファイルのみを使用してGitリポジトリを作成するかどうか。デフォルトはfalseです。このブール値がtrueの場合、import_url、またはリポジトリの代替コンテンツを指定するこのエンドポイントの他の属性を渡してはなりません。エラー（not a git repository）が発生する可能性があります。
issues_enabledブール値いいえ_（非推奨）_このプロジェクト用にイシューを有効にします。代わりにissues_access_levelを使用してください。
jobs_enabledブール値いいえ_（非推奨）_このプロジェクト用にジョブを有効にします。代わりにbuilds_access_levelを使用してください。
lfs_enabledブール値いいえLFSを有効にします。
merge_method文字列いいえプロジェクトのマージ方法を設定します。merge（マージコミット）、rebase_merge（半線形履歴を使用するマージコミット）、またはff（早送りマージ）を指定できます。
merge_pipelines_enabledブール値いいえマージ結果パイプラインを有効または無効にします。
merge_requests_enabledブール値いいえ_（非推奨）_このプロジェクト用にマージリクエストを有効にします。代わりにmerge_requests_access_levelを使用してください。
merge_trains_enabledブール値いいえマージトレインを有効または無効にします。
merge_trains_skip_train_allowedブール値いいえパイプラインが完了するのを待たずに、マージトレインマージリクエストをマージできるようにします。
mirror_trigger_buildsブール値いいえプルミラーリングがビルドをトリガーします。PremiumおよびUltimateのみです。
mirrorブール値いいえプロジェクトでプルミラーリングを有効にします。PremiumおよびUltimateのみです。
namespace_id整数いいえ新しいプロジェクトのネームスペース。グループIDまたはサブグループIDを指定します。指定しない場合、デフォルトで現在のユーザーのパーソナルネームスペースが使用されます。
only_allow_merge_if_all_discussions_are_resolvedブール値いいえすべてのディスカッションが解決された場合にのみマージリクエストをマージできるようにするかどうかを設定します。
only_allow_merge_if_all_status_checks_passedブール値いいえすべてのステータスチェックに合格していなければ、マージリクエストのマージをブロックする必要があることを示します。デフォルトはfalseです。機能フラグonly_allow_merge_if_all_status_checks_passedをデフォルトで無効にして、GitLab 15.5で導入されました。Ultimateのみです。
only_allow_merge_if_pipeline_succeedsブール値いいえマージリクエストを成功したパイプラインでのみマージできるようにするかどうかを設定します。この設定は、プロジェクト設定でパイプラインが完了しているという名前になります。
packages_enabledブール値いいえGitLab 17.10で非推奨になりました。パッケージリポジトリ機能を有効または無効にします。代わりにpackage_registry_access_levelを使用してください。
package_registry_access_level文字列いいえパッケージリポジトリ機能を有効または無効にします。
printing_merge_request_link_enabledブール値いいえコマンドラインからプッシュするときに、マージリクエストを作成/表示するためのリンクを表示します。
public_buildsブール値いいえ（非推奨）trueの場合、プロジェクトメンバー以外のユーザーもジョブを表示できます。代わりにpublic_jobsを使用してください。
public_jobsブール値いいえtrueの場合、プロジェクトメンバー以外のユーザーもジョブを表示できます。
repository_object_format文字列いいえリポジトリオブジェクト形式。sha1がデフォルトです。GitLab 16.9で導入されました。
remove_source_branch_after_mergeブール値いいえすべての新しいマージリクエストに対して、デフォルトでDelete source branchオプションを有効にします。
repository_storage文字列いいえリポジトリが存在するストレージシャード。（管理者のみ）
request_access_enabledブール値いいえユーザーがメンバーアクセスをリクエストできるようにします。
resolve_outdated_diff_discussionsブール値いいえプッシュで変更された行に関するマージリクエスト差分ディスカッションを自動的に解決します。
shared_runners_enabledブール値いいえこのプロジェクト用にインスタンスRunnerを有効にします。
show_default_award_emojisブール値いいえデフォルトの絵文字リアクションを表示します。
snippets_enabledブール値いいえ_（非推奨）_このプロジェクト用にスニペットを有効にします。代わりにsnippets_access_levelを使用してください。
squash_option文字列いいえnever、always、default_on、default_offのいずれかです。
tag_list配列いいえプロジェクトのタグのリスト。最終的にプロジェクトに割り当てる必要のあるタグの配列を指定します。GitLab 14.0で非推奨になりました。代わりにtopicsを使用してください。
template_name文字列いいえuse_custom_templateを指定せずに使用する場合は、組み込みプロジェクトテンプレートの名前。use_custom_templateとともに使用する場合は、カスタムプロジェクトテンプレートの名前。
template_project_id整数いいえuse_custom_templateとともに使用する場合は、カスタムプロジェクトテンプレートのプロジェクトID。プロジェクトIDを使用する方法は、template_nameを使用する方法よりも推奨されます。これは、template_nameはあいまいになる可能性があるためです。PremiumおよびUltimateのみです。
topics配列いいえプロジェクトのトピックのリスト。最終的にプロジェクトに割り当てる必要のあるトピックの配列を指定します。
use_custom_templateブール値いいえカスタムインスタンスプロジェクトテンプレートまたはグループ（group_with_project_templates_id付き）プロジェクトテンプレートのいずれかを使用します。PremiumおよびUltimateのみです。
visibility文字列いいえプロジェクトの表示レベルを参照してください。
warn_about_potentially_unwanted_charactersブール値いいえこのプロジェクトで不要である可能性がある文字の使用に関する警告を有効にします。
wiki_enabledブール値いいえ_（非推奨）_このプロジェクト用にWikiを有効にします。代わりにwiki_access_levelを使用してください。

リクエスト例:

curl --request POST --header "PRIVATE-TOKEN: <your-token>" \
     --header "Content-Type: application/json" --data '{
        "name": "new_project", "description": "New Project", "path": "new_project",
        "namespace_id": "42", "initialize_with_readme": "true"}' \
     --url "https://gitlab.example.com/api/v4/projects/"

個々のプロジェクト機能の表示レベルを設定するには、Project feature visibility levelを参照してください。

ユーザーのプロジェクトを作成する

ユーザーのプロジェクトを作成します。

前提条件:

  • 管理者である必要があります。

HTTPリポジトリが公開されていない場合は、認証情報をURLに追加します。たとえばhttps://username:password@gitlab.company.com/group/project.gitの場合、passwordは、apiスコープが有効になっているパブリックアクセスキーです。

POST /projects/user/:user_id

サポートされている一般的なプロジェクトの属性:

属性型必須説明
name文字列はい新しいプロジェクトの名前。
user_id整数はいプロジェクトオーナーのユーザーID。
allow_merge_on_skipped_pipelineブール値いいえスキップされたジョブでマージリクエストをマージできるかどうかを設定します。
approvals_before_merge整数いいえデフォルトでマージリクエストを承認する必要がある承認者の数。GitLab 16.0で非推奨になりました。承認ルールを設定するには、マージリクエスト承認APIを参照してください。PremiumおよびUltimateのみです。
auto_cancel_pending_pipelines文字列いいえ保留中のパイプラインを自動的にキャンセルします。このアクションは、有効状態と無効状態を切り替えます。ブール値ではありません。
auto_devops_deploy_strategy文字列いいえ自動デプロイ戦略（continuous、manual、またはtimed_incremental）。
auto_devops_enabledブール値いいえこのプロジェクトに対してAuto DevOpsを有効にします。
autoclose_referenced_issuesブール値いいえデフォルトブランチで参照されているイシューを自動的にクローズするかどうかを設定します。
avatar混合いいえプロジェクトのアバターの画像ファイル。
build_git_strategy文字列いいえGit戦略。fetchがデフォルトです。
build_timeout整数いいえジョブの最大実行可能時間（秒単位）。
ci_config_path文字列いいえCI設定ファイルへのパス。
container_registry_enabledブール値いいえ_（非推奨）_このプロジェクトのコンテナレジストリを有効にします。代わりにcontainer_registry_access_levelを使用してください。
default_branch文字列いいえデフォルトブランチ名。initialize_with_readmeがtrueである必要があります。
description文字列いいえプロジェクトの短い説明。
emails_disabledブール値いいえ_（非推奨）_メール通知を無効にします。代わりにemails_enabledを使用してください。
emails_enabledブール値いいえメール通知を有効にします。
enforce_auth_checks_on_uploadsブール値いいえアップロード時に認証チェックを強制します。
external_authorization_classification_label文字列いいえプロジェクトの分類ラベル。PremiumおよびUltimateのみです。
group_runners_enabledブール値いいえこのプロジェクトのグループRunnerを有効にします。
group_with_project_templates_id整数いいえグループレベルのカスタムテンプレートの場合、すべてのカスタムプロジェクトテンプレートのソースとなるグループのIDを指定します。インスタンスレベルのテンプレートの場合は空のままにします。use_custom_templateがtrueである必要があります。PremiumおよびUltimateのみです。
import_url文字列いいえリポジトリのインポート元のURL。
initialize_with_readmeブール値いいえデフォルトではfalseです。
issue_branch_template文字列いいえイシューから作成されたブランチの名前を提案するために使用されるテンプレート。（GitLab 15.6で導入されました）
issues_enabledブール値いいえ_（非推奨）_このプロジェクト用にイシューを有効にします。代わりにissues_access_levelを使用してください。
jobs_enabledブール値いいえ_（非推奨）_このプロジェクト用にジョブを有効にします。代わりにbuilds_access_levelを使用してください。
lfs_enabledブール値いいえLFSを有効にします。
merge_commit_template文字列いいえマージリクエストでマージコミットメッセージを作成するために使用されるテンプレート。
merge_method文字列いいえプロジェクトのマージ方法を設定します。merge（マージコミット）、rebase_merge（半線形履歴を使用するマージコミット）、またはff（早送りマージ）を指定できます。
merge_requests_enabledブール値いいえ_（非推奨）_このプロジェクト用にマージリクエストを有効にします。代わりにmerge_requests_access_levelを使用してください。
mirror_trigger_buildsブール値いいえプルミラーリングがビルドをトリガーします。PremiumおよびUltimateのみです。
mirrorブール値いいえプロジェクトでプルミラーリングを有効にします。PremiumおよびUltimateのみです。
namespace_id整数いいえ新しいプロジェクトのネームスペース（デフォルトは現在のユーザーのネームスペース）。
only_allow_merge_if_all_discussions_are_resolvedブール値いいえすべてのディスカッションが解決された場合にのみマージリクエストをマージできるようにするかどうかを設定します。
only_allow_merge_if_all_status_checks_passedブール値いいえすべてのステータスチェックに合格していなければ、マージリクエストのマージをブロックする必要があることを示します。デフォルトはfalseです。機能フラグonly_allow_merge_if_all_status_checks_passedをデフォルトで無効にして、GitLab 15.5で導入されました。Ultimateのみです。
only_allow_merge_if_pipeline_succeedsブール値いいえマージリクエストを成功したジョブのみとマージできるようにするかどうかを設定します。
packages_enabledブール値いいえGitLab 17.10で非推奨になりました。パッケージリポジトリ機能を有効または無効にします。代わりにpackage_registry_access_levelを使用してください。
package_registry_access_level文字列いいえパッケージリポジトリ機能を有効または無効にします。
path文字列いいえ新しいプロジェクトのカスタムリポジトリ名。デフォルトでは、名前に基づいて生成されます。
printing_merge_request_link_enabledブール値いいえコマンドラインからプッシュするときに、マージリクエストを作成/表示するためのリンクを表示します。
public_buildsブール値いいえ（非推奨）trueの場合、プロジェクトメンバー以外のユーザーもジョブを表示できます。代わりにpublic_jobsを使用してください。
public_jobsブール値いいえtrueの場合、プロジェクトメンバー以外のユーザーもジョブを表示できます。
repository_object_format文字列いいえリポジトリオブジェクト形式。sha1がデフォルトです。GitLab 16.9で導入されました。
remove_source_branch_after_mergeブール値いいえすべての新しいマージリクエストに対して、デフォルトでDelete source branchオプションを有効にします。
repository_storage文字列いいえリポジトリが存在するストレージシャード。（管理者のみ）
request_access_enabledブール値いいえユーザーがメンバーアクセスをリクエストできるようにします。
resolve_outdated_diff_discussionsブール値いいえプッシュで変更された行に関するマージリクエスト差分ディスカッションを自動的に解決します。
shared_runners_enabledブール値いいえこのプロジェクト用にインスタンスRunnerを有効にします。
show_default_award_emojisブール値いいえデフォルトの絵文字リアクションを表示します。
snippets_enabledブール値いいえ_（非推奨）_このプロジェクト用にスニペットを有効にします。代わりにsnippets_access_levelを使用してください。
squash_commit_template文字列いいえマージリクエストでスカッシュコミットメッセージを作成するために使用されるテンプレート。
squash_option文字列いいえnever、always、default_on、default_offのいずれかです。
suggestion_commit_message文字列いいえマージリクエストの提案を適用するために使用されるコミットメッセージ。
tag_list配列いいえ_（GitLab 14.0で非推奨になりました）_プロジェクトのタグのリスト。最終的にプロジェクトに割り当てる必要があるタグの配列を指定します。代わりにtopicsを使用してください。
template_name文字列いいえuse_custom_templateを指定せずに使用する場合は、組み込みプロジェクトテンプレートの名前。use_custom_templateとともに使用する場合は、カスタムプロジェクトテンプレートの名前。
topics配列いいえプロジェクトのトピックのリスト。
use_custom_templateブール値いいえカスタムインスタンスプロジェクトテンプレートまたはグループ（group_with_project_templates_id付き）プロジェクトテンプレートのいずれかを使用します。PremiumおよびUltimateのみです。
visibility文字列いいえプロジェクトの表示レベルを参照してください。
warn_about_potentially_unwanted_charactersブール値いいえこのプロジェクトで不要である可能性がある文字の使用に関する警告を有効にします。
wiki_enabledブール値いいえ_（非推奨）_このプロジェクト用にWikiを有効にします。代わりにwiki_access_levelを使用してください。

個々のプロジェクト機能の表示レベルを設定するには、Project feature visibility levelを参照してください。

プロジェクトを編集する

既存のプロジェクトを更新します。

HTTPリポジトリが公開されていない場合は、URL https://username:password@gitlab.company.com/group/project.gitに認証情報を追加します。ここで、passwordはapiスコープが有効な公開アクセスキーです。

PUT /projects/:id

サポートされている一般的なプロジェクトの属性:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
allow_merge_on_skipped_pipelineブール値いいえスキップされたジョブでマージリクエストをマージできるかどうかを設定します。
allow_pipeline_trigger_approve_deploymentブール値いいえパイプラインのトリガー元がデプロイを承認できるかどうかを設定します。PremiumおよびUltimateのみです。
only_allow_merge_if_all_status_checks_passedブール値いいえすべてのステータスチェックに合格していなければ、マージリクエストのマージをブロックする必要があることを示します。デフォルトはfalseです。

機能フラグonly_allow_merge_if_all_status_checks_passedをデフォルトで無効にして、GitLab 15.5で導入されました。この機能フラグは、GitLab 15.9でデフォルトで有効になりました。Ultimateのみです。
approvals_before_merge整数いいえデフォルトでマージリクエストを承認する必要がある承認者の数。GitLab 16.0で非推奨になりました。承認ルールを設定するには、マージリクエスト承認APIを参照してください。PremiumおよびUltimateのみです。
auto_cancel_pending_pipelines文字列いいえ保留中のパイプラインを自動的にキャンセルします。このアクションは、有効状態と無効状態を切り替えます。ブール値ではありません。
auto_devops_deploy_strategy文字列いいえ自動デプロイ戦略（continuous、manual、またはtimed_incremental）。
auto_devops_enabledブール値いいえこのプロジェクトに対してAuto DevOpsを有効にします。
auto_duo_code_review_enabledブール値いいえマージリクエストでGitLab Duoによる自動レビューを有効にします。GitLab Duoにおけるマージリクエストを参照してください。Ultimateのみです。
autoclose_referenced_issuesブール値いいえデフォルトブランチで参照されているイシューを自動的にクローズするかどうかを設定します。
avatar混合いいえプロジェクトのアバターの画像ファイル。
build_git_strategy文字列いいえGit戦略。fetchがデフォルトです。
build_timeout整数いいえジョブの最大実行可能時間（秒単位）。
ci_config_path文字列いいえCI設定ファイルへのパス。
ci_default_git_depth整数いいえシャロークローンのリビジョンのデフォルト数。
ci_delete_pipelines_in_seconds整数いいえ設定された時刻よりも前のパイプラインは削除されます。
ci_display_pipeline_variablesブール値いいえパイプラインを手動で実行した後、パイプライン詳細ページに手動で定義されたすべての変数を表示します。
ci_forward_deployment_enabledブール値いいえ古いデプロイジョブを防止を有効または無効にします。
ci_forward_deployment_rollback_allowedブール値いいえロールバックデプロイのジョブの再試行を許可するを有効または無効にします。
ci_allow_fork_pipelines_to_run_in_parent_projectブール値いいえフォークからのマージリクエストに対して親プロジェクトでパイプラインを実行するを有効または無効にします。（GitLab 15.3で導入されました）
ci_id_token_sub_claim_components配列いいえIDトークンのsubクレームに含まれるフィールド。project_pathで始まる配列を指定できます。配列にはref_type、ref、environment_protected、およびdeployment_tierも含まれる場合があります。["project_path", "ref_type", "ref"]がデフォルトです。GitLab 17.10で導入されました。environment_protectedおよびdeployment_tierのサポートはGitLab 18.7で導入されました。
ci_separated_cachesブール値いいえキャッシュをブランチの保護状態に応じて分離するかどうかを設定します。
ci_restrict_pipeline_cancellation_role文字列いいえパイプラインまたはジョブをキャンセルするために必要なロールを設定します。developer、maintainer、no_oneのいずれかです。GitLab 16.8で導入されました。PremiumおよびUltimateのみです。
ci_pipeline_variables_minimum_override_role文字列いいえ変数をオーバーライドできるロールを指定できます。owner、maintainer、developer、no_one_allowedのいずれかです。GitLab 17.1で導入されました。GitLab 17.1～17.7では、restrict_user_defined_variablesを有効にする必要があります。
ci_push_repository_for_job_token_allowedブール値いいえジョブトークンを使用してプロジェクトリポジトリにプロジェクトをプッシュする機能を有効または無効にします。GitLab 17.2で導入されました。
container_expiration_policy_attributesハッシュいいえこのプロジェクト用のイメージのクリーンアップポリシーを更新します。cadence（文字列）、keep_n（整数）、older_than（文字列）、name_regex（文字列）、name_regex_delete（文字列）、name_regex_keep（文字列）、enabled（ブール値）を指定できます。
container_registry_enabledブール値いいえ_（非推奨）_このプロジェクトのコンテナレジストリを有効にします。代わりにcontainer_registry_access_levelを使用してください。
default_branch文字列いいえデフォルトブランチ名。
description文字列いいえプロジェクトの短い説明。
duo_remote_flows_enabledブール値いいえプロジェクトでフローを実行できるかどうかを決定します。
emails_disabledブール値いいえ_（非推奨）_メール通知を無効にします。代わりにemails_enabledを使用してください。
emails_enabledブール値いいえメール通知を有効にします。
enforce_auth_checks_on_uploadsブール値いいえアップロード時に認証チェックを強制します。
external_authorization_classification_label文字列いいえプロジェクトの分類ラベル。PremiumおよびUltimateのみです。
group_runners_enabledブール値いいえこのプロジェクトのグループRunnerを有効にします。
import_url文字列いいえリポジトリのインポート元URL。
issues_enabledブール値いいえ_（非推奨）_このプロジェクト用にイシューを有効にします。代わりにissues_access_levelを使用してください。
issues_template文字列いいえ新しいイシューのデフォルトの説明。GitLab Flavored Markdownとしてフォーマットされています。PremiumおよびUltimateのみです。
merge_requests_template文字列いいえ新しいマージリクエストのデフォルトの説明。GitLab Flavored Markdownとしてフォーマットされています。PremiumおよびUltimateのみです。
jobs_enabledブール値いいえ_（非推奨）_このプロジェクト用にジョブを有効にします。代わりにbuilds_access_levelを使用してください。
keep_latest_artifactブール値いいえこのプロジェクトの最新のアーティファクトを保持する機能を無効または有効にします。
lfs_enabledブール値いいえLFSを有効にします。
max_artifacts_size整数いいえ個々のジョブアーティファクトの最大ファイルサイズ（MB単位）。
merge_commit_template文字列いいえマージリクエストでマージコミットメッセージを作成するために使用されるテンプレート。
merge_method文字列いいえプロジェクトのマージ方法を設定します。merge（マージコミット）、rebase_merge（半線形履歴を使用するマージコミット）、またはff（早送りマージ）を指定できます。
merge_pipelines_enabledブール値いいえマージ結果パイプラインを有効または無効にします。
merge_requests_enabledブール値いいえ_（非推奨）_このプロジェクト用にマージリクエストを有効にします。代わりにmerge_requests_access_levelを使用してください。
merge_trains_enabledブール値いいえマージトレインを有効または無効にします。
merge_trains_skip_train_allowedブール値いいえパイプラインが完了するのを待たずに、マージトレインマージリクエストをマージできるようにします。
mirror_overwrites_diverged_branchesブール値いいえプルミラーが、分岐したブランチを上書きします。PremiumおよびUltimateのみです。
mirror_trigger_buildsブール値いいえプルミラーリングがビルドをトリガーします。PremiumおよびUltimateのみです。
mirror_user_id整数いいえプルミラーイベントに関連するすべてのアクティビティを担当するユーザー。_（管理者のみ）_PremiumとUltimateプランのみ。
mirrorブール値いいえプロジェクトでプルミラーリングを有効にします。PremiumおよびUltimateのみです。
mr_default_target_selfブール値いいえフォークされたプロジェクトの場合、マージリクエストのターゲットをこのプロジェクトに設定します。falseの場合、ターゲットはアップストリームプロジェクトになります。
name文字列いいえプロジェクト名。
only_allow_merge_if_all_discussions_are_resolvedブール値いいえすべてのディスカッションが解決された場合にのみマージリクエストをマージできるようにするかどうかを設定します。
only_allow_merge_if_pipeline_succeedsブール値いいえマージリクエストを成功したジョブのみとマージできるようにするかどうかを設定します。
only_mirror_protected_branchesブール値いいえ保護ブランチのみをミラーリングします。PremiumおよびUltimateのみです。
packages_enabledブール値いいえGitLab 17.10で非推奨になりました。パッケージリポジトリ機能を有効または無効にします。代わりにpackage_registry_access_levelを使用してください。
package_registry_access_level文字列いいえパッケージリポジトリ機能を有効または無効にします。
path文字列いいえプロジェクトのカスタムリポジトリ名。デフォルトでは、名前に基づいて生成されます。
prevent_merge_without_jira_issueブール値いいえマージリクエストで、Jiraからの関連イシューを必須にするかどうかを設定します。Ultimateのみです。
printing_merge_request_link_enabledブール値いいえコマンドラインからプッシュするときに、マージリクエストを作成/表示するためのリンクを表示します。
protect_merge_request_pipelinesブール値いいえ保護された変数とRunnerへのアクセスを制御を有効または無効にします。
public_buildsブール値いいえ（非推奨）trueの場合、プロジェクトメンバー以外のユーザーもジョブを表示できます。代わりにpublic_jobsを使用してください。
public_jobsブール値いいえtrueの場合、プロジェクトメンバー以外のユーザーもジョブを表示できます。
remove_source_branch_after_mergeブール値いいえすべての新しいマージリクエストに対して、デフォルトでDelete source branchオプションを有効にします。
repository_storage文字列いいえリポジトリが存在するストレージシャード。（管理者のみ）
request_access_enabledブール値いいえユーザーがメンバーアクセスをリクエストできるようにします。
resolve_outdated_diff_discussionsブール値いいえプッシュで変更された行に関するマージリクエスト差分ディスカッションを自動的に解決します。
restrict_user_defined_variablesブール値いいえ_（GitLab 17.7で非推奨となり、ci_pipeline_variables_minimum_override_roleが推奨されます）_パイプラインをトリガーするときに、メンテナーロールを持つユーザーのみがユーザー定義変数を渡せるようにします。たとえば、UIで、APIを使用して、またはトリガートークンにより、パイプラインがトリガーされる場合などです。
service_desk_enabledブール値いいえサービスデスク機能を有効または無効にします。
shared_runners_enabledブール値いいえこのプロジェクト用にインスタンスRunnerを有効にします。
show_default_award_emojisブール値いいえデフォルトの絵文字リアクションを表示します。
snippets_enabledブール値いいえ_（非推奨）_このプロジェクト用にスニペットを有効にします。代わりにsnippets_access_levelを使用してください。
issue_branch_template文字列いいえイシューから作成されたブランチの名前を提案するために使用されるテンプレート。（GitLab 15.6で導入されました）
spp_repository_pipeline_accessブール値いいえユーザーとトークンに、このプロジェクトからセキュリティポリシーの設定をフェッチするための読み取り専用アクセスを許可します。このプロジェクトをセキュリティポリシーソースとして使用するプロジェクトで、セキュリティポリシーを適用するために必要です。Ultimateのみです。
squash_commit_template文字列いいえマージリクエストでスカッシュコミットメッセージを作成するために使用されるテンプレート。
squash_option文字列いいえnever、always、default_on、default_offのいずれかです。
suggestion_commit_message文字列いいえマージリクエストの提案を適用するために使用されるコミットメッセージ。
tag_list配列いいえ_（GitLab 14.0で非推奨になりました）_プロジェクトのタグのリスト。最終的にプロジェクトに割り当てる必要があるタグの配列を指定します。代わりにtopicsを使用してください。
topics配列いいえプロジェクトのトピックのリスト。これにより、プロジェクトにすでに追加されている既存のトピックがすべて置き換えられます。
visibility文字列いいえプロジェクトの表示レベルを参照してください。
warn_about_potentially_unwanted_charactersブール値いいえこのプロジェクトで不要である可能性がある文字の使用に関する警告を有効にします。
wiki_enabledブール値いいえ_（非推奨）_このプロジェクト用にWikiを有効にします。代わりにwiki_access_levelを使用してください。
web_based_commit_signing_enabledブール値いいえGitLab UIから作成されたコミットに対する、Webベースのコミット署名を有効にします。GitLab.comでのみ利用可能です。

たとえば、GitLab.comプロジェクトのインスタンスRunnerの設定を切り替えるには、次のようにします。

curl --request PUT --header "PRIVATE-TOKEN: <your-token>" \
     --url "https://gitlab.com/api/v4/projects/<your-project-ID>" \
     --data "shared_runners_enabled=true" # to turn off: "shared_runners_enabled=false"

個々のプロジェクト機能の表示レベルを設定するには、Project feature visibility levelを参照してください。

メンバーをインポートする

別のプロジェクトからメンバーをインポートします。

ターゲットプロジェクトに対するインポートメンバーのロールによって、次のようになります。

  • メンテナーの場合、ソースプロジェクトのオーナーロールを持つメンバーは、メンテナーロールでインポートされます。
  • オーナーの場合、ソースプロジェクトのオーナーロールを持つメンバーは、オーナーロールでインポートされます。
POST /projects/:id/import_project_members/:project_id

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいメンバーを受け入れるターゲットプロジェクトのIDまたはURLエンコードされたパス。
project_id整数または文字列はいメンバーのインポート元のソースプロジェクトのIDまたはURLエンコードされたパス。

リクエスト例:

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/import_project_members/32"

戻り値:

  • 成功した場合は200 OK。
  • ターゲットプロジェクトまたはソースプロジェクトが存在しないか、リクエスタがアクセスできない場合は、404 Project Not Found。
  • プロジェクトメンバーのインポートが正常に完了しなかった場合は、422 Unprocessable Entity。

レスポンス例:

  • すべてのメールが正常に送信された場合（HTTPステータスコード200）:

    {  "status":  "success"  }

  • 1つ以上のメンバーのインポートでエラーが発生した場合（HTTPステータスコード200）:

    {
  "status": "error",
  "message": {
               "john_smith": "Some individual error message",
               "jane_smith": "Some individual error message"
             },
  "total_members_count": 3
}

  • システムエラーが発生した場合（HTTPステータスコード404および422）:

{  "message":  "Import failed"  }

プロジェクトをアーカイブする

プロジェクトをアーカイブします。

前提条件:

  • 管理者であるか、プロジェクトのオーナーロールが割り当てられている必要があります。

このエンドポイントはべき等です。すでにアーカイブされているプロジェクトをアーカイブしても、プロジェクトは変更されません。

POST /projects/:id/archive

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。

リクエスト例:

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/archive"

レスポンス例:

{
  "id": 3,
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
  "description_html": "<p data-sourcepos=\"1:1-1:56\" dir=\"auto\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
  "default_branch": "main",
  "visibility": "private",
  "ssh_url_to_repo": "git@example.com:diaspora/diaspora-project-site.git",
  "http_url_to_repo": "http://example.com/diaspora/diaspora-project-site.git",
  "web_url": "http://example.com/diaspora/diaspora-project-site",
  "readme_url": "http://example.com/diaspora/diaspora-project-site/blob/main/README.md",
  "tag_list": [ //deprecated, use `topics` instead
    "example",
    "disapora project"
  ],
  "topics": [
    "example",
    "disapora project"
  ],
  "owner": {
    "id": 3,
    "name": "Diaspora",
    "created_at": "2013-09-30T13:46:02Z"
  },
  "name": "Diaspora Project Site",
  "name_with_namespace": "Diaspora / Diaspora Project Site",
  "path": "diaspora-project-site",
  "path_with_namespace": "diaspora/diaspora-project-site",
  "repository_object_format": "sha1",
  "issues_enabled": true,
  "open_issues_count": 1,
  "merge_requests_enabled": true,
  "jobs_enabled": true,
  "wiki_enabled": true,
  "snippets_enabled": false,
  "can_create_merge_request_in": true,
  "resolve_outdated_diff_discussions": false,
  "container_registry_enabled": false, // deprecated, use container_registry_access_level instead
  "container_registry_access_level": "disabled",
  "security_and_compliance_access_level": "disabled",
  "created_at": "2013-09-30T13:46:02Z",
  "updated_at": "2013-09-30T13:46:02Z",
  "last_activity_at": "2013-09-30T13:46:02Z",
  "creator_id": 3,
  "namespace": {
    "id": 3,
    "name": "Diaspora",
    "path": "diaspora",
    "kind": "group",
    "full_path": "diaspora"
  },
  "import_status": "none",
  "import_error": null,
  "permissions": {
    "project_access": {
      "access_level": 10,
      "notification_level": 3
    },
    "group_access": {
      "access_level": 50,
      "notification_level": 3
    }
  },
  "archived": true,
  "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
  "license_url": "http://example.com/diaspora/diaspora-client/blob/main/LICENSE",
  "license": {
    "key": "lgpl-3.0",
    "name": "GNU Lesser General Public License v3.0",
    "nickname": "GNU LGPLv3",
    "html_url": "http://choosealicense.com/licenses/lgpl-3.0/",
    "source_url": "http://www.gnu.org/licenses/lgpl-3.0.txt"
  },
  "shared_runners_enabled": true,
  "group_runners_enabled": true,
  "forks_count": 0,
  "star_count": 0,
  "runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b",
  "ci_default_git_depth": 50,
  "ci_forward_deployment_enabled": true,
  "ci_forward_deployment_rollback_allowed": true,
  "ci_allow_fork_pipelines_to_run_in_parent_project": true,
  "ci_id_token_sub_claim_components": ["project_path", "ref_type", "ref"],
  "ci_separated_caches": true,
  "ci_restrict_pipeline_cancellation_role": "developer",
  "ci_pipeline_variables_minimum_override_role": "maintainer",
  "ci_push_repository_for_job_token_allowed": false,
  "ci_display_pipeline_variables": false,
  "protect_merge_request_pipelines": true,
  "public_jobs": true,
  "shared_with_groups": [],
  "only_allow_merge_if_pipeline_succeeds": false,
  "allow_merge_on_skipped_pipeline": false,
  "allow_pipeline_trigger_approve_deployment": false,
  "restrict_user_defined_variables": false,
  "only_allow_merge_if_all_discussions_are_resolved": false,
  "remove_source_branch_after_merge": false,
  "request_access_enabled": false,
  "merge_method": "merge",
  "squash_option": "default_on",
  "autoclose_referenced_issues": true,
  "enforce_auth_checks_on_uploads": true,
  "suggestion_commit_message": null,
  "merge_commit_template": null,
  "secret_push_protection_enabled": false,
  "container_registry_image_prefix": "registry.example.com/diaspora/diaspora-project-site",
  "_links": {
    "self": "http://example.com/api/v4/projects",
    "issues": "http://example.com/api/v4/projects/1/issues",
    "merge_requests": "http://example.com/api/v4/projects/1/merge_requests",
    "repo_branches": "http://example.com/api/v4/projects/1/repository_branches",
    "labels": "http://example.com/api/v4/projects/1/labels",
    "events": "http://example.com/api/v4/projects/1/events",
    "members": "http://example.com/api/v4/projects/1/members",
    "cluster_agents": "http://example.com/api/v4/projects/1/cluster_agents"
  }
}

プロジェクトのアーカイブを解除する

プロジェクトのアーカイブを解除します。

前提条件:

  • 管理者であるか、プロジェクトのオーナーロールが割り当てられている必要があります。

このエンドポイントはべき等です。アーカイブされていないプロジェクトのアーカイブを解除しても、プロジェクトは変更されません。

POST /projects/:id/unarchive

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。

リクエスト例:

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/unarchive"

レスポンス例:

{
  "id": 3,
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
  "description_html": "<p data-sourcepos=\"1:1-1:56\" dir=\"auto\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
  "default_branch": "main",
  "visibility": "private",
  "ssh_url_to_repo": "git@example.com:diaspora/diaspora-project-site.git",
  "http_url_to_repo": "http://example.com/diaspora/diaspora-project-site.git",
  "web_url": "http://example.com/diaspora/diaspora-project-site",
  "readme_url": "http://example.com/diaspora/diaspora-project-site/blob/main/README.md",
  "tag_list": [ //deprecated, use `topics` instead
    "example",
    "disapora project"
  ],
  "topics": [
    "example",
    "disapora project"
  ],
  "owner": {
    "id": 3,
    "name": "Diaspora",
    "created_at": "2013-09-30T13:46:02Z"
  },
  "name": "Diaspora Project Site",
  "name_with_namespace": "Diaspora / Diaspora Project Site",
  "path": "diaspora-project-site",
  "path_with_namespace": "diaspora/diaspora-project-site",
  "repository_object_format": "sha1",
  "issues_enabled": true,
  "open_issues_count": 1,
  "merge_requests_enabled": true,
  "jobs_enabled": true,
  "wiki_enabled": true,
  "snippets_enabled": false,
  "can_create_merge_request_in": true,
  "resolve_outdated_diff_discussions": false,
  "container_registry_enabled": false, // deprecated, use container_registry_access_level instead
  "container_registry_access_level": "disabled",
  "security_and_compliance_access_level": "disabled",
  "created_at": "2013-09-30T13:46:02Z",
  "updated_at": "2013-09-30T13:46:02Z",
  "last_activity_at": "2013-09-30T13:46:02Z",
  "creator_id": 3,
  "namespace": {
    "id": 3,
    "name": "Diaspora",
    "path": "diaspora",
    "kind": "group",
    "full_path": "diaspora"
  },
  "import_status": "none",
  "import_error": null,
  "permissions": {
    "project_access": {
      "access_level": 10,
      "notification_level": 3
    },
    "group_access": {
      "access_level": 50,
      "notification_level": 3
    }
  },
  "archived": false,
  "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
  "license_url": "http://example.com/diaspora/diaspora-client/blob/main/LICENSE",
  "license": {
    "key": "lgpl-3.0",
    "name": "GNU Lesser General Public License v3.0",
    "nickname": "GNU LGPLv3",
    "html_url": "http://choosealicense.com/licenses/lgpl-3.0/",
    "source_url": "http://www.gnu.org/licenses/lgpl-3.0.txt"
  },
  "shared_runners_enabled": true,
  "group_runners_enabled": true,
  "forks_count": 0,
  "star_count": 0,
  "runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b",
  "ci_default_git_depth": 50,
  "ci_forward_deployment_enabled": true,
  "ci_forward_deployment_rollback_allowed": true,
  "ci_allow_fork_pipelines_to_run_in_parent_project": true,
  "ci_id_token_sub_claim_components": ["project_path", "ref_type", "ref"],
  "ci_separated_caches": true,
  "ci_restrict_pipeline_cancellation_role": "developer",
  "ci_pipeline_variables_minimum_override_role": "maintainer",
  "ci_push_repository_for_job_token_allowed": false,
  "ci_display_pipeline_variables": false,
  "protect_merge_request_pipelines": true,
  "public_jobs": true,
  "shared_with_groups": [],
  "only_allow_merge_if_pipeline_succeeds": false,
  "allow_merge_on_skipped_pipeline": false,
  "allow_pipeline_trigger_approve_deployment": false,
  "restrict_user_defined_variables": false,
  "only_allow_merge_if_all_discussions_are_resolved": false,
  "remove_source_branch_after_merge": false,
  "request_access_enabled": false,
  "merge_method": "merge",
  "squash_option": "default_on",
  "autoclose_referenced_issues": true,
  "enforce_auth_checks_on_uploads": true,
  "suggestion_commit_message": null,
  "merge_commit_template": null,
  "container_registry_image_prefix": "registry.example.com/diaspora/diaspora-project-site",
  "secret_push_protection_enabled": false,
  "_links": {
    "self": "http://example.com/api/v4/projects",
    "issues": "http://example.com/api/v4/projects/1/issues",
    "merge_requests": "http://example.com/api/v4/projects/1/merge_requests",
    "repo_branches": "http://example.com/api/v4/projects/1/repository_branches",
    "labels": "http://example.com/api/v4/projects/1/labels",
    "events": "http://example.com/api/v4/projects/1/events",
    "members": "http://example.com/api/v4/projects/1/members",
    "cluster_agents": "http://example.com/api/v4/projects/1/cluster_agents"
  }
}

プロジェクトを削除する

前提条件:

  • 管理者であるか、プロジェクトのオーナーロールを持っている必要があります。

プロジェクトを削除対象としてマークします。プロジェクトは保持期間の終了時に削除されます:

  • GitLab.comでは、プロジェクトは30日間保持されます。
  • GitLab Self-Managedでは、保持期間はインスタンスの設定によって制御されます。

このエンドポイントは、以前に削除対象としてマークされたプロジェクトをすぐに削除することもできます。

DELETE /projects/:id

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
full_path文字列いいえpermanently_removeで使用するプロジェクトのフルパス。GitLab 15.11でPremiumおよびUltimate限定で導入され、18.0でGitLab Freeに移行されました。プロジェクトパスを確認するには、単一プロジェクトの取得のpath_with_namespaceを使用します。
permanently_removeブール値/文字列いいえ削除対象としてマークされているプロジェクトを即時削除します。GitLab 15.11でPremiumおよびUltimate限定で導入され、18.0でGitLab Freeに移行されました。GitLab.comおよびDedicatedでは無効になっています。

削除対象としてマークされているプロジェクトを復元する

削除対象としてマークされているプロジェクトを復元します。

POST /projects/:id/restore

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。

プロジェクトを新しいネームスペースに転送する

プロジェクトを新しいネームスペースに転送します。

プロジェクトの転送に必要な前提条件については、プロジェクトを別のネームスペースに転送を参照してください。

PUT /projects/:id/transfer

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
namespace整数または文字列はいプロジェクトの転送先のネームスペースのIDまたはパス。

リクエスト例:

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/transfer?namespace=14"

レスポンス例:

  {
  "id": 7,
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
  "description_html": "<p data-sourcepos=\"1:1-1:56\" dir=\"auto\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
  "name": "hello-world",
  "name_with_namespace": "cute-cats / hello-world",
  "path": "hello-world",
  "path_with_namespace": "cute-cats/hello-world",
  "created_at": "2020-10-15T16:25:22.415Z",
  "updated_at": "2020-10-15T16:25:22.415Z",
  "default_branch": "main",
  "tag_list": [], //deprecated, use `topics` instead
  "topics": [],
  "ssh_url_to_repo": "git@gitlab.example.com:cute-cats/hello-world.git",
  "http_url_to_repo": "https://gitlab.example.com/cute-cats/hello-world.git",
  "web_url": "https://gitlab.example.com/cute-cats/hello-world",
  "readme_url": "https://gitlab.example.com/cute-cats/hello-world/-/blob/main/README.md",
  "avatar_url": null,
  "forks_count": 0,
  "star_count": 0,
  "last_activity_at": "2020-10-15T16:25:22.415Z",
  "namespace": {
    "id": 18,
    "name": "cute-cats",
    "path": "cute-cats",
    "kind": "group",
    "full_path": "cute-cats",
    "parent_id": null,
    "avatar_url": null,
    "web_url": "https://gitlab.example.com/groups/cute-cats"
  },
  "container_registry_image_prefix": "registry.example.com/cute-cats/hello-world",
  "_links": {
    "self": "https://gitlab.example.com/api/v4/projects/7",
    "issues": "https://gitlab.example.com/api/v4/projects/7/issues",
    "merge_requests": "https://gitlab.example.com/api/v4/projects/7/merge_requests",
    "repo_branches": "https://gitlab.example.com/api/v4/projects/7/repository/branches",
    "labels": "https://gitlab.example.com/api/v4/projects/7/labels",
    "events": "https://gitlab.example.com/api/v4/projects/7/events",
    "members": "https://gitlab.example.com/api/v4/projects/7/members"
  },
  "packages_enabled": true, // deprecated, use package_registry_access_level instead
  "package_registry_access_level": "enabled",
  "empty_repo": false,
  "archived": false,
  "visibility": "private",
  "resolve_outdated_diff_discussions": false,
  "container_registry_enabled": true, // deprecated, use container_registry_access_level instead
  "container_registry_access_level": "enabled",
  "container_expiration_policy": {
    "cadence": "7d",
    "enabled": false,
    "keep_n": null,
    "older_than": null,
    "name_regex": null,
    "name_regex_keep": null,
    "next_run_at": "2020-10-22T16:25:22.746Z"
  },
  "issues_enabled": true,
  "merge_requests_enabled": true,
  "wiki_enabled": true,
  "jobs_enabled": true,
  "snippets_enabled": true,
  "service_desk_enabled": false,
  "service_desk_address": null,
  "can_create_merge_request_in": true,
  "issues_access_level": "enabled",
  "repository_access_level": "enabled",
  "merge_requests_access_level": "enabled",
  "forking_access_level": "enabled",
  "analytics_access_level": "enabled",
  "wiki_access_level": "enabled",
  "builds_access_level": "enabled",
  "snippets_access_level": "enabled",
  "pages_access_level": "enabled",
  "security_and_compliance_access_level": "enabled",
  "emails_disabled": null,
  "emails_enabled": null,
  "shared_runners_enabled": true,
  "group_runners_enabled": true,
  "lfs_enabled": true,
  "creator_id": 2,
  "import_status": "none",
  "open_issues_count": 0,
  "ci_default_git_depth": 50,
  "public_jobs": true,
  "build_timeout": 3600,
  "auto_cancel_pending_pipelines": "enabled",
  "ci_config_path": null,
  "shared_with_groups": [],
  "only_allow_merge_if_pipeline_succeeds": false,
  "allow_merge_on_skipped_pipeline": null,
  "allow_pipeline_trigger_approve_deployment": false,
  "restrict_user_defined_variables": false,
  "request_access_enabled": true,
  "only_allow_merge_if_all_discussions_are_resolved": false,
  "remove_source_branch_after_merge": true,
  "printing_merge_request_link_enabled": true,
  "merge_method": "merge",
  "squash_option": "default_on",
  "suggestion_commit_message": null,
  "merge_commit_template": null,
  "auto_devops_enabled": true,
  "auto_devops_deploy_strategy": "continuous",
  "autoclose_referenced_issues": true,
  "approvals_before_merge": 0, // Deprecated. Use merge request approvals API instead.
  "mirror": false,
  "compliance_frameworks": [],
  "warn_about_potentially_unwanted_characters": true,
  "secret_push_protection_enabled": false
}

プロジェクト転送に利用可能なグループのリストを取得する

ユーザーがプロジェクトを転送できる転送先グループのリストを取得します。

GET /projects/:id/transfer_locations

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
search文字列いいえ検索するグループ名。

リクエスト例:

curl --url "https://gitlab.example.com/api/v4/projects/1/transfer_locations"

レスポンス例:

[
  {
    "id": 27,
    "web_url": "https://gitlab.example.com/groups/gitlab",
    "name": "GitLab",
    "avatar_url": null,
    "full_name": "GitLab",
    "full_path": "GitLab"
  },
  {
    "id": 31,
    "web_url": "https://gitlab.example.com/groups/foobar",
    "name": "FooBar",
    "avatar_url": null,
    "full_name": "FooBar",
    "full_path": "FooBar"
  }
]

プロジェクトアバターをアップロードする

指定されたプロジェクトにアバターをアップロードします。

PUT /projects/:id

前提条件:

  • プロジェクトのメンテナーまたはオーナーロールを持っている必要があります。
  • ファイルのサイズは200 KB以下である必要があります。理想的な画像サイズは192 x 192ピクセルです。
  • 画像は、次のいずれかのファイル形式である必要があります。
    • .bmp
    • .gif
    • .ico
    • .jpeg
    • .png
    • .tiff

サポートされている属性は以下のとおりです:

属性型必須説明
avatar文字列はいアップロードするファイル。
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。

ファイルシステムからアバターをアップロードするには、--form引数を使用します。これにより、cURLはヘッダーContent-Type: multipart/form-dataを使用してデータを送信します。avatar=パラメータは、ファイルシステムの画像ファイルを指しており、先頭に@を付ける必要があります。

リクエスト例:

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5" \
  --form "avatar=@dk.png"

レスポンス例:

{
  "avatar_url": "https://gitlab.example.com/uploads/-/system/project/avatar/2/dk.png"
}

プロジェクトアバターをダウンロードする

プロジェクトアバターをダウンロードします。プロジェクトが公開されている場合、このエンドポイントには認証なしでアクセスできます。

GET /projects/:id/avatar

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/4/avatar"

プロジェクトアバターを削除する

プロジェクトアバターを削除するには、avatar属性に空白の値を指定します。

リクエスト例:

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
     --data "avatar=" "https://gitlab.example.com/api/v4/projects/5"

プロジェクトを共有する

プロジェクトをグループと共有します。

詳細については、Invite a group to a projectを参照してください。

プロジェクトをグループと共有する

プロジェクトをグループと共有します。

POST /projects/:id/share

サポートされている属性は以下のとおりです:

属性型必須説明
group_access整数はいグループに付与するアクセスレベル。使用可能な値: 5 (最小アクセス)、10 (ゲスト)、15 (プランナー)、20 (レポーター)、30 (デベロッパー)、40 (メンテナー)、または50 (オーナー)。
group_id整数はい共有するグループのID。
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
expires_at文字列いいえISO 8601形式での共有有効期限。例: 2016-09-26。

グループからプロジェクトの共有を解除します。成功すると204が返されますが、コンテンツは返されません。

DELETE /projects/:id/share/:group_id

サポートされている属性は以下のとおりです:

属性型必須説明
group_id整数はいグループのID。
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。

リクエスト例:

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/share/17"

プロジェクトのハウスキーピングタスクを開始する

プロジェクトのハウスキーピングタスクを開始します。

POST /projects/:id/housekeeping

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
task文字列いいえ到達不能なオブジェクトの手動プルーニングをトリガーする場合はprune、積極的なハウスキーピングをトリガーする場合はeager。

リアルタイムセキュリティスキャン

  • プラン: Ultimate
  • 提供形態: GitLab.com
  • ステータス: 実験的機能

リアルタイムで1つのファイルのSASTスキャン結果を返します。

POST /projects/:id/security_scans/sast/scan

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。

リクエスト例:

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
 --header "Content-Type: application/json" \
 --data '{
  "file_path":"src/main.c",
  "content":"#include<string.h>\nint main(int argc, char **argv) {\n  char buff[128];\n  strcpy(buff, argv[1]);\n  return 0;\n}\n"
 }' \
 --url "https://gitlab.example.com/api/v4/projects/:id/security_scans/sast/scan"

レスポンス例:

{
  "vulnerabilities": [
    {
      "name": "Insecure string processing function (strcpy)",
      "description": "The `strcpy` family of functions do not provide the ability to limit or check buffer\nsizes before copying to a destination buffer. This can lead to buffer overflows. Consider\nusing more secure alternatives such as `strncpy` and provide the correct limit to the\ndestination buffer and ensure the string is null terminated.\n\nFor more information please see: https://linux.die.net/man/3/strncpy\n\nIf developing for C Runtime Library (CRT), more secure versions of these functions should be\nused, see:\nhttps://learn.microsoft.com/en-us/cpp/c-runtime-library/reference/strncpy-s-strncpy-s-l-wcsncpy-s-wcsncpy-s-l-mbsncpy-s-mbsncpy-s-l?view=msvc-170\n",
      "severity": "High",
      "location": {
        "file": "src/main.c",
        "start_line": 5,
        "end_line": 5,
        "start_column": 3,
        "end_column": 23
      }
    }
  ]
}

Gitリポジトリのスナップショットをダウンロードする

このエンドポイントには、管理者のみがアクセスできます。

プロジェクト（またはリクエストされた場合はWiki）のGitリポジトリのスナップショットをダウンロードします。このスナップショットは、常に非圧縮のtar形式です。

リポジトリが破損してgit cloneが機能しない場合でも、スナップショットを使用すると、一部のデータを取得できる場合があります。

GET /projects/:id/snapshot

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
wikiブール値いいえプロジェクトリポジトリではなく、Wikiをダウンロードするかどうか。

リポジトリストレージへのパスを取得する

指定されたプロジェクトのリポジトリストレージへのパスを取得します。Gitaly Cluster（Praefect）を使用している場合は、代わりにPraefectによって生成されたレプリカパスを参照してください。

管理者のみが利用できます。

GET /projects/:id/storage

サポートされている属性は以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
[
  {
    "project_id": 1,
    "disk_path": "@hashed/6b/86/6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b",
    "created_at": "2012-10-12T17:04:47Z",
    "repository_storage": "default"
  }
]

シークレットプッシュ保護のステータス

  • プラン: Ultimate

デベロッパー、メンテナー、またはオーナーロールを持っている場合、以下のリクエストもsecret_push_protection_enabledの値を返す可能性があります。これらのリクエストの一部には、ロールに関するより厳格な要件があります。詳細については、前述のエンドポイントを参照してください。この情報を使用して、プロジェクトに対してシークレットプッシュ保護が有効になっているかどうかを判断します。secret_push_protection_enabledの値を変更するには、プロジェクトセキュリティ設定APIを使用してください。

  • GET /projects
  • GET /projects/:id
  • GET /users/:user_id/projects
  • GET /users/:user_id/contributed_projects
  • PUT /projects/:project_id/transfer?namespace=:namespace_id
  • PUT /projects/:id
  • POST /projects
  • POST /projects/user/:user_id
  • POST /projects/:id/archive
  • POST /projects/:id/unarchive

レスポンス例:

{
  "id": 1,
  "project_id": 3,
  "secret_push_protection_enabled": true,
  ...
}

トラブルシューティング

応答の予期しないrestrict_user_defined_variables値

restrict_user_defined_variablesとci_pipeline_variables_minimum_override_roleに競合する値を設定すると、pipeline_variables_minimum_override_role設定の方が優先順位が高いため、応答の値が予期される値と異なる場合があります。

たとえば、次のような場合が該当します。

  • restrict_user_defined_variablesをtrue、ci_pipeline_variables_minimum_override_roleをdeveloperに設定すると、応答はrestrict_user_defined_variables: falseを返します。ci_pipeline_variables_minimum_override_roleをdeveloperに設定すると、優先され、変数は制限されません。
  • restrict_user_defined_variablesをfalse、ci_pipeline_variables_minimum_override_roleをmaintainerに設定すると、応答はrestrict_user_defined_variables: trueを返します。ci_pipeline_variables_minimum_override_roleをmaintainerに設定すると優先され、変数が制限されるためです。