GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves the avatar image of a specific group from the GitLab API (version 4). It is useful for workflows that need to access or display group avatars, such as in project management dashboards or user interfaces that integrate GitLab group information.

Use Case Examples

  1. Fetching the avatar of a GitLab group to display in a custom dashboard.
  2. Automating the retrieval of group avatars for documentation or reporting purposes.

Properties

Name Meaning
Skip Authentication Option to bypass authentication for the request.
Authentication Type of authentication used, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Parameter Schema Defines the path parameter 'id' which is the ID of the group to retrieve the avatar for.
Request Body Schema Schema for the request body, null for this GET operation.
Request Path The API endpoint path template to get the group avatar, with {id} as a placeholder for the group ID.
Path Parameters Collection of path parameters, specifically the 'id' of the group whose avatar is being fetched.

Output

JSON

  • avatar - The avatar image data or URL of the specified GitLab group.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the group ID provided in the path parameters is valid and exists in the GitLab instance.
  • If authentication is skipped, the request may fail if the GitLab instance requires authentication for this endpoint.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.

Links

Discussion