GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation interacts with the GitLab API to render a badge for a specific group. It is useful for users who want to dynamically generate and display badges associated with GitLab groups, such as build status or coverage badges, by providing the group ID and URLs for the badge image and link.

Use Case Examples

  1. A DevOps engineer uses this node to fetch and render a status badge for a GitLab group to display on a project dashboard.
  2. A developer automates the retrieval of custom badges for different GitLab groups to embed in documentation or websites.

Properties

Name Meaning
Skip Authentication Determines whether to skip API authentication for the request.
Authentication Specifies the authentication method to use, typically an API key credential for GitLab.
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.
Query Parameters Collection of query parameters including 'link_url' (URL of the badge link) and 'image_url' (URL of the badge image) required to render the badge.
Path Parameters Collection of path parameters including 'id' which is the ID or URL-encoded path of the GitLab group owned by the authenticated user.

Output

JSON

  • badgeRenderResponse - The response from the GitLab API rendering the badge for the specified group, including badge image and link data.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the 'id' path parameter is correctly set to the group's ID or URL-encoded path; otherwise, the API call will fail with a 404 or authentication error.
  • Verify that 'link_url' and 'image_url' query parameters are valid URLs; invalid URLs may cause the badge rendering to fail or return an error.
  • If skipping authentication, ensure the GitLab instance allows unauthenticated access to badge rendering; otherwise, authentication errors will occur.
  • Common error messages include 401 Unauthorized (due to missing or invalid API credentials) and 404 Not Found (if the group ID is incorrect or the group does not exist).

Links

Discussion