GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves the avatar image of a specific project from the GitLab API. It is useful for scenarios where you need to display or process the project's avatar image, such as in project management dashboards or integration workflows that involve project metadata.

Use Case Examples

  1. Fetching the avatar image of a project to display in a custom UI.
  2. Automating the retrieval of project avatars for documentation or reporting purposes.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API request.
Authentication Type of authentication to use for the API request, hidden if Skip Authentication is true.
baseUrl Base URL of the GitLab instance to which the API request is sent.
Method HTTP method used for the API request.
Parameter Schema Schema defining the path parameter 'id' which is the ID or URL-encoded path of the project.
Request Body Schema Schema for the request body, null for this operation as it is a GET request.
Request Path API endpoint path template for retrieving the project avatar, with a placeholder for the project ID.
Path Parameters Collection of path parameters including 'id' which specifies the project ID or URL-encoded path.

Output

JSON

  • avatar - The avatar image data or URL of the project retrieved from the GitLab API.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the project ID or URL-encoded path is correctly provided in the path parameters to avoid 404 errors.
  • If authentication is required and skipped, the request may fail with authorization errors; ensure proper credentials are configured.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure the API endpoint is reachable.

Links

Discussion