GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation interacts with the GitLab API to render a badge for a specific group identified by its ID or URL-encoded path. It is useful for automating the retrieval and rendering of group badges in GitLab, which can be used for display in documentation, dashboards, or other integrations that require visual representation of group badges.

Use Case Examples

  1. Automatically fetch and render a badge for a GitLab group to display on a project status page.
  2. Integrate GitLab group badges into a custom dashboard to visually represent group achievements or statuses.

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 authentication.
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 Parameters sent in the query string of the API request, including the URL of the badge link and the URL of the badge image.
Path Parameters Parameters sent in the path of the API request, specifically the ID or URL-encoded path of the group.

Output

JSON

  • badge - The rendered badge data returned from the GitLab API.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the group ID or URL-encoded path is correct and accessible by the authenticated user to avoid authorization errors.
  • Verify that the link_url and image_url query parameters are valid URLs to prevent request failures.
  • Check that the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab server.

Links

Discussion