应用程序外观 API

Tier: 基础版, 专业版, 旗舰版
Offering: 私有化部署

使用这个 API 来控制你的极狐 GitLab 实例的外观。有关更多信息，请参阅极狐GitLab 外观。

先决条件：

你必须拥有对实例的管理员访问权限。

获取当前应用程序外观的详细信息#

获取此极狐 GitLab 实例当前外观配置的详细信息。

plaintext
GET /application/appearance

示例请求：

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

示例响应：

json
1{
2  "title": "GitLab Test Instance",
3  "description": "gitlab-test.example.com",
4  "pwa_name": "GitLab PWA",
5  "pwa_short_name": "GitLab",
6  "pwa_description": "GitLab as PWA",
7  "pwa_icon": "/uploads/-/system/appearance/pwa_icon/1/pwa_logo.png",
8  "logo": "/uploads/-/system/appearance/logo/1/logo.png",
9  "header_logo": "/uploads/-/system/appearance/header_logo/1/header.png",
10  "favicon": "/uploads/-/system/appearance/favicon/1/favicon.png",
11  "member_guidelines": "Custom member guidelines",
12  "new_project_guidelines": "Please read the FAQs for help.",
13  "profile_image_guidelines": "Custom profile image guidelines",
14  "header_message": "",
15  "footer_message": "",
16  "message_background_color": "#e75e40",
17  "message_font_color": "#ffffff",
18  "email_header_and_footer_enabled": false
19}

更新应用程序外观#

更新此极狐 GitLab 实例的当前外观配置。

plaintext
PUT /application/appearance

属性	类型	必需	描述
title	string	no	登录 / 注册页面上的实例标题
description	string	no	登录 / 注册页面上显示的 Markdown 文本
pwa_name	string	no	渐进式 Web 应用程序的全名。用于 manifest.json 中的 name 属性。在极狐 GitLab 15.8 中引入。
pwa_short_name	string	no	渐进式 Web 应用程序的简称。在极狐 GitLab 15.8 中引入。
pwa_description	string	no	渐进式 Web 应用程序的功能说明。用于 manifest.json 中的 description 属性。在极狐 GitLab 15.8 中引入。
pwa_icon	mixed	no	渐进式 Web 应用程序使用的图标。请参阅更新应用程序徽标。在极狐 GitLab 15.8 中引入。
logo	mixed	no	登录 / 注册页面上使用的实例图片。请参阅更新应用程序徽标
header_logo	mixed	no	主导航栏使用的实例图片
favicon	mixed	no	以 .ico 或 .png 格式的实例 favicon
member_guidelines	string	no	在群组或项目成员页面上显示的 Markdown 文本，供有权限更改成员的用户查看
new_project_guidelines	string	no	新项目页面上显示的 Markdown 文本
profile_image_guidelines	string	no	在个人资料页面的公共头像下显示的 Markdown 文本
header_message	string	no	系统头部栏中的信息
footer_message	string	no	系统底部栏中的信息
message_background_color	string	no	系统头部 / 底部栏的背景颜色
message_font_color	string	no	系统头部 / 底部栏的字体颜色
email_header_and_footer_enabled	boolean	no	如果启用，则为所有发送的电子邮件添加头部和底部

示例请求：

shell
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"

示例响应：

json
1{
2  "title": "GitLab Test Instance",
3  "description": "gitlab-test.example.com",
4  "pwa_name": "GitLab PWA",
5  "pwa_short_name": "GitLab",
6  "pwa_description": "GitLab as PWA",
7  "pwa_icon": "/uploads/-/system/appearance/pwa_icon/1/pwa_logo.png",
8  "logo": "/uploads/-/system/appearance/logo/1/logo.png",
9  "header_logo": "/uploads/-/system/appearance/header_logo/1/header.png",
10  "favicon": "/uploads/-/system/appearance/favicon/1/favicon.png",
11  "member_guidelines": "Custom member guidelines",
12  "new_project_guidelines": "Please read the FAQs for help.",
13  "profile_image_guidelines": "Custom profile image guidelines",
14  "header_message": "test",
15  "footer_message": "",
16  "message_background_color": "#e75e40",
17  "message_font_color": "#ffffff",
18  "email_header_and_footer_enabled": true
19}

更新应用程序徽标#

使用包含的图像文件更新此极狐 GitLab 实例的当前徽标。

要从本地文件系统上传头像，请使用 --form 参数来包含文件。这会导致 cURL 使用 Content-Type: multipart/form-data 头部来发布数据。file= 参数必须指向你文件系统上的图像文件，并且前面加上 @。

plaintext
PUT /application/appearance

属性	类型	必需	描述
logo	mixed	Yes	用作徽标的图像。
pwa_icon	mixed	Yes	用于渐进式 Web 应用程序的图像。在极狐 GitLab 15.8 中引入。

示例请求：

shell
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"

示例响应：

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