GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

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. An administrator updates the GitLab instance title and logo to reflect the company branding.
  2. A user configures the Progressive Web App name and icon for better mobile experience.
  3. Customizing the system header and footer messages to display important announcements or guidelines.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, defaulting to GET but can be set to PUT for this operation.
Parameter Schema Defines the parameters that can be sent in the form data to customize the GitLab instance appearance, including titles, descriptions, logos, icons, guidelines, messages, colors, and email header/footer settings.

Output

JSON

  • response - The JSON response from the GitLab API after updating the application appearance settings.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the baseUrl is correctly set to the GitLab instance URL to avoid connection errors.
  • Verify that the API key used for authentication has sufficient permissions to update application appearance settings.
  • Check that file uploads (e.g., logos, icons) are correctly formatted and not corrupted to prevent upload failures.
  • If the API returns an error, review the response message for details on missing or invalid parameters.

Links

Discussion