Modify appearance

PUT

/api/v4/application/appearance

Authorizations

http
oauth2

Request Body

multipart/form-data

object

title

Instance title on the sign in / sign up page

string

nullable

description

Markdown text shown on the sign in / sign up page

string

nullable

pwa_name

Name of the Progressive Web App

string

nullable

pwa_short_name

Optional, short name for Progressive Web App

string

nullable

pwa_description

An explanation of what the Progressive Web App does

string

nullable

logo

Instance image used on the sign in / sign up page

string format: binary

nullable

pwa_icon

Icon used for Progressive Web App

string format: binary

nullable

header_logo

Instance image used for the main navigation bar

string format: binary

nullable

favicon

Instance favicon in .ico/.png format

string format: binary

nullable

member_guidelines

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

string

nullable

new_project_guidelines

Markdown text shown on the new project page

string

nullable

profile_image_guidelines

Markdown text shown on the profile page below Public Avatar

string

nullable

header_message

Message within the system header bar

string

nullable

footer_message

Message within the system footer bar

string

nullable

message_background_color

Background color for the system header / footer bar

string

nullable

message_font_color

Font color for the system header / footer bar

string

nullable

email_header_and_footer_enabled

Add header and footer to all outgoing emails if enabled

boolean

nullable

site_name

Last part of the webpage title. Defaults to empty.

string

nullable

Responses

200

application/json

object

title

string

description

string

pwa_name

string

pwa_short_name

string

pwa_description

string

logo

string

pwa_icon

string

header_logo

string

favicon

string

new_project_guidelines

string

member_guidelines

string

profile_image_guidelines

string

header_message

string

footer_message

string

message_background_color

string

message_font_color

string

email_header_and_footer_enabled

boolean

site_name

string

Example

{
  "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",
  "email_header_and_footer_enabled": false,
  "site_name": "GitLab"
}

400

Bad request

401

Unauthorized

403

Forbidden