GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves repository tags for a specified project from the GitLab API (version 4). It is useful for scenarios where you need to list or manage tags in a GitLab project's repository, such as automation workflows that track version tags or deploy based on tags.

Use Case Examples

  1. Fetch all tags of a GitLab project to display version history.
  2. Automate deployment pipelines by retrieving the latest tag from a repository.

Properties

Name Meaning
Skip Authentication If true, the node skips authentication when making the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to connect to, default is https://gitlab.com.
Method The HTTP method used for the API request, default is GET.
Parameter Schema Defines the parameters for the API request including project ID, sorting, ordering, search, pagination, and items per page.
Query Parameters Optional query parameters to filter and paginate the tags list, such as sort order, search term, page number, and items per page.
Path Parameters Path parameter specifying the project ID or URL-encoded path to identify the project whose tags are being retrieved.

Output

JSON

  • id - The unique identifier of the tag.
  • name - The name of the tag.
  • message - The message associated with the tag, if any.
  • target - The commit SHA or reference the tag points to.
  • commit
    • id - The commit ID the tag points to.
    • short_id - Shortened commit ID.
    • title - Commit title.
    • author_name - Name of the commit author.
    • author_email - Email of the commit author.
    • created_at - Timestamp when the commit was created.
  • release
    • tag_name - The tag name associated with a release, if any.
    • description - Description of the release associated with the tag.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID or URL-encoded path is correct to avoid 404 errors.
  • Verify that the API key credential has sufficient permissions to access the project's repository tags.
  • Check network connectivity and base URL configuration if requests fail to reach the GitLab instance.
  • If pagination parameters are used, ensure they are valid to avoid empty or incomplete results.

Links

Discussion