Modify appearance

PUT /application/appearance
Api key auth

Modify appearance

multipart/form-data

Body

  • title string

    Instance title on the sign in / sign up page

  • description string

    Markdown text shown on the sign in / sign up page

  • pwa_name string

    Name of the Progressive Web App

  • pwa_short_name string

    Optional, short name for Progressive Web App

  • pwa_description string

    An explanation of what the Progressive Web App does

  • pwa_icon string(binary)

    Icon used for Progressive Web App

  • favicon string(binary)

    Instance favicon in .ico/.png format

  • new_project_guidelines string

    Markdown text shown on the new project page

  • profile_image_guidelines string

    Markdown text shown on the profile page below Public Avatar

  • header_message string

    Message within the system header bar

  • footer_message string

    Message within the system footer bar

  • message_background_color string

    Background color for the system header / footer bar

  • message_font_color string

    Font color for the system header / footer bar

  • email_header_and_footer_enabled boolean

    Add header and footer to all outgoing emails if enabled

Responses

  • 200 application/json

    Modify appearance

    Hide response attributes Show response attributes object
    • title string
    • description string
    • pwa_name string
    • pwa_short_name string
    • pwa_description string
    • pwa_icon string
    • favicon string
    • new_project_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 string
PUT /application/appearance 
curl \
 --request PUT 'https://www.gitlab.com/api/v4/application/appearance' \
 --header "Private-Token: $API_KEY" \
 --header "Content-Type: multipart/form-data" \
 --form "title=string" \
 --form "description=string" \
 --form "pwa_name=string" \
 --form "pwa_short_name=string" \
 --form "pwa_description=string" \
 --form "logo=@file" \
 --form "pwa_icon=@file" \
 --form "header_logo=@file" \
 --form "favicon=@file" \
 --form "new_project_guidelines=string" \
 --form "profile_image_guidelines=string" \
 --form "header_message=string" \
 --form "footer_message=string" \
 --form "message_background_color=string" \
 --form "message_font_color=string" \
 --form "email_header_and_footer_enabled=true"
Response examples (200) 
{
  "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",
  "profile_image_guidelines": "string",
  "header_message": "string",
  "footer_message": "string",
  "message_background_color": "string",
  "message_font_color": "string",
  "email_header_and_footer_enabled": "string"
}