외관 API

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

외관 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 Test Instance",  
  "description": "gitlab-test.example.com",  
  "pwa_name": "GitLab PWA",  
  "pwa_short_name": "GitLab",  
  "pwa_description": "GitLab as 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": "Custom member guidelines",  
  "new_project_guidelines": "Please read the FAQs for help.",  
  "profile_image_guidelines": "Custom 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 아니오 로그인 / 회원가입 페이지에 표시되는 Markdown 텍스트
pwa_name string 아니오 진행형 웹 앱의 전체 이름. manifest.json의 name 속성에 사용됩니다. 도입됨 GitLab 15.8.
pwa_short_name string 아니오 진행형 웹 앱의 짧은 이름. 도입됨 GitLab 15.8.
pwa_description string 아니오 진행형 웹 앱이 하는 일에 대한 설명. manifest.json의 description 속성에 사용됩니다. 도입됨 GitLab 15.8.
pwa_icon mixed 아니오 진행형 웹 앱에 사용되는 아이콘. 로고 변경 보기. 도입됨 GitLab 15.8.
logo mixed 아니오 로그인 / 회원가입 페이지에 사용되는 인스턴스 이미지. 로고 변경 보기
header_logo mixed 아니오 기본 탐색 막대에 사용되는 인스턴스 이미지
favicon mixed 아니오 인스턴스 파비콘 .ico 또는 .png 형식
member_guidelines string 아니오 사용자가 멤버 변경 권한이 있는 그룹 또는 프로젝트 멤버 페이지에 표시되는 Markdown 텍스트
new_project_guidelines string 아니오 새 프로젝트 페이지에 표시되는 Markdown 텍스트
profile_image_guidelines string 아니오 공개 아바타 아래 프로필 페이지에 표시되는 Markdown 텍스트
header_message string 아니오 시스템 헤더 바의 메시지
footer_message string 아니오 시스템 바닥글의 메시지
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 as 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": "Custom member guidelines",  
  "new_project_guidelines": "Please read the FAQs for help.",  
  "profile_image_guidelines": "Custom 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 혼합 예 업로드할 파일
pwa_icon 혼합 예 업로드할 파일. 도입됨 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"
}