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

ブランチAPI

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

ブランチAPIを使用すると、プロジェクトのGitブランチをプログラムで管理できます。

プロジェクト用に設定されたブランチ保護を変更するには、保護ブランチAPIを使用します。

リポジトリブランチをリストする

プロジェクトから、名前でアルファベット順にソートされたリポジトリブランチのリストを取得します。名前で検索するか、正規表現を使用して特定のブランチパターンを検索します。保護ステータス、マージステータス、コミットの詳細など、ブランチに関する詳細な情報を返します。

リポジトリが公開されている場合、このエンドポイントには認証なしでアクセスできます。

GET /projects/:id/repository/branches

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

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
regex文字列いいえre2正規表現に一致する名前のブランチのリストを返します。searchと一緒に使用することはできません。
search文字列いいえ検索文字列を含むブランチのリストを返します。termで始まるブランチを検索するには^termを使用し、termで終わるブランチを検索するにはterm$を使用します。

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

属性型説明
can_pushブール値trueの場合、認証済みユーザーは、このブランチにプッシュできます。
commitオブジェクトブランチ上の最新のコミットに関する詳細。
commit.author_email文字列変更を作成者したユーザーのメールアドレス。
commit.author_name文字列変更を作成者したユーザーの名前。
commit.authored_date日時（ISO 8601）コミットが作成された日時。
commit.committed_date日時（ISO 8601）コミットがコミットされた日時。
commit.committer_email文字列変更をコミットしたユーザーのメールアドレス。
commit.committer_name文字列変更をコミットしたユーザーの名前。
commit.created_at日時（ISO 8601）コミットが作成された日時。
commit.extended_trailersオブジェクトコミットメッセージから解析された拡張Gitトレーラー。
commit.id文字列コミットの完全なSHA。
commit.message文字列完全なコミットメッセージ。
commit.parent_ids配列親コミットSHAの配列。
commit.short_id文字列コミットの省略されたSHA。
commit.title文字列コミットメッセージのタイトル。
commit.trailersオブジェクトコミットメッセージから解析されたGitトレーラー。
commit.web_url文字列GitLab UIでコミットを表示するためのURL。
defaultブール値trueの場合、ブランチはプロジェクトのデフォルトブランチです。
developers_can_mergeブール値trueの場合、少なくともデベロッパーロールを持つユーザーは、このブランチにマージできます。
developers_can_pushブール値trueの場合、少なくともデベロッパーロールを持つユーザーは、このブランチにプッシュできます。
mergedブール値trueの場合、ブランチはデフォルトブランチにマージされています。
name文字列ブランチの名前。
protectedブール値trueの場合、ブランチは強制プッシュと削除から保護されています。
web_url文字列GitLab UIでブランチを表示するためのURL。

リクエスト例:

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

レスポンス例:

[
  {
    "name": "main",
    "merged": false,
    "protected": true,
    "default": true,
    "developers_can_push": false,
    "developers_can_merge": false,
    "can_push": true,
    "web_url": "https://gitlab.example.com/my-group/my-project/-/tree/main",
    "commit": {
      "id": "7b5c3cc8be40ee161ae89a06bba6229da1032a0c",
      "short_id": "7b5c3cc",
      "created_at": "2024-06-28T03:44:20-07:00",
      "parent_ids": [
        "4ad91d3c1144c406e50c7b33bae684bd6837faf8"
      ],
      "title": "add projects API",
      "message": "add projects API",
      "author_name": "John Smith",
      "author_email": "john@example.com",
      "authored_date": "2024-06-27T05:51:39-07:00",
      "committer_name": "John Smith",
      "committer_email": "john@example.com",
      "committed_date": "2024-06-28T03:44:20-07:00",
      "trailers": {},
      "extended_trailers": {},
      "web_url": "https://gitlab.example.com/my-group/my-project/-/commit/7b5c3cc8be40ee161ae89a06bba6229da1032a0c"
    }
  },
  ...
]

1つのリポジトリブランチを取得する

1つのプロジェクトリポジトリブランチを取得します。

リポジトリが公開されている場合、このエンドポイントには認証なしでアクセスできます。

GET /projects/:id/repository/branches/:branch

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

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

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

属性型説明
can_pushブール値認証済みユーザーがこのブランチにプッシュできるかどうか。
commitオブジェクトブランチ上の最新コミットの詳細。
commit.author_email文字列コミットの作成者のメールアドレス。
commit.author_name文字列コミットの作成者名。
commit.authored_date文字列コミットがISO 8601形式で作成された日時。
commit.committer_email文字列変更をコミットしたユーザーのメールアドレス。
commit.committer_name文字列変更をコミットしたユーザーの名前。
commit.committed_date文字列コミットがISO 8601形式でコミットされた日時。
commit.created_at文字列コミットがISO 8601形式で作成された日時。
commit.extended_trailersオブジェクトコミットメッセージから解析された拡張Gitトレーラー。
commit.id文字列コミットの完全なSHA。
commit.message文字列完全なコミットメッセージ。
commit.parent_ids配列親コミットSHAの配列。
commit.short_id文字列コミットの省略されたSHA。
commit.title文字列コミットメッセージのタイトル。
commit.trailersオブジェクトコミットメッセージから解析されたGitトレーラー。
commit.web_url文字列GitLab UIでコミットを表示するためのURL。
defaultブール値これがプロジェクトのデフォルトブランチであるかどうか。
developers_can_mergeブール値デベロッパーロールを持つユーザーがこのブランチにマージできるかどうか。
developers_can_pushブール値デベロッパーロールを持つユーザーがこのブランチにプッシュできるかどうか。
mergedブール値ブランチがデフォルトブランチにマージされたかどうか。
name文字列ブランチの名前。
protectedブール値ブランチが強制プッシュと削除から保護されているかどうか。
web_url文字列GitLab UIでブランチを表示するためのURL。

リクエスト例:

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

レスポンス例:

{
  "name": "main",
  "merged": false,
  "protected": true,
  "default": true,
  "developers_can_push": false,
  "developers_can_merge": false,
  "can_push": true,
  "web_url": "https://gitlab.example.com/my-group/my-project/-/tree/main",
  "commit": {
    "id": "7b5c3cc8be40ee161ae89a06bba6229da1032a0c",
    "short_id": "7b5c3cc",
    "created_at": "2012-06-28T03:44:20-07:00",
    "parent_ids": [
      "4ad91d3c1144c406e50c7b33bae684bd6837faf8"
    ],
    "title": "add projects API",
    "message": "add projects API",
    "author_name": "John Smith",
    "author_email": "john@example.com",
    "authored_date": "2012-06-27T05:51:39-07:00",
    "committer_name": "John Smith",
    "committer_email": "john@example.com",
    "committed_date": "2012-06-28T03:44:20-07:00",
    "trailers": {},
    "extended_trailers": {},
    "web_url": "https://gitlab.example.com/my-group/my-project/-/commit/7b5c3cc8be40ee161ae89a06bba6229da1032a0c"
  }
}

リポジトリブランチを保護する

リポジトリブランチの保護については、POST /projects/:id/protected_branchesを参照してください。

リポジトリブランチの保護を解除する

リポジトリブランチの保護の解除については、DELETE /projects/:id/protected_branches/:nameを参照してください。

リポジトリブランチを作成する

リポジトリに新しいブランチを作成します。

POST /projects/:id/repository/branches

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

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
branch文字列はいブランチの名前。スペースまたは特殊文字（ハイフンとアンダースコアを除く）を含めることはできません。
ref文字列はいブランチの作成元となるブランチ名またはコミット 。

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

属性型説明
can_pushブール値trueの場合、認証済みユーザーは、このブランチにプッシュできます。
commitオブジェクトブランチ上の最新コミットの詳細。
commit.author_email文字列コミットの作成者のメールアドレス。
commit.author_name文字列コミットの作成者名。
commit.authored_date文字列コミットが8601形式で作成された日時。
commit.committed_date文字列コミットが8601形式でコミットされた日時。
commit.committer_email文字列変更をコミットしたユーザーのメールアドレス。
commit.committer_name文字列変更をコミットしたユーザーの名前。
commit.created_at文字列コミットが8601形式で作成された日時。
commit.extended_trailersオブジェクトコミットメッセージから解析された拡張Gitトレーラー。
commit.id文字列コミットの完全なSHA。
commit.message文字列完全なコミットメッセージ。
commit.parent_ids配列親コミットSHAの配列。
commit.short_id文字列コミットの省略されたSHA。
commit.title文字列コミットメッセージのタイトル。
commit.trailersオブジェクトコミットメッセージから解析されたGitトレーラー。
commit.web_url文字列GitLab UIでコミットを表示するためのURL。
defaultブール値trueの場合、このブランチをプロジェクトのデフォルトブランチとして設定します。
developers_can_mergeブール値trueの場合、デベロッパーロールを持つユーザーは、このブランチにマージできます。
developers_can_pushブール値trueの場合、デベロッパーロールを持つユーザーは、このブランチにプッシュできます。
mergedブール値trueの場合、ブランチはデフォルトブランチにマージされました。
name文字列ブランチの名前。
protectedブール値trueの場合、ブランチは強制プッシュと削除から保護されています。
web_url文字列GitLab UIでブランチを表示するためのURL。

リクエスト例:

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/repository/branches?branch=newbranch&ref=main"

レスポンス例:

{
  "commit": {
    "id": "7b5c3cc8be40ee161ae89a06bba6229da1032a0c",
    "short_id": "7b5c3cc",
    "created_at": "2012-06-28T03:44:20-07:00",
    "parent_ids": [
      "4ad91d3c1144c406e50c7b33bae684bd6837faf8"
    ],
    "title": "add projects API",
    "message": "add projects API",
    "author_name": "John Smith",
    "author_email": "john@example.com",
    "authored_date": "2012-06-27T05:51:39-07:00",
    "committer_name": "John Smith",
    "committer_email": "john@example.com",
    "committed_date": "2012-06-28T03:44:20-07:00",
    "trailers": {},
    "extended_trailers": {},
    "web_url": "https://gitlab.example.com/my-group/my-project/-/commit/7b5c3cc8be40ee161ae89a06bba6229da1032a0c"
  },
  "name": "newbranch",
  "merged": false,
  "protected": false,
  "default": false,
  "developers_can_push": false,
  "developers_can_merge": false,
  "can_push": true,
  "web_url": "https://gitlab.example.com/my-group/my-project/-/tree/newbranch"
}

リポジトリブランチを削除する

リポジトリからブランチを削除します。

エラーが発生した場合、説明メッセージが表示されます。

DELETE /projects/:id/repository/branches/:branch

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

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
branch文字列はいブランチのURLエンコードされた名前。デフォルトブランチまたは保護ブランチを削除することはできません。

成功すると、204 No Contentを返します。

リクエスト例:

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

ブランチを削除しても、関連するすべてのデータが完全に消去されるわけではありません。プロジェクトの履歴を維持し、リカバリープロセスをサポートするために、一部の情報が保持されます。詳細については、機密情報を処理するを参照してください。

マージ済みブランチを削除する

プロジェクトのデフォルトブランチにマージされたブランチをすべてを削除します。

この操作では、保護ブランチは削除されません。

DELETE /projects/:id/repository/merged_branches

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

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

成功すると、202 Acceptedを返します。

リクエスト例:

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