GitLab API

GitlabTool

Actions1000

Overview

This node interacts with the GitLab API to retrieve release information for a specific group identified by its ID or URL-encoded path. It supports fetching releases with options to sort the results, limit the fields returned, and paginate through the releases. This is useful for users who want to programmatically access release data of GitLab groups, for example, to monitor project releases or integrate release information into other workflows.

Use Case Examples

  1. Retrieve all releases for a GitLab group sorted in descending order by default.
  2. Fetch a simplified list of releases with limited fields for a specific group.
  3. Paginate through releases by specifying page number and items per page.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used for the request, hidden unless Skip Authentication is false. Defaults to GitLab API key.
baseUrl The base URL of the GitLab instance to send the request to. Defaults to https://gitlab.com.
Method The HTTP method to use for the request. Defaults to GET.
Query Parameters Optional query parameters to customize the request such as sorting order, simple response, pagination page, and items per page.
Path Parameters Path parameters including the 'id' which is the ID or URL-encoded path of the group owned by the authenticated user.

Output

JSON

  • id - The unique identifier of the release.
  • tag_name - The tag name associated with the release.
  • description - Description of the release.
  • created_at - Timestamp when the release was created.
  • released_at - Timestamp when the release was released.
  • author - Information about the author of the release.
  • assets - Assets associated with the release, such as links and sources.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the 'id' path parameter is correctly set to a valid group ID or URL-encoded path; otherwise, the API will return an error.
  • If authentication is skipped, some endpoints may not work or return limited data depending on GitLab's API permissions.
  • Verify that the baseUrl is correct and accessible, especially if using a self-hosted GitLab instance.
  • Check that query parameters like 'sort', 'page', and 'per_page' are valid and within acceptable ranges to avoid API errors.

Links

Discussion