GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation updates a specific badge for a group in GitLab using the GitLab API. It is useful for managing group badges programmatically, such as changing badge details or updating badge status. For example, a user can update the appearance or metadata of a badge associated with a GitLab group by specifying the group ID and badge ID.

Use Case Examples

  1. Updating a badge's link or image URL for a GitLab group.
  2. Changing the badge's description or other attributes via the API.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication The authentication method used, defaulting to GitLab API key.
baseUrl The 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 for the API path, including group ID and badge ID.

Output

JSON

  • id - The unique identifier of the updated 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 the badge belongs to.
  • created_at - Timestamp when the badge was created.
  • updated_at - Timestamp when the badge was last updated.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the group ID and badge ID are correct and accessible by the authenticated user.
  • Verify that the authentication credentials are valid and have the necessary permissions to update group badges.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages include 401 Unauthorized (authentication failure), 404 Not Found (invalid group or badge ID), and 400 Bad Request (invalid request body). Resolving these involves correcting credentials, IDs, or request payloads.

Links

Discussion