GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves the avatar image of a specific project from the GitLab API (version 4). It is useful for workflows that need to access or display project avatars, such as project management dashboards or automation scripts that handle project metadata.

Use Case Examples

  1. Fetching the avatar of a project by its ID to display in a custom dashboard.
  2. Automating the retrieval of project avatars for backup or synchronization purposes.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the request, defaulting to GET.
Path Parameters Parameters included in the request path, specifically the project ID or URL-encoded path to identify the project whose avatar is being retrieved.

Output

JSON

  • avatar - The avatar image data or URL of the project.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the authenticated user.
  • Verify that the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab.
  • Authentication errors may occur if the API key is missing, invalid, or lacks sufficient permissions to access the project.
  • Network errors or incorrect HTTP method usage can cause request failures.

Links

Discussion