プロジェクトバッジAPI

プレースホルダトークン

バッジは、リンクと画像URLの両方でリアルタイムに置換されるプレースホルダをサポートしています。許可されるプレースホルダは次のとおりです：

  • project_path}：プロジェクトパスに置き換えられます。
  • %{project_title}：プロジェクトのタイトルで置き換えられます。
  • project_name}：プロジェクト名に置き換えられます。
  • %{project_id}：プロジェクトIDに置き換えられます。
  • %{default_branch}：プロジェクトのデフォルト・ブランチに置き換えられます。
  • commit_sha}：プロジェクトの最後のコミットSHAに置き換えられます。

プロジェクトのすべてのバッジをリストします。

プロジェクトのバッジとそのグループのバッジの一覧を取得します。

GET /projects/:id/badges
属性種類必須説明
id整数/文字列yes認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
name文字列です。いいえ返すバッジの名前（大文字と小文字を区別します）。
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges?name=Coverage"

応答例

[
  {
    "name": "Coverage",
    "id": 1,
    "link_url": "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}",
    "image_url": "https://shields.io/my/badge",
    "rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master",
    "rendered_image_url": "https://shields.io/my/badge",
    "kind": "project"
  },
  {
    "name": "Pipeline",
    "id": 2,
    "link_url": "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}",
    "image_url": "https://shields.io/my/badge",
    "rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master",
    "rendered_image_url": "https://shields.io/my/badge",
    "kind": "group"
  }
]

プロジェクトのバッジの取得

プロジェクトのバッジを取得します。

GET /projects/:id/badges/:badge_id
属性種類必須説明
id整数/文字列yes認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
badge_id整数。yesバッジID
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"

応答例

{
  "name": "Coverage",
  "id": 1,
  "link_url": "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}",
  "image_url": "https://shields.io/my/badge",
  "rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master",
  "rendered_image_url": "https://shields.io/my/badge",
  "kind": "project"
}

プロジェクトにバッジを追加します。

プロジェクトにバッジを追加します。

POST /projects/:id/badges
属性種類必須説明
id整数/文字列yes認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
link_url文字列です。yesバッジリンクのURL
image_url文字列です。yesバッジ画像のURL
name文字列です。いいえバッジの名前
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     --data "link_url=https://gitlab.com/gitlab-org/gitlab-foss/commits/master&image_url=https://shields.io/my/badge1&name=mybadge" \
     "https://gitlab.example.com/api/v4/projects/:id/badges"

応答例

{
  "id": 1,
  "name": "mybadge",
  "link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master",
  "image_url": "https://shields.io/my/badge1",
  "rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master",
  "rendered_image_url": "https://shields.io/my/badge1",
  "kind": "project"
}

プロジェクトのバッジの編集

プロジェクトのバッジを更新します。

PUT /projects/:id/badges/:badge_id
属性種類必須説明
id整数/文字列yes認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
badge_id整数。yesバッジID
link_url文字列です。いいえバッジリンクのURL
image_url文字列です。いいえバッジ画像のURL
name文字列です。いいえバッジの名前
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"

応答例

{
  "id": 1,
  "name": "mybadge",
  "link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master",
  "image_url": "https://shields.io/my/badge",
  "rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master",
  "rendered_image_url": "https://shields.io/my/badge",
  "kind": "project"
}

プロジェクトからバッジを削除します。

プロジェクトからバッジを削除します。このエンドポイントを使用して削除されるのはプロジェクトバッジのみです。

DELETE /projects/:id/badges/:badge_id
属性種類必須説明
id整数/文字列yes認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
badge_id整数。yesバッジID
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"

プロジェクトからのバッジのプレビュー

プレースホルダの補間を解決した後のlink_url とimage_url の最終的な URL を返します。

GET /projects/:id/badges/render
属性種類必須説明
id整数/文字列yes認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
link_url文字列です。yesバッジリンクのURL
image_url文字列です。yesバッジ画像のURL
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/render?link_url=http%3A%2F%2Fexample.com%2Fci_status.svg%3Fproject%3D%25%7Bproject_path%7D%26ref%3D%25%7Bdefault_branch%7D&image_url=https%3A%2F%2Fshields.io%2Fmy%2Fbadge"

応答例

{
  "link_url": "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}",
  "image_url": "https://shields.io/my/badge",
  "rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master",
  "rendered_image_url": "https://shields.io/my/badge"
}