GitLab API

GitlabTool
Join our community

Actions1000

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 detailed information about a particular badge associated with a project, such as for project status displays or automation workflows that depend on badge data.

Use Case Examples

  1. Fetch a badge by its ID from a project to display its status in a dashboard.
  2. Automate badge retrieval to verify project quality metrics before deployment.

Properties

Name Meaning
Skip Authentication Option to bypass authentication for the request.
Authentication Select the authentication method, typically GitLab API key, used for the request.
baseUrl The base URL of the GitLab instance to send the request to.
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 identify the badge 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.
  • kind - The kind/type of the badge.
  • created_at - Timestamp when the badge was created.
  • updated_at - Timestamp when the badge was last updated.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and badge ID are correctly specified and URL-encoded if necessary.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access the project badges.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • Common error messages include 404 Not Found if the badge or project does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion