GIgitlab
instance

PUT /api/v4/application/appearance

Modify appearance

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Request body multipart/form-data

titlestring

Instance title on the sign in / sign up page

descriptionstring

Markdown text shown on the sign in / sign up page

pwa_namestring

Name of the Progressive Web App

pwa_short_namestring

Optional, short name for Progressive Web App

pwa_descriptionstring

An explanation of what the Progressive Web App does

logostring binary

Instance image used on the sign in / sign up page

pwa_iconstring binary

Icon used for Progressive Web App

header_logostring binary

Instance image used for the main navigation bar

faviconstring binary

Instance favicon in .ico/.png format

member_guidelinesstring

Markdown text shown on the members page of a group or project

new_project_guidelinesstring

Markdown text shown on the new project page

profile_image_guidelinesstring

Markdown text shown on the profile page below Public Avatar

header_messagestring

Message within the system header bar

footer_messagestring

Message within the system footer bar

message_background_colorstring

Background color for the system header / footer bar

message_font_colorstring

Font color for the system header / footer bar

email_header_and_footer_enabledboolean

Add header and footer to all outgoing emails if enabled

site_namestring

Last part of the webpage title. Defaults to empty.

Response

Modify appearance

titlestring required
descriptionstring required
pwa_namestring required
pwa_short_namestring required
pwa_descriptionstring required
logostring required
pwa_iconstring required
header_logostring required
faviconstring required
new_project_guidelinesstring required
member_guidelinesstring required
profile_image_guidelinesstring required
header_messagestring required
footer_messagestring required
message_background_colorstring required
message_font_colorstring required
email_header_and_footer_enabledboolean required
site_namestring required

Example response

{
  "title": "GitLab Community Edition",
  "description": "Open source software to collaborate on code",
  "pwa_name": "GitLab",
  "pwa_short_name": "GitLab",
  "pwa_description": "GitLab as PWA",
  "logo": "/uploads/-/system/appearance/logo/1/logo.png",
  "pwa_icon": "/uploads/-/system/appearance/pwa_icon/1/icon.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.",
  "member_guidelines": "Please read the member guidelines.",
  "profile_image_guidelines": "Custom profile image guidelines",
  "header_message": "This is a header message",
  "footer_message": "This is a footer message",
  "message_background_color": "#e75e40",
  "message_font_color": "#ffffff",
  "site_name": "GitLab"
}

Changes

No recorded changes to this operation across all 5 revisions of this API.