プロジェクトバッジAPI

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

このAPIを使用して、プロジェクトバッジを管理およびレビューします。

バッジには、リンクとイメージのURLの両方で置き換えられるプレースホルダーを含めることができます。使用できるプレースホルダーは次のとおりです:

%{project_path}: プロジェクトパスに置き換えられます。
%{project_title}: プロジェクトのタイトルに置き換えられます。
%{project_name}: プロジェクト名に置き換えられます。
%{project_id}: プロジェクトIDに置き換えられます。
%{project_namespace}: プロジェクトのネームスペースのフルパスに置き換えられます。
%{group_name}: プロジェクトのトップレベルグループ名に置き換えられます。
%{gitlab_server}: プロジェクトのサーバー名に置き換えられます。
%{gitlab_pages_domain}: GitLab Pagesをホストするドメイン名に置き換えられます。
%{default_branch}: プロジェクトのデフォルトブランチに置き換えられます。
%{commit_sha}: プロジェクトの最後のコミットSHAに置き換えられます。
%{latest_tag}: プロジェクトの最後のタグに置き換えられます。

プロジェクトのすべてのバッジをリスト表示する

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

GET /projects/:id/badges

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス
`name`	文字列	いいえ	返すバッジの名前（大文字と小文字を区別）。

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "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=main",
    "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=main",
    "rendered_image_url": "https://shields.io/my/badge",
    "kind": "group"
  }
]

プロジェクトのバッジを取得する

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

GET /projects/:id/badges/:badge_id

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

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "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=main",
  "rendered_image_url": "https://shields.io/my/badge",
  "kind": "project"
}

プロジェクトにバッジを追加する

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

POST /projects/:id/badges

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス
`link_url`	文字列	はい	バッジリンクのURL
`image_url`	文字列	はい	バッジイメージのURL
`name`	文字列	いいえ	バッジの名前

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --data "link_url=https://gitlab.com/gitlab-org/gitlab-foss/commits/main&image_url=https://shields.io/my/badge1&name=mybadge" \
  --url "https://gitlab.example.com/api/v4/projects/:id/badges"

レスポンス例:

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

プロジェクトのバッジを編集する

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

PUT /projects/:id/badges/:badge_id

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス
`badge_id`	整数	はい	バッジID
`link_url`	文字列	いいえ	バッジリンクのURL
`image_url`	文字列	いいえ	バッジイメージのURL
`name`	文字列	いいえ	バッジの名前

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "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/main",
  "image_url": "https://shields.io/my/badge",
  "rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/main",
  "rendered_image_url": "https://shields.io/my/badge",
  "kind": "project"
}

プロジェクトからバッジを削除する

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

DELETE /projects/:id/badges/:badge_id

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

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"

プロジェクトからバッジをプレビューする

プレースホルダー補間の解決後、link_urlとimage_urlの最終的なURLがどうなるかを返します。

GET /projects/:id/badges/render

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス
`link_url`	文字列	はい	バッジリンクのURL
`image_url`	文字列	はい	バッジイメージのURL

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "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=main",
  "rendered_image_url": "https://shields.io/my/badge"
}