GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation updates the appearance settings of a GitLab instance via the GitLab API. It allows users to customize various visual and textual elements such as the instance title, descriptions, Progressive Web App (PWA) details, logos, icons, guidelines, header and footer messages, and email header/footer settings. This is useful for administrators who want to personalize the GitLab sign-in page, navigation bar, and other UI components to match their organization's branding or preferences.

Use Case Examples

  1. Updating the instance title and description to reflect a company rebranding.
  2. Setting a custom logo and favicon for the GitLab instance.
  3. Configuring Progressive Web App details like name, short name, and icon for better mobile experience.
  4. Adding custom markdown guidelines for members and new projects to provide helpful information directly in the UI.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the request is sent. Defaults to https://gitlab.com.
Method HTTP method used for the request. Defaults to PUT for this operation.
Parameter Schema Schema defining the parameters that can be sent in the form data to customize the appearance, including titles, descriptions, logos, icons, guidelines, messages, colors, and email header/footer settings.
Request Path The API endpoint path for updating the application appearance, fixed to /api/v4/application/appearance.

Output

JSON

  • response - The JSON response from the GitLab API after updating the application appearance, containing the updated appearance settings or status information.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the GitLab API key credential is valid and has sufficient permissions to update application appearance settings.
  • Verify the baseUrl is correct and accessible from the network where the node runs.
  • Check that the HTTP method is set to PUT as required by the GitLab API for this endpoint.
  • If uploading files (e.g., logos or icons), ensure the file format and size meet GitLab API requirements.
  • Review error messages returned by the GitLab API for details on missing or invalid parameters.

Links

Discussion