GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves a specific badge from a GitLab project using the GitLab API. It is useful for scenarios where you need to fetch details about a particular badge associated with a project, such as displaying badge information in a dashboard or automating badge management workflows.

Use Case Examples

  1. Fetch badge details for a project to display on a project status page.
  2. Automate retrieval of badge information for reporting or monitoring purposes.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication to use, default is GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Path Parameters Parameters to specify the project ID or URL-encoded path and the badge ID to retrieve.

Output

JSON

  • id - The unique identifier of the badge.
  • link_url - The URL the badge links to.
  • image_url - The URL of the badge image.
  • name - The name of the badge.
  • description - The description of the badge.
  • kind - The kind of badge (e.g., project or group badge).

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID and badge ID are correct and accessible by the authenticated user.
  • Verify that the GitLab API key credential is valid and has the necessary permissions to access project badges.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages include 404 Not Found if the badge or project does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion