GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves badges for a specific group in GitLab using the GitLab API v4. It is useful for users who want to programmatically access badge information associated with a group they own or have access to. For example, it can be used to list all badges of a project group to display them in a dashboard or to automate badge management tasks.

Use Case Examples

  1. Retrieve all badges for a group with a specific ID.
  2. Filter badges by name or paginate through badges using page and per_page parameters.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method used for the request, typically an API key credential.
baseUrl The base URL of the GitLab instance to send the request to.
Method The HTTP method to use for the request (GET, POST, PUT, DELETE, HEAD, PATCH).
Parameter Schema Defines the parameters for the API request including path and query parameters.
Request Body Schema Defines the request body schema, if applicable (null for this operation).
Request Path The API endpoint path for the request, with placeholders for path parameters.
Query Parameters Optional query parameters to filter or paginate the badges list.
Path Parameters Path parameters required for the API request, specifically the group ID.

Output

JSON

  • badges - List of badges retrieved for the specified group.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the group ID provided in the path parameters is correct and accessible by the authenticated user.
  • Verify that the authentication credentials are valid and have the necessary permissions to access group badges.
  • Check the baseUrl to ensure it points to the correct GitLab instance if using a self-hosted GitLab server.
  • Common error messages include 401 Unauthorized (invalid or missing authentication), 404 Not Found (group ID does not exist or is inaccessible), and 400 Bad Request (invalid query parameters).

Links

Discussion