GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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 look and feel of their GitLab instance to match their organization's branding or preferences.

Use Case Examples

  1. Updating the instance title and description to reflect a new branding.
  2. Setting a custom logo and favicon for the GitLab sign-in page.
  3. Configuring Progressive Web App details like name, short name, and icon.
  4. Adding custom markdown guidelines for members and new projects.

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. Hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance to which the request is sent. Defaults to https://gitlab.com.
Method The HTTP method used for the request. Defaults to GET but can be set to POST, PUT, DELETE, HEAD, or PATCH.
Parameter Schema Defines the parameters that can be sent in the form data to customize the GitLab instance appearance, including titles, descriptions, logos, icons, colors, and messages. This is a hidden property used internally to structure the request.
Request Body Schema Schema for the request body, currently set to null and hidden.
Request Path The API endpoint path for updating the application appearance, fixed to /api/v4/application/appearance and hidden.

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 has sufficient permissions to update application appearance settings.
  • Verify the baseUrl is correct and accessible from the node's environment.
  • Check that the HTTP method is set to PUT as required by the operation.
  • If uploading files (e.g., logos or icons), ensure the file format and size meet GitLab API requirements.
  • Common error messages may include authentication failures, permission denied, or invalid parameter errors. Verify credentials and parameter formats to resolve these.

Links

Discussion