GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves a specific badge from a GitLab group using the GitLab API. It is useful for scenarios where you need to fetch detailed information about a particular badge associated with a group, such as for display, auditing, or integration purposes.

Use Case Examples

  1. Fetching a badge's details by its ID within a specific GitLab group to display on a dashboard.
  2. Automating the retrieval of badge information for reporting or synchronization with other systems.

Properties

Name Meaning
Skip Authentication Determines whether to skip the authentication process for the API 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 for this operation.
Path Parameters Parameters required in the API request path to identify the group and badge.

Output

JSON

  • id - The unique identifier of the badge.
  • name - The name of the badge.
  • image_url - The URL of the badge image.
  • link_url - The URL the badge links to.
  • group_id - The ID of the group to which the badge belongs.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the group ID and badge ID are correctly provided and exist in the GitLab instance.
  • Verify that the authentication credentials are valid and have sufficient permissions to access the group's badges.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages include 404 Not Found if the badge or group does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion