GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves badges for a specific project in GitLab using the GitLab API. It is useful for users who want to programmatically access badge information associated with a project, such as build status or coverage badges, which can be displayed in project documentation or dashboards.

Use Case Examples

  1. Fetching all badges for a project by its ID to display on a project overview page.
  2. Filtering badges by name to find a specific badge related to a CI pipeline.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Query Parameters Optional query parameters to filter or paginate the badges.
Path Parameters Path parameters required for the API endpoint.

Output

JSON

  • id - Unique identifier of the badge.
  • name - Name of the badge.
  • image_url - URL of the badge image.
  • link_url - URL the badge links to.
  • description - Description of the badge.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible by the authenticated user.
  • Check that the authentication credentials are valid and have the necessary permissions to access project badges.
  • Verify the base URL is correct if using a self-hosted GitLab instance.
  • If pagination parameters are used, ensure they are valid integers to avoid request errors.

Links

Discussion