그룹 배지 API

Tier: Free, Premium, Ultimate

Offering: GitLab.com, Self-managed, GitLab Dedicated

자리 표시자 토큰

배지는 링크와 이미지 URL 모두에서 실시간으로 교체되는 자리 표시자를 지원합니다. 허용되는 자리 표시자는 다음과 같습니다:

  • %{project_path}: 프로젝트 경로로 교체됩니다.
  • %{project_title}: 프로젝트 제목으로 교체됩니다.
  • %{project_name}: 프로젝트 이름으로 교체됩니다.
  • %{project_id}: 프로젝트 ID로 교체됩니다.
  • %{project_namespace}: 프로젝트의 네임스페이스 전체 경로로 교체됩니다.
  • %{group_name}: 프로젝트의 그룹 이름으로 교체됩니다.
  • %{gitlab_server}: 프로젝트의 서버 이름으로 교체됩니다.
  • %{gitlab_pages_domain}: 프로젝트의 도메인 이름으로 교체됩니다.
  • %{default_branch}: 프로젝트의 기본 브랜치로 교체됩니다.
  • %{commit_sha}: 프로젝트의 마지막 커밋 SHA로 교체됩니다.
  • %{latest_tag}: 프로젝트의 마지막 태그로 교체됩니다.

이 엔드포인트는 프로젝트의 컨텍스트 내에 없기 때문에, 자리 표시자를 교체하는 데 사용되는 정보는 생성 날짜에 따라 첫 번째 그룹의 프로젝트에서 가져옵니다. 그룹에 프로젝트가 없으면 자리 표시자가 있는 원본 URL이 반환됩니다.

그룹의 모든 배지 목록

그룹의 배지 목록을 가져옵니다.

GET /groups/:id/badges
속성 유형 필수 설명
id 정수/문자열 예 그룹의 ID 또는 URL 인코딩 경로
name 문자열 아니오 반환할 배지의 이름(대소문자 구분). 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/: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": "group"
  }
]

그룹의 배지 가져오기

그룹의 배지를 가져옵니다.

GET /groups/:id/badges/:badge_id
속성 유형 필수 설명
id 정수/문자열 예 그룹의 ID 또는 URL 인코딩 경로
badge_id 정수 예 배지 ID 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/: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": "group"
}

그룹에 배지 추가

그룹에 배지를 추가합니다.

POST /groups/:id/badges
속성 유형 필수 여부 설명
id integer/string 예 그룹의 ID 또는 URL 인코딩 경로
link_url string 예 배지 링크의 URL
image_url string 예 배지 이미지의 URL
name string 아니오 배지의 이름 
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&position=0" \
     "https://gitlab.example.com/api/v4/groups/: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": "group"
}

그룹의 배지 수정

그룹의 배지를 업데이트합니다.

PUT /groups/:id/badges/:badge_id
속성 유형 필수 여부 설명
id integer/string 예 그룹의 ID 또는 URL 인코딩 경로
badge_id integer 예 배지 ID
link_url string 아니오 배지 링크의 URL
image_url string 아니오 배지 이미지의 URL
name string 아니오 배지의 이름 
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/groups/: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": "group"
}

그룹에서 배지 제거

그룹에서 배지를 제거합니다.

DELETE /groups/:id/badges/:badge_id
속성 유형 필수 여부 설명
id integer/string 예 그룹의 ID 또는 URL 인코딩 경로
badge_id integer 예 배지 ID 
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/badges/:badge_id"

그룹의 배지를 미리 보기

link_url 및 image_url 최종 URL이 자리 표시자 보간을 해결한 후 어떻게 될지를 반환합니다.

GET /groups/:id/badges/render
속성 유형 필수 설명
id integer/string 예 그룹의 URL-인코딩된 경로 또는 ID
link_url string 예 배지 링크의 URL
image_url string 예 배지 이미지의 URL 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/: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"
}