외형 API

Tier: Free, Premium, Ultimate Offering: Self-managed, GitLab Dedicated

Appearance API를 사용하면 /admin/appearance에서 GitLab UI를 사용하는 것처럼 GitLab의 외형을 유지할 수 있습니다. 이 API는 관리자 권한이 필요합니다.

현재 외형 구성 가져오기

GitLab 인스턴스의 현재 외형 구성을 나열합니다. 

GET /application/appearance

예시 요청: 

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/application/appearance"

예시 응답: 

{
  "title": "GitLab 테스트 인스턴스",
  "description": "gitlab-test.example.com",
  "pwa_name": "GitLab PWA",
  "pwa_short_name": "GitLab",
  "pwa_description": "GitLab를 PWA로",
  "pwa_icon": "/uploads/-/system/appearance/pwa_icon/1/pwa_logo.png",
  "logo": "/uploads/-/system/appearance/logo/1/logo.png",
  "header_logo": "/uploads/-/system/appearance/header_logo/1/header.png",
  "favicon": "/uploads/-/system/appearance/favicon/1/favicon.png",
  "member_guidelines": "사용자 지침의 커스텀 버전",
  "new_project_guidelines": "도움말을 위해 FAQ를 읽어주세요.",
  "profile_image_guidelines": "프로필 이미지 지침의 커스텀 버전",
  "header_message": "",
  "footer_message": "",
  "message_background_color": "#e75e40",
  "message_font_color": "#ffffff",
  "email_header_and_footer_enabled": false
}

외형 구성 변경

API 호출을 사용하여 GitLab 인스턴스의 외형 구성을 수정합니다. 

PUT /application/appearance
속성 유형 필요 여부 설명
title string 아니요 로그인 / 가입 페이지의 인스턴스 제목
description string 아니요 로그인 / 가입 페이지에 표시되는 마크다운 텍스트
pwa_name string 아니요 Progressive Web App의 전체 이름. manifest.json의 name 속성에 사용됩니다. GitLab 15.8에서 도입.
pwa_short_name string 아니요 Progressive Web App의 짧은 이름. GitLab 15.8에서 도입.
pwa_description string 아니요 Progressive Web App의 기능 설명. manifest.json의 description 속성에 사용됩니다. GitLab 15.8에서 도입.
pwa_icon mixed 아니요 Progressive Web App에 사용되는 아이콘. 로고 변경 참조. GitLab 15.8에서 도입.
logo mixed 아니요 로그인 / 가입 페이지에서 사용되는 인스턴스 이미지. 로고 변경 참조
header_logo mixed 아니요 메인 내비게이션 바에 사용되는 인스턴스 이미지
favicon mixed 아니요 .ico 또는 .png 형식의 인스턴스 파비콘
member_guidelines string 아니요 변경 가능한 멤버를 가진 사용자를 위해 그룹이나 프로젝트 멤버 페이지에 표시되는 마크다운 텍스트
new_project_guidelines string 아니요 새 프로젝트 페이지에 표시되는 마크다운 텍스트
profile_image_guidelines string 아니요 Public Avatar 아래 프로필 페이지에 표시되는 마크다운 텍스트
header_message string 아니요 시스템 헤더 표시 메시지
footer_message string no 시스템 푸터 표시 메시지
message_background_color string 아니요 시스템 헤더 / 푸터의 배경 색
message_font_color string 아니요 시스템 헤더 / 푸터의 글꼴 색상
email_header_and_footer_enabled boolean 아니요 활성화된 경우 모든 발신 이메일에 헤더와 푸터 추가

예시 요청: 

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/application/appearance?email_header_and_footer_enabled=true&header_message=test"

예시 응답: 

{
  "title": "GitLab Test Instance",
  "description": "gitlab-test.example.com",
  "pwa_name": "GitLab PWA",
  "pwa_short_name": "GitLab",
  "pwa_description": "GitLab를 PWA로",
  "pwa_icon": "/uploads/-/system/appearance/pwa_icon/1/pwa_logo.png",
  "logo": "/uploads/-/system/appearance/logo/1/logo.png",
  "header_logo": "/uploads/-/system/appearance/header_logo/1/header.png",
  "favicon": "/uploads/-/system/appearance/favicon/1/favicon.png",
  "member_guidelines": "사용자 지침의 커스텀 버전",
  "new_project_guidelines": "도움말을 위해 FAQ를 읽어주세요.",
  "profile_image_guidelines": "프로필 이미지 지침의 커스텀 버전",
  "header_message": "test",
  "footer_message": "",
  "message_background_color": "#e75e40",
  "message_font_color": "#ffffff",
  "email_header_and_footer_enabled": true
}

로고 변경

GitLab 인스턴스에 로고를 업로드합니다.

파일 시스템에서 아바타를 업로드하려면 --form 인수를 사용하십시오. 이렇게 하면 cURL이 Content-Type: multipart/form-data 헤더를 사용하여 데이터를 게시합니다. file= 매개변수는 파일 시스템의 이미지 파일을 가리키고 @로 시작해야 합니다. 

PUT /application/appearance
속성 유형 필요 여부 설명
logo mixed 예 업로드할 파일
pwa_icon mixed 예 업로드할 파일. GitLab 15.8에서 도입.

예시 요청: 

curl --location --request PUT "https://gitlab.example.com/api/v4/application/appearance?data=image/png" \
--header "Content-Type: multipart/form-data" \
--header "PRIVATE-TOKEN: <your_access_token>" \
--form "logo=@/path/to/logo.png"

예시 응답: 

{
   "logo":"/uploads/-/system/appearance/logo/1/logo.png"
}