이 API를 사용하여 GitLab 인스턴스의 외관을 제어합니다. 자세한 내용은 GitLab 외관을 참조하세요.

사전 요구 사항:

• 인스턴스에 대한 관리자 액세스 권한이 있어야 합니다.

애플리케이션 외관 조회#

이 GitLab 인스턴스의 외관 구성을 조회합니다.

GET /application/appearance

요청 예시:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "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,
  "site_name": "Production"
}

애플리케이션 외관 업데이트#

이 GitLab 인스턴스의 외관 구성을 업데이트합니다.

PUT /application/appearance

요청 예시:

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "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,
  "site_name": ""
}

애플리케이션 로고 업데이트 {#update-application-logo}#

포함된 이미지 파일로 이 GitLab 인스턴스의 로고를 업데이트합니다.

로컬 파일 시스템에서 아바타를 업로드하려면 --form 인수를 사용하여 파일을 포함합니다. 이렇게 하면 cURL이 Content-Type: multipart/form-data 헤더를 사용하여 데이터를 전송합니다. file= 파라미터는 파일 시스템의 이미지 파일을 가리켜야 하며 @가 앞에 붙어야 합니다.

PUT /application/appearance

요청 예시:

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

응답 예시:

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