外観API

GitLab 12.7から導入されました。

アピアランスAPIを使うと、GitLabのUI/admin/appearance を使っているかのように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",
  "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文字列です。いいえサインイン/サインアップページのインスタンスタイトル
description文字列です。いいえサインイン/サインアップページに表示されるMarkdownテキスト
pwa_name文字列です。いいえProgressive Web App のフルネーム。manifest.json のname 属性に使用。 GitLab 15.8 で導入。
pwa_short_name文字列です。いいえProgressive Web Appの略称。GitLab 15.8で導入されました。
pwa_description文字列です。いいえProgressive Web Appが何をするのかの説明。manifest.json のdescription 属性に使用。 GitLab 15.8 で導入。
pwa_icon混合いいえProgressive Webアプリに使用されるアイコン。Change logoを参照してください。GitLab 15.8で導入されました。
logo混合いいえサインイン/サインアップページで使用されるインスタンス画像。ロゴの変更を見る
header_logo混合いいえメインナビゲーションバーに使用されるインスタンス画像
favicon混合いいえ .ico または.png 形式のインスタンス favicon
new_project_guidelines文字列です。いいえ新しいプロジェクトページに表示されるMarkdownテキスト
profile_image_guidelines文字列です。いいえ公開アバターの下のプロフィールページに表示されるマークダウン・テキスト
header_message文字列です。いいえシステムヘッダーバーのメッセージ
footer_message文字列です。いいえシステムフッターバーのメッセージ
message_background_color文字列です。いいえシステムヘッダー/フッターバーの背景色
message_font_color文字列です。いいえシステムヘッダー/フッターバーのフォント色
email_header_and_footer_enabledbooleanいいえ有効な場合、すべての送信メールにヘッダーとフッターを追加
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",
  "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"
}